Back to Purchase Order PO purchase-order.schema.json
Purchase Order Releases Versioned JSON Schema artifacts for this document. The latest version is expanded by default; older versions stay collapsed for quick inspection and download.
1.0.10 Latest
/edi/contracts/releases/1.0.10/schemas/purchase-order.schema.json View Hide Schema
purchase-order.schema.json
docType docTypeconstant
Required Canonical document type. For purchase orders this value is PO. correlationId correlationIdstring
Required Stable UUID used to trace this purchase order through downstream acknowledgements, shipments, invoices, and support workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical document. metadata metadataobject
Required Public source metadata retained for integration troubleshooting without exposing tenant or credential details. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionconstant
Required Canonical schema version used to create this document payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentconstant
Required DataShift Edge version that generated the canonical document data dataobject
Required Business payload for the purchase order. poNumber data.poNumberstring
Required Buyer-issued purchase order number. Use this as the primary business reference. poVersion data.poVersionstring
Required Buyer-issued version or revision for this purchase order. operation data.operationstring
Required Standard document operation. Legacy PO change requests map to update. Values: new, update, delete orderType data.orderTypestring
Type of purchase order Values: regular, blanket, release, standing orderDate data.orderDatestring
Required Date and time the buyer issued the order. requestedDeliveryDate data.requestedDeliveryDatestring
Required Buyer-requested delivery date for the order. comments data.commentsstring
General order comments or instructions dropship data.dropshipboolean
Indicates if this is a direct ship/dropship order. When true, shipping address should be included in outbound mappings (e.g., NetSuite sales orders). buyer data.buyerobject
Required Party placing the order. id data.buyer.idstring
Required name data.buyer.namestring
Required taxRegistrations data.buyer.taxRegistrationsobject
Australian tax registrations for the party type data.buyer.taxRegistrations.typestring
Required Values: ABN value data.buyer.taxRegistrations.valuestring
Required contact data.buyer.contactobject
name data.buyer.contact.namestring
phone data.buyer.contact.phonestring
email data.buyer.contact.emailstring
role data.buyer.contact.rolestring
address data.buyer.addressobject
Standard address structure for DataShift canonical documents addressId data.buyer.address.addressIdstring
addressee data.buyer.address.addresseestring
street1 data.buyer.address.street1string
Required street2 data.buyer.address.street2string
city data.buyer.address.citystring
Required state data.buyer.address.statestring
Required postalCode data.buyer.address.postalCodestring
Required country data.buyer.address.countrystring
Required Values: AU supplier data.supplierobject
Required Party expected to fulfil the order. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsobject
Australian tax registrations for the party type data.supplier.taxRegistrations.typestring
Required Values: ABN value data.supplier.taxRegistrations.valuestring
Required contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressobject
Standard address structure for DataShift canonical documents addressId data.supplier.address.addressIdstring
addressee data.supplier.address.addresseestring
street1 data.supplier.address.street1string
Required street2 data.supplier.address.street2string
city data.supplier.address.citystring
Required state data.supplier.address.statestring
Required postalCode data.supplier.address.postalCodestring
Required country data.supplier.address.countrystring
Required Values: AU billTo data.billToobject
Required Billing destination supplied by the buyer. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU shipTo data.shipToobject
Required Delivery destination for the ordered goods. addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU shipping data.shippingobject
Commercial freight charges and instructions. amount data.shipping.amountinteger
Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
Shipping route method shippingInstructions data.shipping.shippingInstructionsstring
Detailed shipping instructions buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) lineItems data.lineItemsarray
Required Ordered product lines. DataShift manages uniqueLineKey for cross-document line correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Buyer line number from the purchase order. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key used by DataShift connectors to correlate PO, POA, ASN, and INV lines. supplierItemId data.lineItems[].supplierItemIdstring
supplierItemAuxiliaryId data.lineItems[].supplierItemAuxiliaryIdstring
Supplier's alternate/auxiliary part ID buyerItemId data.lineItems[].buyerItemIdstring
description data.lineItems[].descriptionstring
quantity data.lineItems[].quantitynumber
Ordered quantity for this line. unitOfMeasure data.lineItems[].unitOfMeasurestring
Unit of measure code for the ordered quantity. Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPriceinteger
Integer unit price at ISO 4217 minor-unit scale + 2 (e.g. AUD, exponent 2 -> 1/10000: 5.2185 -> 52185). Carries sub-minor precision; not rounded to minor units. currency data.lineItems[].currencystring
ISO 4217 currency code for line pricing. Values: AUD lineAmountExTax data.lineItems[].lineAmountExTaxinteger
Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. lineAmountInclTax data.lineItems[].lineAmountInclTaxinteger
Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. requestedDeliveryDate data.lineItems[].requestedDeliveryDatestring
priceBasisQuantityQuantity data.lineItems[].priceBasisQuantityQuantitynumber
Price basis quantity priceBasisQuantityConversionFactor data.lineItems[].priceBasisQuantityConversionFactornumber
Price basis conversion factor priceBasisQuantityUnitOfMeasure data.lineItems[].priceBasisQuantityUnitOfMeasurestring
Price basis unit of measure classificationDomain data.lineItems[].classificationDomainstring
Product classification domain classificationCode data.lineItems[].classificationCodestring
Product classification code comments data.lineItems[].commentsstring
Line item specific comments orderTotals data.orderTotalsobject
Required Order-level subtotal, tax, and total amounts. subtotal data.orderTotals.subtotalinteger
Required Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. taxAmount data.orderTotals.taxAmountinteger
Required Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. totalAmount data.orderTotals.totalAmountinteger
Required Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. currency data.orderTotals.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 1.0.9
/edi/contracts/releases/1.0.9/schemas/purchase-order.schema.json View Hide Schema
purchase-order.schema.json
docType docTypeconstant
Required Canonical document type. For purchase orders this value is PO. correlationId correlationIdstring
Required Stable UUID used to trace this purchase order through downstream acknowledgements, shipments, invoices, and support workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical document. metadata metadataobject
Required Public source metadata retained for integration troubleshooting without exposing tenant or credential details. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionconstant
Required Canonical schema version used to create this document payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentconstant
Required DataShift Edge version that generated the canonical document data dataobject
Required Business payload for the purchase order. poNumber data.poNumberstring
Required Buyer-issued purchase order number. Use this as the primary business reference. poVersion data.poVersionstring
Required Buyer-issued version or revision for this purchase order. operation data.operationstring
Required Standard document operation. Legacy PO change requests map to update. Values: new, update, delete orderType data.orderTypestring
Type of purchase order Values: regular, blanket, release, standing orderDate data.orderDatestring
Required Date and time the buyer issued the order. requestedDeliveryDate data.requestedDeliveryDatestring
Required Buyer-requested delivery date for the order. comments data.commentsstring
General order comments or instructions dropship data.dropshipboolean
Indicates if this is a direct ship/dropship order. When true, shipping address should be included in outbound mappings (e.g., NetSuite sales orders). buyer data.buyerobject
Required Party placing the order. id data.buyer.idstring
Required name data.buyer.namestring
Required taxRegistrations data.buyer.taxRegistrationsobject
Australian tax registrations for the party type data.buyer.taxRegistrations.typestring
Required Values: ABN value data.buyer.taxRegistrations.valuestring
Required contact data.buyer.contactobject
name data.buyer.contact.namestring
phone data.buyer.contact.phonestring
email data.buyer.contact.emailstring
role data.buyer.contact.rolestring
address data.buyer.addressobject
Standard address structure for DataShift canonical documents addressId data.buyer.address.addressIdstring
addressee data.buyer.address.addresseestring
street1 data.buyer.address.street1string
Required street2 data.buyer.address.street2string
city data.buyer.address.citystring
Required state data.buyer.address.statestring
Required postalCode data.buyer.address.postalCodestring
Required country data.buyer.address.countrystring
Required Values: AU supplier data.supplierobject
Required Party expected to fulfil the order. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsobject
Australian tax registrations for the party type data.supplier.taxRegistrations.typestring
Required Values: ABN value data.supplier.taxRegistrations.valuestring
Required contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressobject
Standard address structure for DataShift canonical documents addressId data.supplier.address.addressIdstring
addressee data.supplier.address.addresseestring
street1 data.supplier.address.street1string
Required street2 data.supplier.address.street2string
city data.supplier.address.citystring
Required state data.supplier.address.statestring
Required postalCode data.supplier.address.postalCodestring
Required country data.supplier.address.countrystring
Required Values: AU billTo data.billToobject
Required Billing destination supplied by the buyer. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU shipTo data.shipToobject
Required Delivery destination for the ordered goods. addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU shipping data.shippingobject
Commercial freight charges and instructions. amount data.shipping.amountinteger
Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
Shipping route method shippingInstructions data.shipping.shippingInstructionsstring
Detailed shipping instructions buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) lineItems data.lineItemsarray
Required Ordered product lines. DataShift manages uniqueLineKey for cross-document line correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Buyer line number from the purchase order. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key used by DataShift connectors to correlate PO, POA, ASN, and INV lines. supplierItemId data.lineItems[].supplierItemIdstring
supplierItemAuxiliaryId data.lineItems[].supplierItemAuxiliaryIdstring
Supplier's alternate/auxiliary part ID buyerItemId data.lineItems[].buyerItemIdstring
description data.lineItems[].descriptionstring
quantity data.lineItems[].quantitynumber
Ordered quantity for this line. unitOfMeasure data.lineItems[].unitOfMeasurestring
Unit of measure code for the ordered quantity. Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPriceinteger
Integer unit price at ISO 4217 minor-unit scale + 2 (e.g. AUD, exponent 2 -> 1/10000: 5.2185 -> 52185). Carries sub-minor precision; not rounded to minor units. currency data.lineItems[].currencystring
ISO 4217 currency code for line pricing. Values: AUD lineAmountExTax data.lineItems[].lineAmountExTaxinteger
Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. lineAmountInclTax data.lineItems[].lineAmountInclTaxinteger
Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. requestedDeliveryDate data.lineItems[].requestedDeliveryDatestring
priceBasisQuantityQuantity data.lineItems[].priceBasisQuantityQuantitynumber
Price basis quantity priceBasisQuantityConversionFactor data.lineItems[].priceBasisQuantityConversionFactornumber
Price basis conversion factor priceBasisQuantityUnitOfMeasure data.lineItems[].priceBasisQuantityUnitOfMeasurestring
Price basis unit of measure classificationDomain data.lineItems[].classificationDomainstring
Product classification domain classificationCode data.lineItems[].classificationCodestring
Product classification code comments data.lineItems[].commentsstring
Line item specific comments orderTotals data.orderTotalsobject
Required Order-level subtotal, tax, and total amounts. subtotal data.orderTotals.subtotalinteger
Required Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. taxAmount data.orderTotals.taxAmountinteger
Required Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. totalAmount data.orderTotals.totalAmountinteger
Required Integer amount in ISO 4217 minor units (e.g. AUD in cents, exponent 2: 561.02 -> 56102). Negative for credits or adjustments. currency data.orderTotals.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 1.0.8
/edi/contracts/releases/1.0.8/schemas/purchase-order.schema.json View Hide Schema
purchase-order.schema.json
docType docTypeconstant
Required Canonical document type. For purchase orders this value is PO. correlationId correlationIdstring
Required Stable UUID used to trace this purchase order through downstream acknowledgements, shipments, invoices, and support workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical document. metadata metadataobject
Required Public source metadata retained for integration troubleshooting without exposing tenant or credential details. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionconstant
Required Canonical schema version used to create this document payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentconstant
Required DataShift Edge version that generated the canonical document data dataobject
Required Business payload for the purchase order. poNumber data.poNumberstring
Required Buyer-issued purchase order number. Use this as the primary business reference. poVersion data.poVersionstring
Required Buyer-issued version or revision for this purchase order. operation data.operationstring
Required Standard document operation. Legacy PO change requests map to update. Values: new, update, delete orderType data.orderTypestring
Type of purchase order Values: regular, blanket, release, standing orderDate data.orderDatestring
Required Date and time the buyer issued the order. requestedDeliveryDate data.requestedDeliveryDatestring
Required Buyer-requested delivery date for the order. comments data.commentsstring
General order comments or instructions dropship data.dropshipboolean
Indicates if this is a direct ship/dropship order. When true, shipping address should be included in outbound mappings (e.g., NetSuite sales orders). buyer data.buyerobject
Required Party placing the order. id data.buyer.idstring
Required name data.buyer.namestring
Required taxRegistrations data.buyer.taxRegistrationsobject
Australian tax registrations for the party type data.buyer.taxRegistrations.typestring
Required Values: ABN value data.buyer.taxRegistrations.valuestring
Required contact data.buyer.contactobject
name data.buyer.contact.namestring
phone data.buyer.contact.phonestring
email data.buyer.contact.emailstring
role data.buyer.contact.rolestring
address data.buyer.addressobject
Standard address structure for DataShift canonical documents addressId data.buyer.address.addressIdstring
addressee data.buyer.address.addresseestring
street1 data.buyer.address.street1string
Required street2 data.buyer.address.street2string
city data.buyer.address.citystring
Required state data.buyer.address.statestring
Required postalCode data.buyer.address.postalCodestring
Required country data.buyer.address.countrystring
Required Values: AU supplier data.supplierobject
Required Party expected to fulfil the order. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsobject
Australian tax registrations for the party type data.supplier.taxRegistrations.typestring
Required Values: ABN value data.supplier.taxRegistrations.valuestring
Required contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressobject
Standard address structure for DataShift canonical documents addressId data.supplier.address.addressIdstring
addressee data.supplier.address.addresseestring
street1 data.supplier.address.street1string
Required street2 data.supplier.address.street2string
city data.supplier.address.citystring
Required state data.supplier.address.statestring
Required postalCode data.supplier.address.postalCodestring
Required country data.supplier.address.countrystring
Required Values: AU billTo data.billToobject
Required Billing destination supplied by the buyer. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU shipTo data.shipToobject
Required Delivery destination for the ordered goods. addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU shipping data.shippingobject
Commercial freight charges and instructions. amount data.shipping.amountinteger
Settled monetary amount as an integer in ISO 4217 minor units. The minor-unit exponent is resolved from the in-scope `currency` via the DataShift currency registry (e.g. AUD has exponent 2 -> cents: 561.02 is encoded 56102; JPY exponent 0; KWD exponent 3). Negative values represent adjustments or credits. Never a fractional/decimal value. currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
Shipping route method shippingInstructions data.shipping.shippingInstructionsstring
Detailed shipping instructions buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) lineItems data.lineItemsarray
Required Ordered product lines. DataShift manages uniqueLineKey for cross-document line correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Buyer line number from the purchase order. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key used by DataShift connectors to correlate PO, POA, ASN, and INV lines. supplierItemId data.lineItems[].supplierItemIdstring
supplierItemAuxiliaryId data.lineItems[].supplierItemAuxiliaryIdstring
Supplier's alternate/auxiliary part ID buyerItemId data.lineItems[].buyerItemIdstring
description data.lineItems[].descriptionstring
quantity data.lineItems[].quantitynumber
Ordered quantity for this line. unitOfMeasure data.lineItems[].unitOfMeasurestring
Unit of measure code for the ordered quantity. Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPriceinteger
Unit price as an integer at the currency rate scale (minorUnitExponent + 2; e.g. AUD -> 1/10000: 5.2185 is encoded 52185). The scale is resolved from the in-scope `currency` via the DataShift currency registry. Unit prices legitimately carry sub-minor-unit precision and MUST NOT be rounded to minor units. Never a fractional/decimal value. currency data.lineItems[].currencystring
ISO 4217 currency code for line pricing. Values: AUD lineAmountExTax data.lineItems[].lineAmountExTaxinteger
Settled monetary amount as an integer in ISO 4217 minor units. The minor-unit exponent is resolved from the in-scope `currency` via the DataShift currency registry (e.g. AUD has exponent 2 -> cents: 561.02 is encoded 56102; JPY exponent 0; KWD exponent 3). Negative values represent adjustments or credits. Never a fractional/decimal value. lineAmountInclTax data.lineItems[].lineAmountInclTaxinteger
Settled monetary amount as an integer in ISO 4217 minor units. The minor-unit exponent is resolved from the in-scope `currency` via the DataShift currency registry (e.g. AUD has exponent 2 -> cents: 561.02 is encoded 56102; JPY exponent 0; KWD exponent 3). Negative values represent adjustments or credits. Never a fractional/decimal value. requestedDeliveryDate data.lineItems[].requestedDeliveryDatestring
priceBasisQuantityQuantity data.lineItems[].priceBasisQuantityQuantitynumber
Price basis quantity priceBasisQuantityConversionFactor data.lineItems[].priceBasisQuantityConversionFactornumber
Price basis conversion factor priceBasisQuantityUnitOfMeasure data.lineItems[].priceBasisQuantityUnitOfMeasurestring
Price basis unit of measure classificationDomain data.lineItems[].classificationDomainstring
Product classification domain classificationCode data.lineItems[].classificationCodestring
Product classification code comments data.lineItems[].commentsstring
Line item specific comments orderTotals data.orderTotalsobject
Required Order-level subtotal, tax, and total amounts. subtotal data.orderTotals.subtotalinteger
Required Settled monetary amount as an integer in ISO 4217 minor units. The minor-unit exponent is resolved from the in-scope `currency` via the DataShift currency registry (e.g. AUD has exponent 2 -> cents: 561.02 is encoded 56102; JPY exponent 0; KWD exponent 3). Negative values represent adjustments or credits. Never a fractional/decimal value. taxAmount data.orderTotals.taxAmountinteger
Required Settled monetary amount as an integer in ISO 4217 minor units. The minor-unit exponent is resolved from the in-scope `currency` via the DataShift currency registry (e.g. AUD has exponent 2 -> cents: 561.02 is encoded 56102; JPY exponent 0; KWD exponent 3). Negative values represent adjustments or credits. Never a fractional/decimal value. totalAmount data.orderTotals.totalAmountinteger
Required Settled monetary amount as an integer in ISO 4217 minor units. The minor-unit exponent is resolved from the in-scope `currency` via the DataShift currency registry (e.g. AUD has exponent 2 -> cents: 561.02 is encoded 56102; JPY exponent 0; KWD exponent 3). Negative values represent adjustments or credits. Never a fractional/decimal value. currency data.orderTotals.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 1.0.7
/edi/contracts/releases/1.0.7/schemas/purchase-order.schema.json View Hide Schema
purchase-order.schema.json
docType docTypeconstant
Required Canonical document type. For purchase orders this value is PO. correlationId correlationIdstring
Required Stable UUID used to trace this purchase order through downstream acknowledgements, shipments, invoices, and support workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical document. metadata metadataobject
Required Public source metadata retained for integration troubleshooting without exposing tenant or credential details. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionconstant
Required Canonical schema version used to create this document payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentconstant
Required DataShift Edge version that generated the canonical document data dataobject
Required Business payload for the purchase order. poNumber data.poNumberstring
Required Buyer-issued purchase order number. Use this as the primary business reference. poVersion data.poVersionstring
Required Buyer-issued version or revision for this purchase order. operation data.operationstring
Required Standard document operation. Legacy PO change requests map to update. Values: new, update, delete orderType data.orderTypestring
Type of purchase order Values: regular, blanket, release, standing orderDate data.orderDatestring
Required Date and time the buyer issued the order. requestedDeliveryDate data.requestedDeliveryDatestring
Required Buyer-requested delivery date for the order. comments data.commentsstring
General order comments or instructions dropship data.dropshipboolean
Indicates if this is a direct ship/dropship order. When true, shipping address should be included in outbound mappings (e.g., NetSuite sales orders). buyer data.buyerobject
Required Party placing the order. id data.buyer.idstring
Required name data.buyer.namestring
Required taxRegistrations data.buyer.taxRegistrationsobject
Australian tax registrations for the party type data.buyer.taxRegistrations.typestring
Required Values: ABN value data.buyer.taxRegistrations.valuestring
Required contact data.buyer.contactobject
name data.buyer.contact.namestring
phone data.buyer.contact.phonestring
email data.buyer.contact.emailstring
role data.buyer.contact.rolestring
address data.buyer.addressobject
Standard address structure for DataShift canonical documents addressId data.buyer.address.addressIdstring
addressee data.buyer.address.addresseestring
street1 data.buyer.address.street1string
Required street2 data.buyer.address.street2string
city data.buyer.address.citystring
Required state data.buyer.address.statestring
Required postalCode data.buyer.address.postalCodestring
Required country data.buyer.address.countrystring
Required Values: AU supplier data.supplierobject
Required Party expected to fulfil the order. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsobject
Australian tax registrations for the party type data.supplier.taxRegistrations.typestring
Required Values: ABN value data.supplier.taxRegistrations.valuestring
Required contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressobject
Standard address structure for DataShift canonical documents addressId data.supplier.address.addressIdstring
addressee data.supplier.address.addresseestring
street1 data.supplier.address.street1string
Required street2 data.supplier.address.street2string
city data.supplier.address.citystring
Required state data.supplier.address.statestring
Required postalCode data.supplier.address.postalCodestring
Required country data.supplier.address.countrystring
Required Values: AU billTo data.billToobject
Required Billing destination supplied by the buyer. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU shipTo data.shipToobject
Required Delivery destination for the ordered goods. addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU shipping data.shippingobject
Commercial freight charges and instructions. amount data.shipping.amountnumber
currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
Shipping route method shippingInstructions data.shipping.shippingInstructionsstring
Detailed shipping instructions buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) lineItems data.lineItemsarray
Required Ordered product lines. DataShift manages uniqueLineKey for cross-document line correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Buyer line number from the purchase order. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key used by DataShift connectors to correlate PO, POA, ASN, and INV lines. supplierItemId data.lineItems[].supplierItemIdstring
supplierItemAuxiliaryId data.lineItems[].supplierItemAuxiliaryIdstring
Supplier's alternate/auxiliary part ID buyerItemId data.lineItems[].buyerItemIdstring
description data.lineItems[].descriptionstring
quantity data.lineItems[].quantitynumber
Ordered quantity for this line. unitOfMeasure data.lineItems[].unitOfMeasurestring
Unit of measure code for the ordered quantity. Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
currency data.lineItems[].currencystring
ISO 4217 currency code for line pricing. Values: AUD lineAmountExTax data.lineItems[].lineAmountExTaxnumber
lineAmountInclTax data.lineItems[].lineAmountInclTaxnumber
requestedDeliveryDate data.lineItems[].requestedDeliveryDatestring
priceBasisQuantityQuantity data.lineItems[].priceBasisQuantityQuantitynumber
Price basis quantity priceBasisQuantityConversionFactor data.lineItems[].priceBasisQuantityConversionFactornumber
Price basis conversion factor priceBasisQuantityUnitOfMeasure data.lineItems[].priceBasisQuantityUnitOfMeasurestring
Price basis unit of measure classificationDomain data.lineItems[].classificationDomainstring
Product classification domain classificationCode data.lineItems[].classificationCodestring
Product classification code comments data.lineItems[].commentsstring
Line item specific comments orderTotals data.orderTotalsobject
Required Order-level subtotal, tax, and total amounts. subtotal data.orderTotals.subtotalnumber
Required taxAmount data.orderTotals.taxAmountnumber
Required totalAmount data.orderTotals.totalAmountnumber
Required currency data.orderTotals.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 1.0.6
/edi/contracts/releases/1.0.6/schemas/purchase-order.schema.json View Hide Schema
purchase-order.schema.json
docType docTypeconstant
Required Canonical document type. For purchase orders this value is PO. correlationId correlationIdstring
Required Stable UUID used to trace this purchase order through downstream acknowledgements, shipments, invoices, and support workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical document. metadata metadataobject
Required Public source metadata retained for integration troubleshooting without exposing tenant or credential details. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionstring
Required payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentstring
Required System that generated the document data dataobject
Required Business payload for the purchase order. poNumber data.poNumberstring
Required Buyer-issued purchase order number. Use this as the primary business reference. poVersion data.poVersionstring
Required Buyer-issued version or revision for this purchase order. operation data.operationstring
Required Standard document operation. Legacy PO change requests map to update. Values: new, update, delete orderType data.orderTypestring
Type of purchase order Values: regular, blanket, release, standing orderDate data.orderDatestring
Required Date and time the buyer issued the order. requestedDeliveryDate data.requestedDeliveryDatestring
Required Buyer-requested delivery date for the order. comments data.commentsstring
General order comments or instructions dropship data.dropshipboolean
Indicates if this is a direct ship/dropship order. When true, shipping address should be included in outbound mappings (e.g., NetSuite sales orders). buyer data.buyerobject
Required Party placing the order. id data.buyer.idstring
Required name data.buyer.namestring
Required taxRegistrations data.buyer.taxRegistrationsobject
Australian tax registrations for the party type data.buyer.taxRegistrations.typestring
Required Values: ABN value data.buyer.taxRegistrations.valuestring
Required contact data.buyer.contactobject
name data.buyer.contact.namestring
phone data.buyer.contact.phonestring
email data.buyer.contact.emailstring
role data.buyer.contact.rolestring
address data.buyer.addressobject
Standard address structure for DataShift canonical documents addressId data.buyer.address.addressIdstring
addressee data.buyer.address.addresseestring
street1 data.buyer.address.street1string
Required street2 data.buyer.address.street2string
city data.buyer.address.citystring
Required state data.buyer.address.statestring
Required postalCode data.buyer.address.postalCodestring
Required country data.buyer.address.countrystring
Required Values: AU supplier data.supplierobject
Required Party expected to fulfil the order. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsobject
Australian tax registrations for the party type data.supplier.taxRegistrations.typestring
Required Values: ABN value data.supplier.taxRegistrations.valuestring
Required contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressobject
Standard address structure for DataShift canonical documents addressId data.supplier.address.addressIdstring
addressee data.supplier.address.addresseestring
street1 data.supplier.address.street1string
Required street2 data.supplier.address.street2string
city data.supplier.address.citystring
Required state data.supplier.address.statestring
Required postalCode data.supplier.address.postalCodestring
Required country data.supplier.address.countrystring
Required Values: AU billTo data.billToobject
Required Billing destination supplied by the buyer. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU shipTo data.shipToobject
Required Delivery destination for the ordered goods. addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU shipping data.shippingobject
Commercial freight charges and instructions. amount data.shipping.amountnumber
currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
Shipping route method shippingInstructions data.shipping.shippingInstructionsstring
Detailed shipping instructions buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) lineItems data.lineItemsarray
Required Ordered product lines. DataShift manages uniqueLineKey for cross-document line correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Buyer line number from the purchase order. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key used by DataShift connectors to correlate PO, POA, ASN, and INV lines. supplierItemId data.lineItems[].supplierItemIdstring
supplierItemAuxiliaryId data.lineItems[].supplierItemAuxiliaryIdstring
Supplier's alternate/auxiliary part ID buyerItemId data.lineItems[].buyerItemIdstring
description data.lineItems[].descriptionstring
quantity data.lineItems[].quantitynumber
Ordered quantity for this line. unitOfMeasure data.lineItems[].unitOfMeasurestring
Unit of measure code for the ordered quantity. Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
currency data.lineItems[].currencystring
ISO 4217 currency code for line pricing. Values: AUD lineAmountExTax data.lineItems[].lineAmountExTaxnumber
lineAmountInclTax data.lineItems[].lineAmountInclTaxnumber
requestedDeliveryDate data.lineItems[].requestedDeliveryDatestring
priceBasisQuantityQuantity data.lineItems[].priceBasisQuantityQuantitynumber
Price basis quantity priceBasisQuantityConversionFactor data.lineItems[].priceBasisQuantityConversionFactornumber
Price basis conversion factor priceBasisQuantityUnitOfMeasure data.lineItems[].priceBasisQuantityUnitOfMeasurestring
Price basis unit of measure classificationDomain data.lineItems[].classificationDomainstring
Product classification domain classificationCode data.lineItems[].classificationCodestring
Product classification code comments data.lineItems[].commentsstring
Line item specific comments orderTotals data.orderTotalsobject
Required Order-level subtotal, tax, and total amounts. subtotal data.orderTotals.subtotalnumber
Required taxAmount data.orderTotals.taxAmountnumber
Required totalAmount data.orderTotals.totalAmountnumber
Required currency data.orderTotals.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 1.0.5
/edi/contracts/releases/1.0.5/schemas/purchase-order.schema.json View Hide Schema
purchase-order.schema.json
docType docTypeconstant
Required Canonical document type. For purchase orders this value is PO. correlationId correlationIdstring
Required Stable UUID used to trace this purchase order through downstream acknowledgements, shipments, invoices, and support workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical document. metadata metadataobject
Required Public source metadata retained for integration troubleshooting without exposing tenant or credential details. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionstring
Required payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentstring
Required System that generated the document data dataobject
Required Business payload for the purchase order. poNumber data.poNumberstring
Required Buyer-issued purchase order number. Use this as the primary business reference. poVersion data.poVersionstring
Required Buyer-issued version or revision for this purchase order. operation data.operationstring
Required Standard document operation. Legacy PO change requests map to update. Values: new, update, delete orderType data.orderTypestring
Type of purchase order Values: regular, blanket, release, standing orderDate data.orderDatestring
Required Date and time the buyer issued the order. requestedDeliveryDate data.requestedDeliveryDatestring
Required Buyer-requested delivery date for the order. comments data.commentsstring
General order comments or instructions dropship data.dropshipboolean
Indicates if this is a direct ship/dropship order. When true, shipping address should be included in outbound mappings (e.g., NetSuite sales orders). buyer data.buyerobject
Required Party placing the order. id data.buyer.idstring
Required name data.buyer.namestring
Required taxRegistrations data.buyer.taxRegistrationsobject
Australian tax registrations for the party type data.buyer.taxRegistrations.typestring
Required Values: ABN value data.buyer.taxRegistrations.valuestring
Required contact data.buyer.contactobject
name data.buyer.contact.namestring
phone data.buyer.contact.phonestring
email data.buyer.contact.emailstring
role data.buyer.contact.rolestring
address data.buyer.addressobject
Standard address structure for DataShift canonical documents addressId data.buyer.address.addressIdstring
addressee data.buyer.address.addresseestring
Required street1 data.buyer.address.street1string
Required street2 data.buyer.address.street2string
city data.buyer.address.citystring
Required state data.buyer.address.statestring
Required postalCode data.buyer.address.postalCodestring
Required country data.buyer.address.countrystring
Required Values: AU supplier data.supplierobject
Required Party expected to fulfil the order. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsobject
Australian tax registrations for the party type data.supplier.taxRegistrations.typestring
Required Values: ABN value data.supplier.taxRegistrations.valuestring
Required contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressobject
Standard address structure for DataShift canonical documents addressId data.supplier.address.addressIdstring
addressee data.supplier.address.addresseestring
Required street1 data.supplier.address.street1string
Required street2 data.supplier.address.street2string
city data.supplier.address.citystring
Required state data.supplier.address.statestring
Required postalCode data.supplier.address.postalCodestring
Required country data.supplier.address.countrystring
Required Values: AU billTo data.billToobject
Required Billing destination supplied by the buyer. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
Required street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU shipTo data.shipToobject
Required Delivery destination for the ordered goods. addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
Required street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU shipping data.shippingobject
Commercial freight charges and instructions. amount data.shipping.amountnumber
currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
Shipping route method shippingInstructions data.shipping.shippingInstructionsstring
Detailed shipping instructions buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) lineItems data.lineItemsarray
Required Ordered product lines. DataShift manages uniqueLineKey for cross-document line correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Buyer line number from the purchase order. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key used by DataShift connectors to correlate PO, POA, ASN, and INV lines. supplierItemId data.lineItems[].supplierItemIdstring
supplierItemAuxiliaryId data.lineItems[].supplierItemAuxiliaryIdstring
Supplier's alternate/auxiliary part ID buyerItemId data.lineItems[].buyerItemIdstring
description data.lineItems[].descriptionstring
quantity data.lineItems[].quantitynumber
Ordered quantity for this line. unitOfMeasure data.lineItems[].unitOfMeasurestring
Unit of measure code for the ordered quantity. Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
currency data.lineItems[].currencystring
ISO 4217 currency code for line pricing. Values: AUD lineAmountExTax data.lineItems[].lineAmountExTaxnumber
lineAmountInclTax data.lineItems[].lineAmountInclTaxnumber
requestedDeliveryDate data.lineItems[].requestedDeliveryDatestring
priceBasisQuantityQuantity data.lineItems[].priceBasisQuantityQuantitynumber
Price basis quantity priceBasisQuantityConversionFactor data.lineItems[].priceBasisQuantityConversionFactornumber
Price basis conversion factor priceBasisQuantityUnitOfMeasure data.lineItems[].priceBasisQuantityUnitOfMeasurestring
Price basis unit of measure classificationDomain data.lineItems[].classificationDomainstring
Product classification domain classificationCode data.lineItems[].classificationCodestring
Product classification code comments data.lineItems[].commentsstring
Line item specific comments orderTotals data.orderTotalsobject
Required Order-level subtotal, tax, and total amounts. subtotal data.orderTotals.subtotalnumber
Required taxAmount data.orderTotals.taxAmountnumber
Required totalAmount data.orderTotals.totalAmountnumber
Required currency data.orderTotals.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 1.0.4
/edi/contracts/releases/1.0.4/schemas/purchase-order.schema.json View Hide Schema
purchase-order.schema.json
docType docTypeconstant
Required Canonical document type. For purchase orders this value is PO. correlationId correlationIdstring
Required Stable UUID used to trace this purchase order through downstream acknowledgements, shipments, invoices, and support workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical document. metadata metadataobject
Required Public source metadata retained for integration troubleshooting without exposing tenant or credential details. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionstring
Required payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentstring
Required System that generated the document data dataobject
Required Business payload for the purchase order. poNumber data.poNumberstring
Required Buyer-issued purchase order number. Use this as the primary business reference. poVersion data.poVersionstring
Required Buyer-issued version or revision for this purchase order. operation data.operationstring
Required Standard document operation. Legacy PO change requests map to update. Values: new, update, delete orderType data.orderTypestring
Type of purchase order Values: regular, blanket, release, standing orderDate data.orderDatestring
Required Date and time the buyer issued the order. requestedDeliveryDate data.requestedDeliveryDatestring
Required Buyer-requested delivery date for the order. comments data.commentsstring
General order comments or instructions dropship data.dropshipboolean
Indicates if this is a direct ship/dropship order. When true, shipping address should be included in outbound mappings (e.g., NetSuite sales orders). buyer data.buyerobject
Required Party placing the order. id data.buyer.idstring
Required name data.buyer.namestring
Required taxRegistrations data.buyer.taxRegistrationsarray
Australian tax registrations for the party type data.buyer.taxRegistrations[].typestring
Values: ABN value data.buyer.taxRegistrations[].valuestring
contact data.buyer.contactobject
name data.buyer.contact.namestring
phone data.buyer.contact.phonestring
email data.buyer.contact.emailstring
role data.buyer.contact.rolestring
address data.buyer.addressobject
Standard address structure for DataShift canonical documents addressId data.buyer.address.addressIdstring
addressee data.buyer.address.addresseestring
Required street1 data.buyer.address.street1string
Required street2 data.buyer.address.street2string
city data.buyer.address.citystring
Required state data.buyer.address.statestring
Required postalCode data.buyer.address.postalCodestring
Required country data.buyer.address.countrystring
Required Values: AU supplier data.supplierobject
Required Party expected to fulfil the order. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsarray
Australian tax registrations for the party type data.supplier.taxRegistrations[].typestring
Values: ABN value data.supplier.taxRegistrations[].valuestring
contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressobject
Standard address structure for DataShift canonical documents addressId data.supplier.address.addressIdstring
addressee data.supplier.address.addresseestring
Required street1 data.supplier.address.street1string
Required street2 data.supplier.address.street2string
city data.supplier.address.citystring
Required state data.supplier.address.statestring
Required postalCode data.supplier.address.postalCodestring
Required country data.supplier.address.countrystring
Required Values: AU billTo data.billToobject
Required Billing destination supplied by the buyer. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
Required street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU shipTo data.shipToobject
Required Delivery destination for the ordered goods. addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
Required street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU shipping data.shippingobject
Commercial freight charges and instructions. amount data.shipping.amountnumber
currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
Shipping route method shippingInstructions data.shipping.shippingInstructionsstring
Detailed shipping instructions buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) lineItems data.lineItemsarray
Required Ordered product lines. DataShift manages uniqueLineKey for cross-document line correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Buyer line number from the purchase order. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key used by DataShift connectors to correlate PO, POA, ASN, and INV lines. supplierItemId data.lineItems[].supplierItemIdstring
supplierItemAuxiliaryId data.lineItems[].supplierItemAuxiliaryIdstring
Supplier's alternate/auxiliary part ID buyerItemId data.lineItems[].buyerItemIdstring
description data.lineItems[].descriptionstring
quantity data.lineItems[].quantitynumber
Ordered quantity for this line. unitOfMeasure data.lineItems[].unitOfMeasurestring
Unit of measure code for the ordered quantity. Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
currency data.lineItems[].currencystring
ISO 4217 currency code for line pricing. Values: AUD lineAmountExTax data.lineItems[].lineAmountExTaxnumber
lineAmountInclTax data.lineItems[].lineAmountInclTaxnumber
requestedDeliveryDate data.lineItems[].requestedDeliveryDatestring
priceBasisQuantityQuantity data.lineItems[].priceBasisQuantityQuantitynumber
Price basis quantity priceBasisQuantityConversionFactor data.lineItems[].priceBasisQuantityConversionFactornumber
Price basis conversion factor priceBasisQuantityUnitOfMeasure data.lineItems[].priceBasisQuantityUnitOfMeasurestring
Price basis unit of measure classificationDomain data.lineItems[].classificationDomainstring
Product classification domain classificationCode data.lineItems[].classificationCodestring
Product classification code comments data.lineItems[].commentsstring
Line item specific comments orderTotals data.orderTotalsobject
Required Order-level subtotal, tax, and total amounts. subtotal data.orderTotals.subtotalnumber
Required taxAmount data.orderTotals.taxAmountnumber
Required totalAmount data.orderTotals.totalAmountnumber
Required currency data.orderTotals.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 1.0.3
/edi/contracts/releases/1.0.3/schemas/purchase-order.schema.json View Hide Schema
purchase-order.schema.json
docType docTypeconstant
Required Canonical document type. For purchase orders this value is PO. correlationId correlationIdstring
Required Stable UUID used to trace this purchase order through downstream acknowledgements, shipments, invoices, and support workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical document. metadata metadataobject
Required Public source metadata retained for integration troubleshooting without exposing tenant or credential details. sourceLanguage metadata.sourceLanguagestring
Required Values: json, cxml sourceVersion metadata.sourceVersionstring
Required payloadId metadata.payloadIdstring
Original cXML payload ID userAgent metadata.userAgentstring
Required System that generated the document data dataobject
Required Business payload for the purchase order. poNumber data.poNumberstring
Required Buyer-issued purchase order number. Use this as the primary business reference. poVersion data.poVersionstring
Required Buyer-issued version or revision for this purchase order. operation data.operationstring
Required Standard document operation. Legacy PO change requests map to update. Values: new, update, delete orderType data.orderTypestring
Type of purchase order Values: regular, blanket, release, standing orderDate data.orderDatestring
Required Date and time the buyer issued the order. requestedDeliveryDate data.requestedDeliveryDatestring
Required Buyer-requested delivery date for the order. comments data.commentsstring
General order comments or instructions dropship data.dropshipboolean
Indicates if this is a direct ship/dropship order. When true, shipping address should be included in outbound mappings (e.g., NetSuite sales orders). buyer data.buyerobject
Required Party placing the order. id data.buyer.idstring
Required name data.buyer.namestring
Required taxRegistrations data.buyer.taxRegistrationsarray
Australian tax registrations for the party type data.buyer.taxRegistrations[].typestring
Values: ABN value data.buyer.taxRegistrations[].valuestring
contact data.buyer.contactobject
name data.buyer.contact.namestring
phone data.buyer.contact.phonestring
email data.buyer.contact.emailstring
role data.buyer.contact.rolestring
address data.buyer.addressunknown
supplier data.supplierobject
Required Party expected to fulfil the order. id data.supplier.idstring
Required name data.supplier.namestring
Required taxRegistrations data.supplier.taxRegistrationsarray
Australian tax registrations for the party type data.supplier.taxRegistrations[].typestring
Values: ABN value data.supplier.taxRegistrations[].valuestring
contact data.supplier.contactobject
name data.supplier.contact.namestring
phone data.supplier.contact.phonestring
email data.supplier.contact.emailstring
role data.supplier.contact.rolestring
address data.supplier.addressunknown
billTo data.billToobject
Required Billing destination supplied by the buyer. addressId data.billTo.addressIdstring
addressee data.billTo.addresseestring
Required street1 data.billTo.street1string
Required street2 data.billTo.street2string
city data.billTo.citystring
Required state data.billTo.statestring
Required postalCode data.billTo.postalCodestring
Required country data.billTo.countrystring
Required Values: AU shipTo data.shipToobject
Required Delivery destination for the ordered goods. addressId data.shipTo.addressIdstring
addressee data.shipTo.addresseestring
Required street1 data.shipTo.street1string
Required street2 data.shipTo.street2string
city data.shipTo.citystring
Required state data.shipTo.statestring
Required postalCode data.shipTo.postalCodestring
Required country data.shipTo.countrystring
Required Values: AU shipping data.shippingobject
Commercial freight charges and instructions. amount data.shipping.amountnumber
currency data.shipping.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD carrier data.shipping.carrierstring
route data.shipping.routestring
Shipping route method shippingInstructions data.shipping.shippingInstructionsstring
Detailed shipping instructions buyerAcctNumber data.shipping.buyerAcctNumberstring
incoTerms data.shipping.incoTermsstring
Values: cfr, cif, cip, cpt, daf, dap (+9 more) lineItems data.lineItemsarray
Required Ordered product lines. DataShift manages uniqueLineKey for cross-document line correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Buyer line number from the purchase order. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key used by DataShift connectors to correlate PO, POA, ASN, and INV lines. supplierItemId data.lineItems[].supplierItemIdstring
supplierItemAuxiliaryId data.lineItems[].supplierItemAuxiliaryIdstring
Supplier's alternate/auxiliary part ID buyerItemId data.lineItems[].buyerItemIdstring
description data.lineItems[].descriptionstring
quantity data.lineItems[].quantitynumber
Ordered quantity for this line. unitOfMeasure data.lineItems[].unitOfMeasurestring
Unit of measure code for the ordered quantity. Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
currency data.lineItems[].currencystring
ISO 4217 currency code for line pricing. Values: AUD lineAmountExTax data.lineItems[].lineAmountExTaxnumber
lineAmountInclTax data.lineItems[].lineAmountInclTaxnumber
requestedDeliveryDate data.lineItems[].requestedDeliveryDatestring
priceBasisQuantityQuantity data.lineItems[].priceBasisQuantityQuantitynumber
Price basis quantity priceBasisQuantityConversionFactor data.lineItems[].priceBasisQuantityConversionFactornumber
Price basis conversion factor priceBasisQuantityUnitOfMeasure data.lineItems[].priceBasisQuantityUnitOfMeasurestring
Price basis unit of measure classificationDomain data.lineItems[].classificationDomainstring
Product classification domain classificationCode data.lineItems[].classificationCodestring
Product classification code comments data.lineItems[].commentsstring
Line item specific comments orderTotals data.orderTotalsobject
Required Order-level subtotal, tax, and total amounts. subtotal data.orderTotals.subtotalnumber
Required taxAmount data.orderTotals.taxAmountnumber
Required totalAmount data.orderTotals.totalAmountnumber
Required currency data.orderTotals.currencystring
Required ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 