The Internal Shipment Object

Outbound and inbound transfers have different response shapes — one for work leaving your warehouse, one for work arriving. Both are documented below.

Outbound transfer 🔗

Returned from /v1/outbound-transfers.json and related endpoints.

Field	Type	Notes
id	integer
number	string	User-facing transfer number
company_code	string
warehouse	object	Sending warehouse — {id, code, name}
planned_date	date, nullable
delivery_address	object	Receiving location — same shape as Address on customer shipments
create_date	datetime
write_date	datetime, nullable
carrier_code	string, nullable
service_code	string, nullable
reference	string, nullable	External reference
request_confirmation	boolean, nullable
shipping_instructions	string, nullable
lines	array	See Outbound line
metafields	array	Tenant-defined custom fields

Outbound line 🔗

Field	Type	Notes
id	integer	Move id
product	object	Same shape as Product
quantity	number
uom	string	Unit of measure symbol
customs_value	string, nullable	Cost basis in company currency; only set when origin and destination are in different countries
currency	string

Inbound transfer 🔗

Returned from /v1/inbound-transfers.json and related endpoints.

Field	Type	Notes
id	integer
number	string
company_code	string
warehouse	object	Receiving warehouse — {id, code, name}
planned_date	date, nullable
from_address	object	Sender warehouse address — same shape as Address
create_date	datetime
write_date	datetime, nullable
carrier_code	string, nullable
service_code	string, nullable
reference	string, nullable
shipping_instructions	string, nullable
packages	array	Package descriptors from the sender
lines	array	See Inbound line
metafields	array	Tenant-defined custom fields

Inbound line 🔗

Field	Type	Notes
id	integer	Move id
product	object	Same shape as Product
quantity	number
uom	string
lot	object, nullable	{number, expiry_date} for lot-tracked SKUs
outbound_allocations	array	Downstream customer moves reserved against this receipt