Advance Shipping Notice EDI Schema
Supplier shipment notice describing dispatched goods. Follows PO acknowledgement and precedes receipt, giving the buyer shipment detail before goods arrive.
ASN · AdvanceShippingNotice
Supplier shipment notice describing dispatched goods.
An Advance Shipping Notice describes goods that have been dispatched or are planned for dispatch. It separates authoritative shipped lines from carton allocation details so receiving, fulfilment, and invoice reconciliation can reason about what moved and how it was packed.
View releases · View model · View example · View guides · Versioning policy · Error catalogue
Lifecycle And Correlation
Lifecycle Position
Follows PO acknowledgement and precedes receipt, giving the buyer shipment detail before goods arrive.
Correlation Guidance
Use data.lineItems[] as the authoritative shipped line list. Packages should reference those lines through data.packages[].lineReferences[] using uniqueLineKey for automatic correlation; package line references do not replace shipped line data.
Validation Notes
- Require dispatchAdviceNumber, noticeDate, shipmentDate, carrier, shipFrom, shipTo, and lineItems.
- Validate package SSCC values when supplied.
- Require each package line reference to include quantity and uniqueLineKey for automatic line correlation.
- Keep unitOfMeasure aligned between lineItems and package lineReferences.
Mapping Notes
- Map shipped quantities to data.lineItems[] first, then map carton allocation to packages[].lineReferences[].
- Preserve PO uniqueLineKey values on shipped lines and package line references.
- Use shipmentIdentifiers for tracking and transport references instead of comments.
- Map SCAC and other carrier codes to carrier.identifiers[] rather than overloading carrier name or shipment comments.
- Represent partial and complete fulfilment through fulfillmentType.
Operational Notes
- Receiving progress should be calculated from data.lineItems[], not package allocation rows.
- If uniqueLineKey is missing or unknown, send the shipment line to manual review rather than matching on item text or array position.
Implementation Pitfalls
- Do not use package item arrays as authoritative ASN line data.
- Do not treat packageId as an SSCC; map SSCC values to data.packages[].sscc.
- Do not infer line fulfilment from carton count alone.
- Do not match ASN lines to PO lines by lineNumber, array index, item id, description, or quantity.
Key Fields
data.dispatchAdviceNumber: Supplier shipment notice identifier.data.lineItems[]: Authoritative ASN line data.data.packages[].lineReferences[]: Optional carton allocation detail.
Field Groups
Envelope
Identifies the shipment notice and traces it through fulfilment and invoice workflows.
docType: Always ASN for advance shipping notice payloads.correlationId: Stable UUID used to trace the shipment notice through downstream workflows.timestamp: UTC timestamp for when the canonical shipment notice was created.
Shipment Header
Captures shipment identity, operation, timing, fulfilment type, and purchase order references.
data.dispatchAdviceNumber: Supplier shipment or dispatch advice identifier.data.noticeDate: Date and time the supplier created the notice.data.shipmentDate: Date and time goods left the supplier.data.poReferences[]: Purchase orders being fulfilled by this shipment.
Carrier And Parties
Describes the carrier, tracking identifiers, origin, destination, and delivery terms.
data.carrier: Carrier and service details for the shipment.data.shipmentIdentifiers[]: Tracking, bill of lading, pro, airwaybill, or container references.data.shipFrom: Shipment origin.data.shipTo: Shipment destination.
Lines And Packages
Separates shipped line facts from physical carton and SSCC allocation detail.
data.lineItems[]: Authoritative shipped line data.data.lineItems[].uniqueLineKey: Stable line key copied from the original PO.data.packages[]: Physical package or carton detail.data.packages[].lineReferences[]: Quantities packed in each carton by line reference.
Endpoints
The current JSON Schema is served at /edi/schemas/v1/advance-shipping-notice. Every published version, with its immutable download path, is on the releases page.
/edi/schemas/v1/advance-shipping-noticeModel
Generated from the published advance-shipping-notice.schema.json (version 1.0.8). Fields marked managed are populated by DataShift.
$
Prop
Type
$.metadata
Prop
Type
$.data
Prop
Type
$.data.documentReference
Prop
Type
$.data.poReferences[]
Prop
Type
$.data.carrier
Prop
Type
$.data.carrier.identifiers[]
Prop
Type
$.data.shipmentIdentifiers[]
Prop
Type
$.data.termsOfDelivery
Prop
Type
$.data.shipFrom
Prop
Type
$.data.shipTo
Prop
Type
$.data.contacts[]
Prop
Type
$.data.lineItems[]
Prop
Type
$.data.lineItems[].batchInfo
Prop
Type
$.data.packages[]
Prop
Type
$.data.packages[].grossWeight
Prop
Type
$.data.packages[].netWeight
Prop
Type
$.data.packages[].dimensions
Prop
Type
$.data.packages[].lineReferences[]
Prop
Type
$.data.hazardInfo[]
Prop
Type
Last updated on
Purchase Order Acknowledgement EDI Schema
Supplier confirmation or change response for a purchase order. Follows PO receipt and precedes shipment, giving the buyer an explicit supplier response.
Invoice EDI Schema
Supplier billing document for ordered or shipped goods. Follows fulfilment and supports financial reconciliation, payment approval, and exception handling.