Back to Purchase Order
PO1.0.7
Purchase Order Example
Approved canonical example from the published Purchase Order JSON Schema. Use Preview to see schema fields alongside example values, or Code for the canonical JSON payload.
| Field | Required | Description | Example value |
|---|---|---|---|
docType | Yes | Canonical document type. For purchase orders this value is PO. | PO |
correlationId | Yes | Stable UUID used to trace this purchase order through downstream acknowledgements, shipments, invoices, and support workflows. | 8d359a0f-3e5a-4d36-a87c-f2748b1d6b43 |
timestamp | Yes | UTC timestamp indicating when DataShift created the canonical document. | 2026-05-16T00:00:00Z |
metadata.sourceLanguage | Yes | cxml | |
metadata.sourceVersion | Yes | Canonical schema version used to create this document | 1.0.7 |
metadata.payloadId | No | Original cXML payload ID | po-example-10001 |
metadata.userAgent | Yes | DataShift Edge version that generated the canonical document | DataShift Edge v1 |
data.poNumber | Yes | Buyer-issued purchase order number. Use this as the primary business reference. | PO-10001 |
data.poVersion | Yes | Buyer-issued version or revision for this purchase order. | 1 |
data.operation | Yes | Standard document operation. Legacy PO change requests map to update. | new |
data.orderType | No | Type of purchase order | - |
data.orderDate | Yes | Date and time the buyer issued the order. | 2026-05-16T00:00:00Z |
data.requestedDeliveryDate | Yes | Buyer-requested delivery date for the order. | 2026-05-23T00:00:00Z |
data.comments | No | General order comments or instructions | - |
data.dropship | No | Indicates if this is a direct ship/dropship order. When true, shipping address should be included in outbound mappings (e.g., NetSuite sales orders). | - |
data.buyer.id | Yes | BUYER-AU | |
data.buyer.name | Yes | Example Buyer Pty Ltd | |
data.buyer.taxRegistrations.type | Yes | ABN | |
data.buyer.taxRegistrations.value | Yes | 12345678901 | |
data.buyer.contact.name | No | - | |
data.buyer.contact.phone | No | - | |
data.buyer.contact.email | No | - | |
data.buyer.contact.role | No | - | |
data.buyer.address.addressId | No | - | |
data.buyer.address.addressee | No | - | |
data.buyer.address.street1 | Yes | - | |
data.buyer.address.street2 | No | - | |
data.buyer.address.city | Yes | - | |
data.buyer.address.state | Yes | - | |
data.buyer.address.postalCode | Yes | - | |
data.buyer.address.country | Yes | - | |
data.supplier.id | Yes | SUPPLIER-AU | |
data.supplier.name | Yes | Example Supplier Pty Ltd | |
data.supplier.taxRegistrations.type | Yes | ABN | |
data.supplier.taxRegistrations.value | Yes | 98765432109 | |
data.supplier.contact.name | No | - | |
data.supplier.contact.phone | No | - | |
data.supplier.contact.email | No | - | |
data.supplier.contact.role | No | - | |
data.supplier.address.addressId | No | - | |
data.supplier.address.addressee | No | - | |
data.supplier.address.street1 | Yes | - | |
data.supplier.address.street2 | No | - | |
data.supplier.address.city | Yes | - | |
data.supplier.address.state | Yes | - | |
data.supplier.address.postalCode | Yes | - | |
data.supplier.address.country | Yes | - | |
data.billTo.addressId | No | - | |
data.billTo.addressee | No | Example Buyer Accounts | |
data.billTo.street1 | Yes | 1 Market Street | |
data.billTo.street2 | No | - | |
data.billTo.city | Yes | Sydney | |
data.billTo.state | Yes | NSW | |
data.billTo.postalCode | Yes | 2000 | |
data.billTo.country | Yes | AU | |
data.shipTo.addressId | No | - | |
data.shipTo.addressee | No | Example Distribution Centre | |
data.shipTo.street1 | Yes | 10 Warehouse Road | |
data.shipTo.street2 | No | - | |
data.shipTo.city | Yes | Melbourne | |
data.shipTo.state | Yes | VIC | |
data.shipTo.postalCode | Yes | 3000 | |
data.shipTo.country | Yes | AU | |
data.shipping.amount | No | - | |
data.shipping.currency | No | ISO 4217 currency codes supported by DataShift canonical schemas | - |
data.shipping.carrier | No | - | |
data.shipping.route | No | Shipping route method | - |
data.shipping.shippingInstructions | No | Detailed shipping instructions | - |
data.shipping.buyerAcctNumber | No | - | |
data.shipping.incoTerms | No | - | |
data.lineItems[].lineNumber | Yes | Buyer line number from the purchase order. | 1 |
data.lineItems[].uniqueLineKey | No | DataShift-managed stable line key used by DataShift connectors to correlate PO, POA, ASN, and INV lines. | PO-10001-1 |
data.lineItems[].supplierItemId | Yes | SUP-001 | |
data.lineItems[].supplierItemAuxiliaryId | No | Supplier's alternate/auxiliary part ID | - |
data.lineItems[].buyerItemId | Yes | BUY-001 | |
data.lineItems[].description | No | Example product | |
data.lineItems[].quantity | Yes | Ordered quantity for this line. | 12 |
data.lineItems[].unitOfMeasure | Yes | Unit of measure code for the ordered quantity. | EA |
data.lineItems[].unitPrice | Yes | 25 | |
data.lineItems[].currency | Yes | ISO 4217 currency code for line pricing. | AUD |
data.lineItems[].lineAmountExTax | Yes | 300 | |
data.lineItems[].lineAmountInclTax | Yes | 330 | |
data.lineItems[].requestedDeliveryDate | No | - | |
data.lineItems[].priceBasisQuantityQuantity | No | Price basis quantity | - |
data.lineItems[].priceBasisQuantityConversionFactor | No | Price basis conversion factor | - |
data.lineItems[].priceBasisQuantityUnitOfMeasure | No | Price basis unit of measure | - |
data.lineItems[].classificationDomain | No | Product classification domain | - |
data.lineItems[].classificationCode | No | Product classification code | - |
data.lineItems[].comments | No | Line item specific comments | - |
data.orderTotals.subtotal | Yes | 300 | |
data.orderTotals.taxAmount | Yes | 30 | |
data.orderTotals.totalAmount | Yes | 330 | |
data.orderTotals.currency | Yes | ISO 4217 currency codes supported by DataShift canonical schemas | AUD |
data.extrinsics | No | Partner-specific extension fields that are not part of the canonical core contract. | {"department":"Operations"} |