Back to Purchase Order Acknowledgement POA purchase-order-acknowledgement.schema.json
Purchase Order Acknowledgement 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.6 Latest
/edi/contracts/releases/1.0.6/schemas/purchase-order-acknowledgement.schema.json View Hide Schema
purchase-order-acknowledgement.schema.json
docType docTypeconstant
Required Canonical document type. For purchase order acknowledgements this value is POA. correlationId correlationIdstring
Required Stable UUID used to trace this acknowledgement against the purchase order lifecycle. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical acknowledgement. metadata metadataobject
Required Public source metadata retained for integration troubleshooting. 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 acknowledgement. poaNumber data.poaNumberstring
Required Supplier-assigned acknowledgement identifier used for duplicate detection and support references. confirmationType data.confirmationTypestring
DataShift-managed order-level acknowledgement outcome calculated from line-level status and tolerance validation. Values: accept, reject, except, detail, backordered, allDetail (+1 more) operation data.operationstring
Whether this creates, updates, or deletes a confirmation Values: new, update, delete noticeDate data.noticeDatestring
Required Date and time the supplier created the acknowledgement. poNumber data.poNumberstring
Required Purchase order number being acknowledged. poVersion data.poVersionstring
Purchase order version being acknowledged. orderReference data.orderReferenceobject
Reference to the original purchase order document documentId data.orderReference.documentIdstring
payloadId data.orderReference.payloadIdstring
orderDate data.orderReference.orderDatestring
documentReference data.documentReferenceobject
Reference to previous confirmation (required for operation=update/delete) documentId data.documentReference.documentIdstring
payloadId data.documentReference.payloadIdstring
deliveryDate data.deliveryDatestring
Expected delivery business date-time. Valid ISO offsets are allowed. dropship data.dropshipboolean
Indicates if this is a direct ship/dropship order invoiceId data.invoiceIdstring
Optional supplier-generated invoice ID associated with this confirmation 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
Carrier name route data.shipping.routestring
Shipping route method shippingInstructions data.shipping.shippingInstructionsstring
Detailed shipping instructions buyerAcctNumber data.shipping.buyerAcctNumberstring
Buyer's shipping account number incoTerms data.shipping.incoTermsstring
International Commercial Terms Values: cfr, cif, cip, cpt, daf, dap (+9 more) tax data.taxobject
Tax adjustments from original order amount data.tax.amountnumber
currency data.tax.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD total data.totalobject
Order total adjustments amount data.total.amountnumber
currency data.total.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD contacts data.contactsarray
Contact information for various roles role data.contacts[].rolestring
Values: shipFrom, shipTo, billTo, technicalSupport, customerService, sales (+1 more) name data.contacts[].namestring
email data.contacts[].emailstring
phone data.contacts[].phonestring
billTo data.billToobject
Standard address structure for DataShift canonical documents 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
Standard address structure for DataShift canonical documents 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 comments data.commentsstring
Human-readable notes about this confirmation lineItems data.lineItemsarray
Required Acknowledgement lines. DataShift manages uniqueLineKey correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Line number from the original purchase order. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key from the original purchase order, used by internal connectors for cross-document correlation. statusType data.lineItems[].statusTypestring
System-calculated status based on tolerance validation. Not mappable by sender; use supplierLineStatus for sender intent. Values: accept, reject, backordered, unknown, detail, allDetail supplierLineStatus data.lineItems[].supplierLineStatusstring
Supplier-provided line acknowledgement intent. Defaults to unknown when omitted or blank. Values: accept, reject, backordered, unknown supplierItemId data.lineItems[].supplierItemIdstring
Supplier's part/item number supplierItemAuxiliaryId data.lineItems[].supplierItemAuxiliaryIdstring
Supplier's alternate/auxiliary part ID buyerItemId data.lineItems[].buyerItemIdstring
Buyer's part/item number gtin data.lineItems[].gtinstring
Global Trade Item Number (GTIN-8, GTIN-12, GTIN-13, or GTIN-14) description data.lineItems[].descriptionstring
Item description originalQuantity data.lineItems[].originalQuantitynumber
Quantity originally ordered confirmedQuantity data.lineItems[].confirmedQuantitynumber
Quantity the supplier confirms for this line. quantityBackordered data.lineItems[].quantityBackorderednumber
Quantity backordered by the supplier unitOfMeasure data.lineItems[].unitOfMeasurestring
UN/ECE Recommendation 20 unit of measure codes for DataShift canonical documents Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
Confirmed unit price (if different from order) currency data.lineItems[].currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD unitPriceUom data.lineItems[].unitPriceUomstring
Unit of measure for price basis (e.g., price per 100) lineTotalExTax data.lineItems[].lineTotalExTaxnumber
lineTotalInclTax data.lineItems[].lineTotalInclTaxnumber
classificationDomain data.lineItems[].classificationDomainstring
Product classification domain classificationCode data.lineItems[].classificationCodestring
Product classification code shipmentDate data.lineItems[].shipmentDatestring
Expected or actual shipment date for this line deliveryDate data.lineItems[].deliveryDatestring
Expected delivery date for this line rejectionReason data.lineItems[].rejectionReasonstring
Reason for rejection or backorder substitution data.lineItems[].substitutionobject
Substitute item details if supplier is offering an alternative supplierItemId data.lineItems[].substitution.supplierItemIdstring
buyerItemId data.lineItems[].substitution.buyerItemIdstring
description data.lineItems[].substitution.descriptionstring
quantity data.lineItems[].substitution.quantitynumber
unitOfMeasure data.lineItems[].substitution.unitOfMeasurestring
UN/ECE Recommendation 20 unit of measure codes for DataShift canonical documents Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].substitution.unitPricenumber
comments data.lineItems[].commentsstring
Line-level comments 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-acknowledgement.schema.json View Hide Schema
purchase-order-acknowledgement.schema.json
docType docTypeconstant
Required Canonical document type. For purchase order acknowledgements this value is POA. correlationId correlationIdstring
Required Stable UUID used to trace this acknowledgement against the purchase order lifecycle. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical acknowledgement. metadata metadataobject
Required Public source metadata retained for integration troubleshooting. 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 acknowledgement. poaNumber data.poaNumberstring
Required Supplier-assigned acknowledgement identifier used for duplicate detection and support references. confirmationType data.confirmationTypestring
Required Order-level acknowledgement outcome calculated from line-level status and tolerance validation. Values: accept, reject, except, detail, backordered, allDetail (+1 more) operation data.operationstring
Whether this creates, updates, or deletes a confirmation Values: new, update, delete noticeDate data.noticeDatestring
Required Date and time the supplier created the acknowledgement. poNumber data.poNumberstring
Required Purchase order number being acknowledged. poVersion data.poVersionstring
Purchase order version being acknowledged. orderReference data.orderReferenceobject
Reference to the original purchase order document documentId data.orderReference.documentIdstring
payloadId data.orderReference.payloadIdstring
orderDate data.orderReference.orderDatestring
documentReference data.documentReferenceobject
Reference to previous confirmation (required for operation=update/delete) documentId data.documentReference.documentIdstring
payloadId data.documentReference.payloadIdstring
deliveryDate data.deliveryDatestring
Expected delivery business date-time. Valid ISO offsets are allowed. dropship data.dropshipboolean
Indicates if this is a direct ship/dropship order invoiceId data.invoiceIdstring
Optional supplier-generated invoice ID associated with this confirmation 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
Carrier name route data.shipping.routestring
Shipping route method shippingInstructions data.shipping.shippingInstructionsstring
Detailed shipping instructions buyerAcctNumber data.shipping.buyerAcctNumberstring
Buyer's shipping account number incoTerms data.shipping.incoTermsstring
International Commercial Terms Values: cfr, cif, cip, cpt, daf, dap (+9 more) tax data.taxobject
Tax adjustments from original order amount data.tax.amountnumber
currency data.tax.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD total data.totalobject
Order total adjustments amount data.total.amountnumber
currency data.total.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD contacts data.contactsarray
Contact information for various roles role data.contacts[].rolestring
Values: shipFrom, shipTo, billTo, technicalSupport, customerService, sales (+1 more) name data.contacts[].namestring
email data.contacts[].emailstring
phone data.contacts[].phonestring
billTo data.billToobject
Standard address structure for DataShift canonical documents 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
Standard address structure for DataShift canonical documents 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 comments data.commentsstring
Human-readable notes about this confirmation lineItems data.lineItemsarray
Required Acknowledgement lines. DataShift manages uniqueLineKey correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Line number from the original purchase order. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key from the original purchase order, used by internal connectors for cross-document correlation. statusType data.lineItems[].statusTypestring
System-calculated status based on tolerance validation. Not mappable by sender; use supplierLineStatus for sender intent. Values: accept, reject, backordered, unknown, detail, allDetail supplierLineStatus data.lineItems[].supplierLineStatusstring
Supplier-provided line acknowledgement intent. Values: accept, reject, backordered, unknown supplierItemId data.lineItems[].supplierItemIdstring
Supplier's part/item number supplierItemAuxiliaryId data.lineItems[].supplierItemAuxiliaryIdstring
Supplier's alternate/auxiliary part ID buyerItemId data.lineItems[].buyerItemIdstring
Buyer's part/item number gtin data.lineItems[].gtinstring
Global Trade Item Number (GTIN-8, GTIN-12, GTIN-13, or GTIN-14) description data.lineItems[].descriptionstring
Item description originalQuantity data.lineItems[].originalQuantitynumber
Quantity originally ordered confirmedQuantity data.lineItems[].confirmedQuantitynumber
Quantity the supplier confirms for this line. quantityBackordered data.lineItems[].quantityBackorderednumber
Quantity backordered by the supplier unitOfMeasure data.lineItems[].unitOfMeasurestring
UN/ECE Recommendation 20 unit of measure codes for DataShift canonical documents Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
Confirmed unit price (if different from order) currency data.lineItems[].currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD unitPriceUom data.lineItems[].unitPriceUomstring
Unit of measure for price basis (e.g., price per 100) lineTotalExTax data.lineItems[].lineTotalExTaxnumber
lineTotalInclTax data.lineItems[].lineTotalInclTaxnumber
classificationDomain data.lineItems[].classificationDomainstring
Product classification domain classificationCode data.lineItems[].classificationCodestring
Product classification code shipmentDate data.lineItems[].shipmentDatestring
Expected or actual shipment date for this line deliveryDate data.lineItems[].deliveryDatestring
Expected delivery date for this line rejectionReason data.lineItems[].rejectionReasonstring
Reason for rejection or backorder substitution data.lineItems[].substitutionobject
Substitute item details if supplier is offering an alternative supplierItemId data.lineItems[].substitution.supplierItemIdstring
buyerItemId data.lineItems[].substitution.buyerItemIdstring
description data.lineItems[].substitution.descriptionstring
quantity data.lineItems[].substitution.quantitynumber
unitOfMeasure data.lineItems[].substitution.unitOfMeasurestring
UN/ECE Recommendation 20 unit of measure codes for DataShift canonical documents Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].substitution.unitPricenumber
comments data.lineItems[].commentsstring
Line-level comments 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-acknowledgement.schema.json View Hide Schema
purchase-order-acknowledgement.schema.json
docType docTypeconstant
Required Canonical document type. For purchase order acknowledgements this value is POA. correlationId correlationIdstring
Required Stable UUID used to trace this acknowledgement against the purchase order lifecycle. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical acknowledgement. metadata metadataobject
Required Public source metadata retained for integration troubleshooting. 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 acknowledgement. poaNumber data.poaNumberstring
Required Supplier-assigned acknowledgement identifier used for duplicate detection and support references. confirmationType data.confirmationTypestring
Required Order-level acknowledgement outcome calculated from line-level status and tolerance validation. Values: accept, reject, except, detail, backordered, allDetail (+1 more) operation data.operationstring
Whether this creates, updates, or deletes a confirmation Values: new, update, delete noticeDate data.noticeDatestring
Required Date and time the supplier created the acknowledgement. poNumber data.poNumberstring
Required Purchase order number being acknowledged. poVersion data.poVersionstring
Purchase order version being acknowledged. orderReference data.orderReferenceobject
Reference to the original purchase order document documentId data.orderReference.documentIdstring
payloadId data.orderReference.payloadIdstring
orderDate data.orderReference.orderDatestring
documentReference data.documentReferenceobject
Reference to previous confirmation (required for operation=update/delete) documentId data.documentReference.documentIdstring
payloadId data.documentReference.payloadIdstring
deliveryDate data.deliveryDatestring
Expected delivery business date-time. Valid ISO offsets are allowed. dropship data.dropshipboolean
Indicates if this is a direct ship/dropship order invoiceId data.invoiceIdstring
Optional supplier-generated invoice ID associated with this confirmation 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
Carrier name route data.shipping.routestring
Shipping route method shippingInstructions data.shipping.shippingInstructionsstring
Detailed shipping instructions buyerAcctNumber data.shipping.buyerAcctNumberstring
Buyer's shipping account number incoTerms data.shipping.incoTermsstring
International Commercial Terms Values: cfr, cif, cip, cpt, daf, dap (+9 more) tax data.taxobject
Tax adjustments from original order amount data.tax.amountnumber
currency data.tax.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD total data.totalobject
Order total adjustments amount data.total.amountnumber
currency data.total.currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD contacts data.contactsarray
Contact information for various roles role data.contacts[].rolestring
Values: shipFrom, shipTo, billTo, technicalSupport, customerService, sales (+1 more) name data.contacts[].namestring
email data.contacts[].emailstring
phone data.contacts[].phonestring
billTo data.billToobject
Standard address structure for DataShift canonical documents 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
Standard address structure for DataShift canonical documents 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 comments data.commentsstring
Human-readable notes about this confirmation lineItems data.lineItemsarray
Required Acknowledgement lines. DataShift manages uniqueLineKey correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Line number from the original purchase order. uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key from the original purchase order, used by internal connectors for cross-document correlation. statusType data.lineItems[].statusTypestring
System-calculated status based on tolerance validation. Not mappable by sender; use supplierLineStatus for sender intent. Values: accept, reject, backordered, unknown, detail, allDetail supplierLineStatus data.lineItems[].supplierLineStatusstring
Supplier-provided line acknowledgement intent. Values: accept, reject, backordered, unknown supplierItemId data.lineItems[].supplierItemIdstring
Supplier's part/item number supplierItemAuxiliaryId data.lineItems[].supplierItemAuxiliaryIdstring
Supplier's alternate/auxiliary part ID buyerItemId data.lineItems[].buyerItemIdstring
Buyer's part/item number gtin data.lineItems[].gtinstring
Global Trade Item Number (GTIN-8, GTIN-12, GTIN-13, or GTIN-14) description data.lineItems[].descriptionstring
Item description originalQuantity data.lineItems[].originalQuantitynumber
Quantity originally ordered confirmedQuantity data.lineItems[].confirmedQuantitynumber
Quantity the supplier confirms for this line. quantityBackordered data.lineItems[].quantityBackorderednumber
Quantity backordered by the supplier unitOfMeasure data.lineItems[].unitOfMeasurestring
UN/ECE Recommendation 20 unit of measure codes for DataShift canonical documents Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].unitPricenumber
Confirmed unit price (if different from order) currency data.lineItems[].currencystring
ISO 4217 currency codes supported by DataShift canonical schemas Values: AUD unitPriceUom data.lineItems[].unitPriceUomstring
Unit of measure for price basis (e.g., price per 100) lineTotalExTax data.lineItems[].lineTotalExTaxnumber
lineTotalInclTax data.lineItems[].lineTotalInclTaxnumber
classificationDomain data.lineItems[].classificationDomainstring
Product classification domain classificationCode data.lineItems[].classificationCodestring
Product classification code shipmentDate data.lineItems[].shipmentDatestring
Expected or actual shipment date for this line deliveryDate data.lineItems[].deliveryDatestring
Expected delivery date for this line rejectionReason data.lineItems[].rejectionReasonstring
Reason for rejection or backorder substitution data.lineItems[].substitutionobject
Substitute item details if supplier is offering an alternative supplierItemId data.lineItems[].substitution.supplierItemIdstring
buyerItemId data.lineItems[].substitution.buyerItemIdstring
description data.lineItems[].substitution.descriptionstring
quantity data.lineItems[].substitution.quantitynumber
unitOfMeasure data.lineItems[].substitution.unitOfMeasurestring
UN/ECE Recommendation 20 unit of measure codes for DataShift canonical documents Values: AY, BG, BL, BR, BLL, E2 (+57 more) unitPrice data.lineItems[].substitution.unitPricenumber
comments data.lineItems[].commentsstring
Line-level comments extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 