The Supplier Shipment Object
Every supplier-shipment response — list, count, acknowledge, receive — contains one or more objects of this shape.
Top-level fields 🔗
| Field | Type | Notes |
|---|---|---|
id |
integer | Internal shipment id |
number |
string | User-facing shipment number (e.g. SS-200456) |
company_code |
string | Legal entity code |
warehouse |
object | {id, code, name} |
reference |
string, nullable | External reference (often the PO reference) |
supplier |
object | {name, code} |
create_date |
datetime | ISO 8601 |
write_date |
datetime, nullable | ISO 8601, updated on any change |
planned_date |
date | Expected receipt date |
carrier_code |
string, nullable | Carrier method code |
service_code |
string, nullable | Carrier service code |
incoterm |
string, nullable | e.g. FOB, DAP |
transportation_mode |
string, nullable | e.g. truck, ocean, air |
packages |
array | Package descriptors from the sender |
purchase_orders |
array | See Purchase order |
lines |
array | See Line |
tracking_number |
object, nullable | See Tracking number |
metafields |
array | Tenant-defined custom fields |
Purchase order 🔗
Each item in purchase_orders[]. One entry per PO that contributed lines
to this shipment.
| Field | Type | Notes |
|---|---|---|
id |
integer | PO id |
number |
string | PO number |
reference |
string, nullable | External PO reference |
description |
string, nullable | |
purchase_date |
date | |
ship_from_address |
object | Supplier address — same shape as the Address fields on customer shipments |
Line 🔗
Each item in lines[].
| Field | Type | Notes |
|---|---|---|
id |
integer | Move id |
product |
object | Same shape as Product on customer shipments |
quantity |
number | Expected quantity |
unit |
string | Unit of measure symbol |
order_line |
object | {id, unit_price} — present when line originates from a PO |
order |
object | {id, number, reference, currency} — the PO |
outbound_allocations |
array | Downstream customer moves reserved against this receipt |
Tracking number 🔗
Freight-level tracking metadata. Populated for LTL/ocean/air modes.
| Field | Type | Notes |
|---|---|---|
tracking_number |
string, nullable | |
tracking_url |
string, nullable | |
carrier_identifier |
string, nullable | e.g. ups, fedex |
bill_of_lading |
string, nullable | BOL number |
load_number |
string, nullable | |
transportation_mode |
string, nullable | truck, ocean, air, rail |
air_waybill |
string, nullable | |
pro_number |
string, nullable | |
booking_number |
string, nullable | |
vessel_name |
string, nullable | |
vessel_code |
string, nullable | |
vessel_country |
string, nullable | ISO 2-letter |
voyage_number |
string, nullable | |
flight_number |
string, nullable | |
trailer_number |
string, nullable | |
container_number |
string, nullable | |
container_type |
string, nullable | |
port_of_origin |
string, nullable | |
port_of_loading |
string, nullable | |
port_of_entry |
string, nullable | |
airport_of_origin |
string, nullable | |
airport_of_entry |
string, nullable | |
border_crossing_port |
string, nullable | |
estimated_arrival |
datetime, nullable | |
estimated_pickup_date |
date, nullable | |
number_of_pallets |
integer, nullable | |
commercial_invoice_number |
string, nullable | |
customs_bond_type |
string, nullable | |
customs_bond_number |
string, nullable | |
isf_reference |
string, nullable | |
entry_type |
string, nullable | |
entry_number |
string, nullable | |
paps_number |
string, nullable | |
declared_freight_charges |
number, nullable |