| Name | Description |
|---|---|
| Root | The top level document. Its "doc_type" matches the canonical Shipment format; its "version" is always "1.0". |
| Shipment | A single shipment. |
| PurchaseOrder | A purchase order within the shipment. In the EDI form the package groups are nested under the PO (the canonical Shipment carries them at shipment level). |
| PackageGroup | A package (carton/pallet) within a purchase order. |
| PackItem | A single item within a package. |
| Name | Data Type | Description | Required |
|---|---|---|---|
doc_type | String | Always shipment_json (the same value the canonical Shipment format uses) | |
shipments | Array<Shipment> | Array of Shipment objects (one per file when "output_one_doc_per_shipment" is set). | YES |
version | String | Always 1.0 |
| Name | Data Type | Description | Required |
|---|---|---|---|
departure_estimated | DateTime | Estimated departure date. | |
destination_warehouse | String | Destination warehouse identifier (the ship-to party). | |
must_deliver_by_date | DateTime | The must-deliver-by date. | |
number_of_packages | Integer | Total package count for the shipment. | |
purchase_orders | Array<PurchaseOrder> | Purchase order loop. Each PO is split one-per-store, so the same PO number can appear multiple times with different "store_number" values. | |
source_system_uid | String | The shipment identifier from the system of record (the same field as canonical Shipment). | |
transaction_type_code | String | Present only when the adapter is configured to hardcode a transaction type code (the transaction purpose). | |
transmission_uid | String | A unique id generated per transmission. | |
volume_cbms | Decimal | Shipment volume in cubic meters. |
| Name | Data Type | Description | Required |
|---|---|---|---|
customer_order_number | String | The purchase order number. | |
latest_delivery_date | DateTime | The latest delivery date (present only when supplied). | |
order_date | DateTime | The order date. | |
package_group | Array<PackageGroup> | The package groups for this PO/store. | |
quantity_requested | Integer | Repurposed in the EDI form to the count of package groups in this store (NOT the ordered quantity). | |
store_number | String | The mark-for store number. EDI-specific: the PO is cloned per distinct store number. |
| Name | Data Type | Description | Required |
|---|---|---|---|
pack_items | Array<PackItem> | The items packed in this package. | |
package_number | String | The package / SSCC-18 number. | |
package_type_code | String | The package type code (present only when supplied). |