Back to Advance Shipping Notice ASN advance-shipping-notice.schema.json
Advance Shipping Notice 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/advance-shipping-notice.schema.json View Hide Schema
advance-shipping-notice.schema.json
docType docTypeconstant
Required Canonical document type. For advance shipping notices this value is ASN. correlationId correlationIdstring
Required Stable UUID used to trace this shipment notice through fulfilment and invoice workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical shipment notice. 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 shipment notice. dispatchAdviceNumber data.dispatchAdviceNumberstring
Required Supplier-assigned shipment or dispatch advice identifier. poNumber data.poNumberstring
Required Primary purchase order number this shipment fulfils. operation data.operationstring
Whether this is a new shipment notice, an update, or a cancellation Values: new, update, delete noticeDate data.noticeDatestring
Required Date and time the supplier created the shipment notice. shipmentDate data.shipmentDatestring
Required Date and time the goods left the supplier. deliveryDate data.deliveryDatestring
Expected delivery date and time. requestedDeliveryDate data.requestedDeliveryDatestring
Buyer's originally requested delivery date shipmentType data.shipmentTypestring
Whether this is an actual shipment or a planned/estimated one Values: actual, planned fulfillmentType data.fulfillmentTypestring
Whether this shipment fulfils all or part of the referenced order. Values: partial, complete serviceLevel data.serviceLevelstring
Level of shipping service (e.g., overnight, ground, express) documentReference data.documentReferenceobject
Reference to previous ship notice (required for operation=update/delete) documentId data.documentReference.documentIdstring
payloadId data.documentReference.payloadIdstring
poReferences data.poReferencesarray
References to purchase orders being fulfilled by this shipment poNumber data.poReferences[].poNumberstring
poVersion data.poReferences[].poVersionstring
documentId data.poReferences[].documentIdstring
payloadId data.poReferences[].payloadIdstring
orderDate data.poReferences[].orderDatestring
carrier data.carrierobject
Required Carrier and service details for the shipment. name data.carrier.namestring
Required Carrier company name identifiers data.carrier.identifiersarray
Carrier identification codes domain data.carrier.identifiers[].domainstring
Domain/type of identifier Values: SCAC, IATA, AAR, UIC, EAN, DUNS (+1 more) value data.carrier.identifiers[].valuestring
serviceType data.carrier.serviceTypestring
Type of shipping service shipmentIdentifiers data.shipmentIdentifiersarray
Tracking numbers and shipment identifiers (consignment note, bill of lading, etc.) domain data.shipmentIdentifiers[].domainstring
Type of shipment identifier Values: trackingNumber, billOfLading, proNumber, airWaybill, containerNumber value data.shipmentIdentifiers[].valuestring
termsOfDelivery data.termsOfDeliveryobject
Delivery terms and conditions incoTerms data.termsOfDelivery.incoTermsstring
International Commercial Terms Values: cfr, cif, cip, cpt, daf, dap (+9 more) fobPoint data.termsOfDelivery.fobPointstring
description data.termsOfDelivery.descriptionstring
shipFrom data.shipFromobject
Required Shipment origin. addressId data.shipFrom.addressIdstring
addressee data.shipFrom.addresseestring
street1 data.shipFrom.street1string
Required street2 data.shipFrom.street2string
city data.shipFrom.citystring
Required state data.shipFrom.statestring
Required postalCode data.shipFrom.postalCodestring
Required country data.shipFrom.countrystring
Required Values: AU shipTo data.shipToobject
Required Shipment destination. 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 contacts data.contactsarray
Contact information for various roles role data.contacts[].rolestring
Values: shipFrom, shipTo, carrierCorporate, technicalSupport, customerService name data.contacts[].namestring
email data.contacts[].emailstring
phone data.contacts[].phonestring
comments data.commentsstring
Human-readable notes about this shipment reason data.reasonstring
Reason for shipment if not a standard delivery (e.g., return) Values: return lineItems data.lineItemsarray
Required Authoritative shipped line data. Packages reference these lines; they do not replace them. DataShift manages uniqueLineKey correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Line number from the purchase order being fulfilled. shipNoticeLineNumber data.lineItems[].shipNoticeLineNumberinteger
Sequence number of this line within the ship notice uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key from the original purchase order, used by internal connectors for cross-document correlation. supplierItemId data.lineItems[].supplierItemIdstring
Supplier's part or item number buyerItemId data.lineItems[].buyerItemIdstring
Buyer's part or item number gtin data.lineItems[].gtinstring
GS1 Global Trade Item Number description data.lineItems[].descriptionstring
Item description quantity data.lineItems[].quantitynumber
Quantity shipped on this line. unitOfMeasure data.lineItems[].unitOfMeasurestring
UN/ECE REC20 unit of measure code Values: AY, BG, BL, BR, BLL, E2 (+57 more) countryOfOrigin data.lineItems[].countryOfOriginstring
Country where the item was manufactured Values: AU batchInfo data.lineItems[].batchInfoobject
Lot or batch tracking information batchId data.lineItems[].batchInfo.batchIdstring
productionDate data.lineItems[].batchInfo.productionDatestring
expirationDate data.lineItems[].batchInfo.expirationDatestring
serialNumbers data.lineItems[].serialNumbersarray
Serial numbers for individually serialised items packages data.packagesarray
Physical package or carton detail used for carton allocation and SSCC labelling. packageId data.packages[].packageIdstring
Supplier or warehouse package identifier unique within this shipment. sscc data.packages[].ssccstring
Serial Shipping Container Code for the carton or logistic unit. packagingCode data.packages[].packagingCodestring
Type of packaging (e.g., BOX, PAL, CTN) grossWeight data.packages[].grossWeightobject
Total weight of package including contents value data.packages[].grossWeight.valuenumber
unit data.packages[].grossWeight.unitstring
Values: KG, LB, OZ, G netWeight data.packages[].netWeightobject
Weight of contents only value data.packages[].netWeight.valuenumber
unit data.packages[].netWeight.unitstring
Values: KG, LB, OZ, G dimensions data.packages[].dimensionsobject
Physical dimensions of the package length data.packages[].dimensions.lengthnumber
width data.packages[].dimensions.widthnumber
height data.packages[].dimensions.heightnumber
unit data.packages[].dimensions.unitstring
Values: CM, IN, M, FT lineReferences data.packages[].lineReferencesarray
References to authoritative lineItems packed inside this package. lineNumber data.packages[].lineReferences[].lineNumberinteger
uniqueLineKey data.packages[].lineReferences[].uniqueLineKeystring
DataShift-managed line key from the original purchase order for internal connector correlation quantity data.packages[].lineReferences[].quantitynumber
Quantity of this line item packed in this carton unitOfMeasure data.packages[].lineReferences[].unitOfMeasurestring
Unit of measure for the quantity — must match the parent line item's unitOfMeasure Values: AY, BG, BL, BR, BLL, E2 (+57 more) hazardInfo data.hazardInfoarray
Hazardous materials information unNumber data.hazardInfo[].unNumberstring
hazardClass data.hazardInfo[].hazardClassstring
description data.hazardInfo[].descriptionstring
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/advance-shipping-notice.schema.json View Hide Schema
advance-shipping-notice.schema.json
docType docTypeconstant
Required Canonical document type. For advance shipping notices this value is ASN. correlationId correlationIdstring
Required Stable UUID used to trace this shipment notice through fulfilment and invoice workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical shipment notice. 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 shipment notice. dispatchAdviceNumber data.dispatchAdviceNumberstring
Required Supplier-assigned shipment or dispatch advice identifier. poNumber data.poNumberstring
Required Primary purchase order number this shipment fulfils. operation data.operationstring
Whether this is a new shipment notice, an update, or a cancellation Values: new, update, delete noticeDate data.noticeDatestring
Required Date and time the supplier created the shipment notice. shipmentDate data.shipmentDatestring
Required Date and time the goods left the supplier. deliveryDate data.deliveryDatestring
Expected delivery date and time. requestedDeliveryDate data.requestedDeliveryDatestring
Buyer's originally requested delivery date shipmentType data.shipmentTypestring
Whether this is an actual shipment or a planned/estimated one Values: actual, planned fulfillmentType data.fulfillmentTypestring
Whether this shipment fulfils all or part of the referenced order. Values: partial, complete serviceLevel data.serviceLevelstring
Level of shipping service (e.g., overnight, ground, express) documentReference data.documentReferenceobject
Reference to previous ship notice (required for operation=update/delete) documentId data.documentReference.documentIdstring
payloadId data.documentReference.payloadIdstring
poReferences data.poReferencesarray
References to purchase orders being fulfilled by this shipment poNumber data.poReferences[].poNumberstring
poVersion data.poReferences[].poVersionstring
documentId data.poReferences[].documentIdstring
payloadId data.poReferences[].payloadIdstring
orderDate data.poReferences[].orderDatestring
carrier data.carrierobject
Required Carrier and service details for the shipment. name data.carrier.namestring
Required Carrier company name identifiers data.carrier.identifiersarray
Carrier identification codes domain data.carrier.identifiers[].domainstring
Domain/type of identifier Values: SCAC, IATA, AAR, UIC, EAN, DUNS (+1 more) value data.carrier.identifiers[].valuestring
serviceType data.carrier.serviceTypestring
Type of shipping service shipmentIdentifiers data.shipmentIdentifiersarray
Tracking numbers and shipment identifiers (consignment note, bill of lading, etc.) domain data.shipmentIdentifiers[].domainstring
Type of shipment identifier Values: trackingNumber, billOfLading, proNumber, airWaybill, containerNumber value data.shipmentIdentifiers[].valuestring
termsOfDelivery data.termsOfDeliveryobject
Delivery terms and conditions incoTerms data.termsOfDelivery.incoTermsstring
International Commercial Terms Values: cfr, cif, cip, cpt, daf, dap (+9 more) fobPoint data.termsOfDelivery.fobPointstring
description data.termsOfDelivery.descriptionstring
shipFrom data.shipFromobject
Required Shipment origin. addressId data.shipFrom.addressIdstring
addressee data.shipFrom.addresseestring
Required street1 data.shipFrom.street1string
Required street2 data.shipFrom.street2string
city data.shipFrom.citystring
Required state data.shipFrom.statestring
Required postalCode data.shipFrom.postalCodestring
Required country data.shipFrom.countrystring
Required Values: AU shipTo data.shipToobject
Required Shipment destination. 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 contacts data.contactsarray
Contact information for various roles role data.contacts[].rolestring
Values: shipFrom, shipTo, carrierCorporate, technicalSupport, customerService name data.contacts[].namestring
email data.contacts[].emailstring
phone data.contacts[].phonestring
comments data.commentsstring
Human-readable notes about this shipment reason data.reasonstring
Reason for shipment if not a standard delivery (e.g., return) Values: return lineItems data.lineItemsarray
Required Authoritative shipped line data. Packages reference these lines; they do not replace them. DataShift manages uniqueLineKey correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Line number from the purchase order being fulfilled. shipNoticeLineNumber data.lineItems[].shipNoticeLineNumberinteger
Sequence number of this line within the ship notice uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key from the original purchase order, used by internal connectors for cross-document correlation. supplierItemId data.lineItems[].supplierItemIdstring
Supplier's part or item number buyerItemId data.lineItems[].buyerItemIdstring
Buyer's part or item number gtin data.lineItems[].gtinstring
GS1 Global Trade Item Number description data.lineItems[].descriptionstring
Item description quantity data.lineItems[].quantitynumber
Quantity shipped on this line. unitOfMeasure data.lineItems[].unitOfMeasurestring
UN/ECE REC20 unit of measure code Values: AY, BG, BL, BR, BLL, E2 (+57 more) poNumber data.lineItems[].poNumberstring
Purchase order number this shipped line fulfils. countryOfOrigin data.lineItems[].countryOfOriginstring
Country where the item was manufactured Values: AU batchInfo data.lineItems[].batchInfoobject
Lot or batch tracking information batchId data.lineItems[].batchInfo.batchIdstring
productionDate data.lineItems[].batchInfo.productionDatestring
expirationDate data.lineItems[].batchInfo.expirationDatestring
serialNumbers data.lineItems[].serialNumbersarray
Serial numbers for individually serialised items packages data.packagesarray
Physical package or carton detail used for carton allocation and SSCC labelling. packageId data.packages[].packageIdstring
Supplier or warehouse package identifier unique within this shipment. sscc data.packages[].ssccstring
Serial Shipping Container Code for the carton or logistic unit. packagingCode data.packages[].packagingCodestring
Type of packaging (e.g., BOX, PAL, CTN) grossWeight data.packages[].grossWeightobject
Total weight of package including contents value data.packages[].grossWeight.valuenumber
unit data.packages[].grossWeight.unitstring
Values: KG, LB, OZ, G netWeight data.packages[].netWeightobject
Weight of contents only value data.packages[].netWeight.valuenumber
unit data.packages[].netWeight.unitstring
Values: KG, LB, OZ, G dimensions data.packages[].dimensionsobject
Physical dimensions of the package length data.packages[].dimensions.lengthnumber
width data.packages[].dimensions.widthnumber
height data.packages[].dimensions.heightnumber
unit data.packages[].dimensions.unitstring
Values: CM, IN, M, FT lineReferences data.packages[].lineReferencesarray
References to authoritative lineItems packed inside this package. lineNumber data.packages[].lineReferences[].lineNumberinteger
uniqueLineKey data.packages[].lineReferences[].uniqueLineKeystring
DataShift-managed line key from the original purchase order for internal connector correlation quantity data.packages[].lineReferences[].quantitynumber
Quantity of this line item packed in this carton unitOfMeasure data.packages[].lineReferences[].unitOfMeasurestring
Unit of measure for the quantity — must match the parent line item's unitOfMeasure Values: AY, BG, BL, BR, BLL, E2 (+57 more) hazardInfo data.hazardInfoarray
Hazardous materials information unNumber data.hazardInfo[].unNumberstring
hazardClass data.hazardInfo[].hazardClassstring
description data.hazardInfo[].descriptionstring
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/advance-shipping-notice.schema.json View Hide Schema
advance-shipping-notice.schema.json
docType docTypeconstant
Required Canonical document type. For advance shipping notices this value is ASN. correlationId correlationIdstring
Required Stable UUID used to trace this shipment notice through fulfilment and invoice workflows. timestamp timestampstring
Required UTC timestamp indicating when DataShift created the canonical shipment notice. 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 shipment notice. dispatchAdviceNumber data.dispatchAdviceNumberstring
Required Supplier-assigned shipment or dispatch advice identifier. poNumber data.poNumberstring
Required Primary purchase order number this shipment fulfils. operation data.operationstring
Whether this is a new shipment notice, an update, or a cancellation Values: new, update, delete noticeDate data.noticeDatestring
Required Date and time the supplier created the shipment notice. shipmentDate data.shipmentDatestring
Required Date and time the goods left the supplier. deliveryDate data.deliveryDatestring
Expected delivery date and time. requestedDeliveryDate data.requestedDeliveryDatestring
Buyer's originally requested delivery date shipmentType data.shipmentTypestring
Whether this is an actual shipment or a planned/estimated one Values: actual, planned fulfillmentType data.fulfillmentTypestring
Whether this shipment fulfils all or part of the referenced order. Values: partial, complete serviceLevel data.serviceLevelstring
Level of shipping service (e.g., overnight, ground, express) documentReference data.documentReferenceobject
Reference to previous ship notice (required for operation=update/delete) documentId data.documentReference.documentIdstring
payloadId data.documentReference.payloadIdstring
poReferences data.poReferencesarray
References to purchase orders being fulfilled by this shipment poNumber data.poReferences[].poNumberstring
poVersion data.poReferences[].poVersionstring
documentId data.poReferences[].documentIdstring
payloadId data.poReferences[].payloadIdstring
orderDate data.poReferences[].orderDatestring
carrier data.carrierobject
Required Carrier and service details for the shipment. name data.carrier.namestring
Required Carrier company name identifiers data.carrier.identifiersarray
Carrier identification codes domain data.carrier.identifiers[].domainstring
Domain/type of identifier Values: SCAC, IATA, AAR, UIC, EAN, DUNS (+1 more) value data.carrier.identifiers[].valuestring
serviceType data.carrier.serviceTypestring
Type of shipping service shipmentIdentifiers data.shipmentIdentifiersarray
Tracking numbers and shipment identifiers (consignment note, bill of lading, etc.) domain data.shipmentIdentifiers[].domainstring
Type of shipment identifier Values: trackingNumber, billOfLading, proNumber, airWaybill, containerNumber value data.shipmentIdentifiers[].valuestring
termsOfDelivery data.termsOfDeliveryobject
Delivery terms and conditions incoTerms data.termsOfDelivery.incoTermsstring
International Commercial Terms Values: cfr, cif, cip, cpt, daf, dap (+9 more) fobPoint data.termsOfDelivery.fobPointstring
description data.termsOfDelivery.descriptionstring
shipFrom data.shipFromobject
Required Shipment origin. addressId data.shipFrom.addressIdstring
addressee data.shipFrom.addresseestring
Required street1 data.shipFrom.street1string
Required street2 data.shipFrom.street2string
city data.shipFrom.citystring
Required state data.shipFrom.statestring
Required postalCode data.shipFrom.postalCodestring
Required country data.shipFrom.countrystring
Required Values: AU shipTo data.shipToobject
Required Shipment destination. 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 contacts data.contactsarray
Contact information for various roles role data.contacts[].rolestring
Values: shipFrom, shipTo, carrierCorporate, technicalSupport, customerService name data.contacts[].namestring
email data.contacts[].emailstring
phone data.contacts[].phonestring
comments data.commentsstring
Human-readable notes about this shipment reason data.reasonstring
Reason for shipment if not a standard delivery (e.g., return) Values: return lineItems data.lineItemsarray
Required Authoritative shipped line data. Packages reference these lines; they do not replace them. DataShift manages uniqueLineKey correlation where needed. lineNumber data.lineItems[].lineNumberinteger
Line number from the purchase order being fulfilled. shipNoticeLineNumber data.lineItems[].shipNoticeLineNumberinteger
Sequence number of this line within the ship notice uniqueLineKey data.lineItems[].uniqueLineKeystring
DataShift-managed stable line key from the original purchase order, used by internal connectors for cross-document correlation. supplierItemId data.lineItems[].supplierItemIdstring
Supplier's part or item number buyerItemId data.lineItems[].buyerItemIdstring
Buyer's part or item number gtin data.lineItems[].gtinstring
GS1 Global Trade Item Number description data.lineItems[].descriptionstring
Item description quantity data.lineItems[].quantitynumber
Quantity shipped on this line. unitOfMeasure data.lineItems[].unitOfMeasurestring
UN/ECE REC20 unit of measure code Values: AY, BG, BL, BR, BLL, E2 (+57 more) poNumber data.lineItems[].poNumberstring
Purchase order number this shipped line fulfils. countryOfOrigin data.lineItems[].countryOfOriginstring
Country where the item was manufactured Values: AU batchInfo data.lineItems[].batchInfoobject
Lot or batch tracking information batchId data.lineItems[].batchInfo.batchIdstring
productionDate data.lineItems[].batchInfo.productionDatestring
expirationDate data.lineItems[].batchInfo.expirationDatestring
serialNumbers data.lineItems[].serialNumbersarray
Serial numbers for individually serialised items packages data.packagesarray
Physical package or carton detail used for carton allocation and SSCC labelling. packageId data.packages[].packageIdstring
Supplier or warehouse package identifier unique within this shipment. sscc data.packages[].ssccstring
Serial Shipping Container Code for the carton or logistic unit. packagingCode data.packages[].packagingCodestring
Type of packaging (e.g., BOX, PAL, CTN) grossWeight data.packages[].grossWeightobject
Total weight of package including contents value data.packages[].grossWeight.valuenumber
unit data.packages[].grossWeight.unitstring
Values: KG, LB, OZ, G netWeight data.packages[].netWeightobject
Weight of contents only value data.packages[].netWeight.valuenumber
unit data.packages[].netWeight.unitstring
Values: KG, LB, OZ, G dimensions data.packages[].dimensionsobject
Physical dimensions of the package length data.packages[].dimensions.lengthnumber
width data.packages[].dimensions.widthnumber
height data.packages[].dimensions.heightnumber
unit data.packages[].dimensions.unitstring
Values: CM, IN, M, FT lineReferences data.packages[].lineReferencesarray
References to authoritative lineItems packed inside this package. lineNumber data.packages[].lineReferences[].lineNumberinteger
uniqueLineKey data.packages[].lineReferences[].uniqueLineKeystring
DataShift-managed line key from the original purchase order for internal connector correlation quantity data.packages[].lineReferences[].quantitynumber
Quantity of this line item packed in this carton unitOfMeasure data.packages[].lineReferences[].unitOfMeasurestring
Unit of measure for the quantity — must match the parent line item's unitOfMeasure Values: AY, BG, BL, BR, BLL, E2 (+57 more) hazardInfo data.hazardInfoarray
Hazardous materials information unNumber data.hazardInfo[].unNumberstring
hazardClass data.hazardInfo[].hazardClassstring
description data.hazardInfo[].descriptionstring
extrinsics data.extrinsicsobject
Partner-specific extension fields that are not part of the canonical core contract. 