Shipment data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
Unique identifier for this shipment object
created_atdate
The date that this shipment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
The last date that this shipment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
order_idstring
Reference to commerce_order or accounting_order
from_addressobject
Origin address
to_addressobject
Destination address
packages array
Array of packages in this shipment
carrier_idstring
Reference to the carrier
service_codestring
Code for the shipping service used
status enum
Valid values:
"PENDING"
"PROCESSING"
"IN_TRANSIT"
"DELIVERED"
"EXCEPTION"
Current status of the shipment
rate_idstring
Optional reference to the selected rate (for traceability)
label_idstring
Optional reference to the shipping label
tracking_idstring
Optional reference to the tracking information
shipped_atdate
When shipment was createddispatched (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
rate_amountnumber
The rate amount used (may differ from shipping_cost due to adjustments)
rate_currencystring
Currency for rate_amount
rate_service_namestring
Service name from the rate (e.g., "Priority Mail")
rate_estimated_daysnumber
Estimated delivery days from the rate
rate_estimated_delivery_atdate
Estimated delivery date from the rate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_rate_guaranteedboolean
Whether delivery is guaranteed (from rate)
return_addressobject
Return address (may differ from from_address)
return_authorization_numberstring
RMA number if return shipment
warehouse_location_idstring
Origin warehouselocation ID; points to CommerceLocation
warehouse_location_namestring
Origin warehouse location name
customsobject
Customs information
is_internationalboolean
Whether shipment is international
insuranceobject
Insurance details
special_instructionsstring array
Array of special instructions
is_signature_requiredboolean
Signature required on delivery
is_adult_signature_requiredboolean
Adult signature required
reference_numberstring
Customer reference number
is_returnboolean
Whether this is a return shipment
original_shipment_idstring
Reference to original shipment if return; points to ShippingShipment
return_reasonstring
Reason for return
return_type enum
Valid values:
"CUSTOMER"
"VENDOR"
"WARRANTY"
"DEFECTIVE"
"OTHER"
Type of return
Are we missing anything? Let us know
Was this page helpful?