ASN1.0.6

Advance Shipping Notice Example

Approved canonical example from the published Advance Shipping Notice JSON Schema. Use Preview to see schema fields alongside example values, or Code for the canonical JSON payload.

Field	Required	Description	Example value
`docType`	Yes	Canonical document type. For advance shipping notices this value is ASN.	`ASN`
`correlationId`	Yes	Stable UUID used to trace this shipment notice through fulfilment and invoice workflows.	`cab103da-1713-4976-80c4-f1b47f62b523`
`timestamp`	Yes	UTC timestamp indicating when DataShift created the canonical shipment notice.	`2026-05-16T02:00:00Z`
`metadata.sourceLanguage`	Yes		`cxml`
`metadata.sourceVersion`	Yes	Canonical schema version used to create this document	`1.0.6`
`metadata.payloadId`	No	Original cXML payload ID	`asn-example-10001`
`metadata.userAgent`	Yes	DataShift Edge version that generated the canonical document	`DataShift Edge v1`
`data.dispatchAdviceNumber`	Yes	Supplier-assigned shipment or dispatch advice identifier.	`ASN-10001`
`data.poNumber`	Yes	Primary purchase order number this shipment fulfils.	`PO-10001`
`data.operation`	No	Whether this is a new shipment notice, an update, or a cancellation	`-`
`data.noticeDate`	Yes	Date and time the supplier created the shipment notice.	`2026-05-16T02:00:00Z`
`data.shipmentDate`	Yes	Date and time the goods left the supplier.	`2026-05-16T03:00:00Z`
`data.deliveryDate`	No	Expected delivery date and time.	`2026-05-23T00:00:00Z`
`data.requestedDeliveryDate`	No	Buyer's originally requested delivery date	`-`
`data.shipmentType`	No	Whether this is an actual shipment or a planned/estimated one	`-`
`data.fulfillmentType`	No	Whether this shipment fulfils all or part of the referenced order.	`partial`
`data.serviceLevel`	No	Level of shipping service (e.g., overnight, ground, express)	`-`
`data.documentReference.documentId`	No		`-`
`data.documentReference.payloadId`	No		`-`
`data.poReferences[].poNumber`	Yes		`-`
`data.poReferences[].poVersion`	No		`-`
`data.poReferences[].documentId`	No		`-`
`data.poReferences[].payloadId`	No		`-`
`data.poReferences[].orderDate`	No		`-`
`data.carrier.name`	Yes	Carrier company name	`Example Freight`
`data.carrier.identifiers[].domain`	Yes	Domain/type of identifier	`-`
`data.carrier.identifiers[].value`	Yes		`-`
`data.carrier.serviceType`	No	Type of shipping service	`Road`
`data.shipmentIdentifiers[].domain`	Yes	Type of shipment identifier	`-`
`data.shipmentIdentifiers[].value`	Yes		`-`
`data.termsOfDelivery.incoTerms`	No	International Commercial Terms	`-`
`data.termsOfDelivery.fobPoint`	No		`-`
`data.termsOfDelivery.description`	No		`-`
`data.shipFrom.addressId`	No		`-`
`data.shipFrom.addressee`	No		`Example Supplier Warehouse`
`data.shipFrom.street1`	Yes		`20 Supplier Street`
`data.shipFrom.street2`	No		`-`
`data.shipFrom.city`	Yes		`Adelaide`
`data.shipFrom.state`	Yes		`SA`
`data.shipFrom.postalCode`	Yes		`5000`
`data.shipFrom.country`	Yes		`AU`
`data.shipTo.addressId`	No		`-`
`data.shipTo.addressee`	No		`Example Distribution Centre`
`data.shipTo.street1`	Yes		`10 Warehouse Road`
`data.shipTo.street2`	No		`-`
`data.shipTo.city`	Yes		`Melbourne`
`data.shipTo.state`	Yes		`VIC`
`data.shipTo.postalCode`	Yes		`3000`
`data.shipTo.country`	Yes		`AU`
`data.contacts[].role`	Yes		`-`
`data.contacts[].name`	No		`-`
`data.contacts[].email`	No		`-`
`data.contacts[].phone`	No		`-`
`data.comments`	No	Human-readable notes about this shipment	`-`
`data.reason`	No	Reason for shipment if not a standard delivery (e.g., return)	`-`
`data.lineItems[].lineNumber`	No	Line number from the purchase order being fulfilled.	`1`
`data.lineItems[].shipNoticeLineNumber`	No	Sequence number of this line within the ship notice	`-`
`data.lineItems[].uniqueLineKey`	No	DataShift-managed stable line key from the original purchase order, used by internal connectors for cross-document correlation.	`PO-10001-1`
`data.lineItems[].supplierItemId`	No	Supplier's part or item number	`SUP-001`
`data.lineItems[].buyerItemId`	No	Buyer's part or item number	`BUY-001`
`data.lineItems[].gtin`	No	GS1 Global Trade Item Number	`-`
`data.lineItems[].description`	No	Item description	`-`
`data.lineItems[].quantity`	Yes	Quantity shipped on this line.	`6`
`data.lineItems[].unitOfMeasure`	No	UN/ECE REC20 unit of measure code	`EA`
`data.lineItems[].countryOfOrigin`	No	Country where the item was manufactured	`-`
`data.lineItems[].batchInfo.batchId`	No		`-`
`data.lineItems[].batchInfo.productionDate`	No		`-`
`data.lineItems[].batchInfo.expirationDate`	No		`-`
`data.lineItems[].serialNumbers`	No	Serial numbers for individually serialised items	`-`
`data.packages[].packageId`	Yes	Supplier or warehouse package identifier unique within this shipment.	`CARTON-1`
`data.packages[].sscc`	No	Serial Shipping Container Code for the carton or logistic unit.	`193123456789012345`
`data.packages[].packagingCode`	No	Type of packaging (e.g., BOX, PAL, CTN)	`-`
`data.packages[].grossWeight.value`	No		`-`
`data.packages[].grossWeight.unit`	No		`-`
`data.packages[].netWeight.value`	No		`-`
`data.packages[].netWeight.unit`	No		`-`
`data.packages[].dimensions.length`	No		`-`
`data.packages[].dimensions.width`	No		`-`
`data.packages[].dimensions.height`	No		`-`
`data.packages[].dimensions.unit`	No		`-`
`data.packages[].lineReferences[].lineNumber`	No		`-`
`data.packages[].lineReferences[].uniqueLineKey`	No	DataShift-managed line key from the original purchase order for internal connector correlation	`PO-10001-1`
`data.packages[].lineReferences[].quantity`	Yes	Quantity of this line item packed in this carton	`6`
`data.packages[].lineReferences[].unitOfMeasure`	No	Unit of measure for the quantity — must match the parent line item's unitOfMeasure	`EA`
`data.hazardInfo[].unNumber`	No		`-`
`data.hazardInfo[].hazardClass`	No		`-`
`data.hazardInfo[].description`	No		`-`
`data.extrinsics`	No	Partner-specific extension fields that are not part of the canonical core contract.	`{"warehouseWave":"WAVE-42"}`