| Name | Description |
|---|---|
| Root | The top level document. On input these fields are at the root; on output they are wrapped in a single "shipment" object. |
| Shipment | The single shipment. Fields marked output-only are computed by the adapter and appear only on the output form. |
| NativeReferenceNumber | A coded reference number. |
| Party | A party (ship-to or shipper). |
| Container | A container / equipment record. |
| PurchaseOrder | A purchase order. |
| PurchaseOrderLine | A line on a purchase order. |
| Charge | Commercial-invoice charge detail for a purchase order line. |
| Name | Data Type | Description | Required |
|---|---|---|---|
action_type | String | Purpose code. 00 = create, 05 = update, 03 = delete (logical 856 BSN purpose). | |
master_bill | String | Master bill of lading. | |
shipments | Array<Shipment> | The shipment loop. Exactly one element (the input is rejected when more than one is present). | YES |
shipper_reference | String | The shipment / shipper reference. |
| Name | Data Type | Description | Required |
|---|---|---|---|
arrival_port_estimated | String | Estimated arrival date in YYYYMMDD. | |
arrival_unlocode | String | Port of discharge (UN/LOCODE). | |
carrier_name | String | The carrier name. | |
carrier_scac | String | The carrier SCAC. | |
containerization_type | String | Output-only. Service type (e.g. CY/CY); on input derived from the first non-blank container delivery mode. | |
containers | Array<Container> | Container / equipment loop. | |
delivery_estimated | String | Estimated delivery date in YYYYMMDD. | |
departure_actual | String | Actual departure date in YYYYMMDD. | |
description_of_goods | String | Goods description. | |
final_port_unlocode | String | Final destination port (UN/LOCODE). | |
forwarder_controlling_branch_code | String | The forwarder branch. | |
gross_weight_kgs | Number | Output-only. Shipment gross weight in kilograms (sum of containers). | |
gross_weight_lbs | Number | Output-only. Computed gross weight in pounds. | |
house_bill | String | House bill of lading. | |
lading_unlocode | String | Port of lading (UN/LOCODE). | |
native_reference_number | Array<NativeReferenceNumber> | Reference-number loop. | |
number_of_packages | Number | Output-only. Total package count (sum of containers). | |
package_type_code | String | Package type code (e.g. CT = carton). | |
port_of_entry_code | String | Customs Schedule-D port. On output it is derived from "final_port_unlocode" when a mapping exists. | |
purchase_orders | Array<PurchaseOrder> | Output-only. A shipment-level copy of the purchase orders (also present under each container). | |
ship_to | Party | The consignee / ship-to party (logical 856 N1 ST). | |
shipper | Party | The shipper / vendor party (logical 856 N1 SF). | |
transport_mode | String | Mode of transport. S = SEA, A = AIR. | |
vessel_name | String | The vessel name. | |
volume_cbms | Number | Output-only. Shipment volume in cubic meters. | |
volume_cf | Number | Output-only. Computed volume in cubic feet. | |
voyage_number | String | The voyage / flight number. |
| Name | Data Type | Description | Required |
|---|---|---|---|
code | String | The reference qualifier / code. | |
data_source | String | The source system. | |
description | String | A human description of the reference. | |
value | String | The reference value. | |
value_context | String | Context / direction of the reference. |
| Name | Data Type | Description | Required |
|---|---|---|---|
address_code | String | The address code for the party. | |
code | String | The party code (remapped by the "org_code_mapping" configuration). | |
name | String | The party name. |
| Name | Data Type | Description | Required |
|---|---|---|---|
delivery_mode | String | Delivery / containerization mode. | |
equipment_initial | String | Owner prefix (4 characters). | |
equipment_number | String | Container serial number. | |
gross_volume_cbms | Number | Container volume in cubic meters. | |
gross_weight_kgs | Number | Container gross weight in kilograms. | |
number_of_packages | String | Package count. A STRING on input; the shipment-level aggregate is a number on output. | |
purchase_orders | Array<PurchaseOrder> | Purchase order loop under the container. | |
seal_number | String | The seal number. | |
type_code | String | ISO container type code. |
| Name | Data Type | Description | Required |
|---|---|---|---|
customer_order_number | String | The customer purchase order number. | |
purchase_order_lines | Array<PurchaseOrderLine> | Purchase order line loop. | |
shipper_mid_code | String | Manufacturer id; hoisted to the shipper party as its customs MID code. |
| Name | Data Type | Description | Required |
|---|---|---|---|
charge | Charge | Charge / commercial-invoice detail for the line. | |
country_of_origin | String | Country of origin. | |
customer_sku | String | The customer SKU. | |
gross_weight_kgs | Number | Line gross weight in kilograms. | |
hts_code | String | HTS / commodity code. | |
line_id | String | The PO line number. | |
quantity_fulfilled | Number | Quantity shipped. | |
quantity_requested | Number | Output-only. Quantity ordered. | |
sku_description | String | The item description. | |
unit_of_measure | String | Unit of measure. | |
volume_cbms | Number | Line volume in cubic meters. | |
zone_status | String | Input-only. FTZ zone status; parsed but not re-emitted on output. |
| Name | Data Type | Description | Required |
|---|---|---|---|
charge_code | String | Input-only. Accepted but not mapped. | |
currency | String | The currency. | |
invoice_date | String | The commercial invoice date in YYYYMMDD. | |
invoice_number | String | The commercial invoice number. Required on input: the input converter rejects a charge line without it (it is the grouping key for invoices). Optional on output: omitted when the related commercial invoice has no invoice number. | |
unit_price | Number | The unit price. |