The Customer Shipment Object

Every customer-shipment response — list, count, acknowledge, ship — 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. CS-100123)
company_code	string	Legal entity code
warehouse	object	See Warehouse
priority	string	"0" (highest) — "4" (lowest)
planned_date	date, nullable	Expected ship date
requested_delivery_date	date, nullable	Customer's requested delivery date
create_date	datetime	ISO 8601
write_date	datetime, nullable	ISO 8601, updated on any change
customer	object, nullable	See Customer
delivery_address	object, nullable	See Address
carrier_code	string, nullable	Carrier method code (e.g. ups, fedex)
service_code	string, nullable	Carrier service code (e.g. ground)
requested_shipping_service	string, nullable	Customer's requested service
shipping_instructions	string, nullable	Free-form picker/packer notes
gift_message	string, nullable	Gift message
incoterm	string, nullable	e.g. DAP, DDP
insurance_amount	number, nullable	Declared insurance value
request_confirmation	string, nullable	service_default, delivery, signature, etc.
importer_of_record_tax_identifiers	array	Tax IDs for customs. Each: {type, value}
lines	array	See Line
channels	array	Sales channels involved. Each: {id, code, name}
related_orders	array	See Related order
cross_dock_locations	array	See Cross-dock location
metafields	array	Tenant-defined custom fields exposed to the 3PL

Warehouse 🔗

Field	Type	Notes
id	integer	Internal warehouse id
code	string	Warehouse code
name	string	Display name

Customer 🔗

Field	Type	Notes
name	string	Customer name
phone	string, nullable
email	string, nullable
code	string, nullable	Customer code
billing_accounts	array	Third-party billing accounts

Billing account fields

Field	Type	Notes
account_number	string, nullable	Carrier account number
bill_to	string, nullable	third_party, recipient, etc.
carrier_identifier	string, nullable	e.g. ups, fedex, dhl_express
country	string, nullable	ISO 2-letter country code
zip	string, nullable	Postal code

Address 🔗

Used for delivery_address, cross-dock locations, and other address slots.

Field	Type	Notes
name	string, nullable	Recipient name
address1	string, nullable	Street
address2	string, nullable	Street, secondary
business_name	string, nullable
city	string, nullable
zip	string, nullable
country_code	string, nullable	ISO 2-letter
subdivision_code	string, nullable	State/province code
phone	string, nullable
email	string, nullable
edi_location_number	string, nullable
dock	string, nullable
code	string, nullable	Address code

Line 🔗

Each item in lines[].

Field	Type	Notes
id	integer	Move id (used in the ship endpoint's lines[].id)
product	object	See Product
quantity	number	Ordered quantity
uom	string	Unit of measure symbol (e.g. u)
lot	object, nullable	{id, number, expiry_date}
serial_numbers	array	Each: {id, serial_number}
options	array	Line-level customizations. See Option
sublines	array	Bundle-component moves (same shape as Line, without recursion)
order	object	See Order — present when line originates from a sale order
order_line	object	See Order line — present when line originates from a sale order
unit_price	number, nullable	Sale unit price
unit_customs_value	number, nullable	Per-unit customs value
unit_customs_value_in_company_currency	number, nullable	Same, in company currency
currency	string, nullable	Sale currency code
company_currency	string, nullable	Company currency code

Product 🔗

Field	Type	Notes
id	integer	Product id
code	string	SKU
upc	string, nullable
name	string	Variant name
buyer_sku	string, nullable	Customer-specific SKU
codes	array	All product codes: {type, value} (e.g. 3pl_sku, buyer_sku, upc)
metafields	array	Tenant-defined custom fields

Option 🔗

Line-level customizations (personalization, engraving, add-on products).

Field	Type	Notes
id	integer	Option instance id
option	object	{id, name, code, type} — type is one of string, text, product, integer, float, numeric, selection, date
value	string	Option value
quantity	number	Present only when option.type == "product"

Order 🔗

Present on lines[].order when the line comes from a sale order.

Field	Type	Notes
id	integer
number	string	Order number
sale_date	date, nullable
reference	string, nullable	External reference
channel	object	{id, code, name}
channel_segment	string, nullable

Order line 🔗

Present on lines[].order_line when the line comes from a sale order.

Field	Type	Notes
id	integer
cross_dock_location	object, nullable	Address if the line has a cross-dock override
edi_attributes	object, nullable	Trading-partner EDI data
listing_sku	string, nullable	Channel-listing SKU

Related order 🔗

Each item in related_orders[]. One entry per unique sale order across all lines.

Field	Type	Notes
id	integer
number	string
reference	string, nullable
dropship_order_reference	string, nullable
edi_attributes	object, nullable
trading_partner	object, nullable	{id, identifier, contact: {id, name, code}}
shipping_start_date	date, nullable	Fulfillment window start
shipping_end_date	date, nullable	Fulfillment window end
invoice_address	object	See Address

Cross-dock location 🔗

Each item in cross_dock_locations[]. Aggregates lines that share the same cross-dock destination.

Field	Type	Notes
address	object	See Address
items	array of integer	Move ids from lines[].id