The Customer Return Shipment Object

Every customer-return-shipment response — list, 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. CR-300789)
company_code	string	Legal entity code
warehouse	object	Receiving warehouse — {id, code, name}
planned_date	date, nullable	Expected receipt date
customer	object	Same shape as Customer on customer shipments
origin_address	object	Where the return is shipping from (customer) — same shape as Address
delivery_address	object	Where the return is shipping to (warehouse return address, or falls back to the warehouse's regular address) — same shape as Address
create_date	datetime
write_date	datetime, nullable
carrier_code	string, nullable
service_code	string, nullable
tracking_number	object, nullable	See Tracking number
lines	array	See Line
shipping_instructions	string, nullable
channels	array	Sales channels the original order(s) came from — each {id, code, name}
related_orders	array	The sale orders being returned — each {id, number, reference, edi_attributes, shipping_start_date, shipping_end_date}
request_confirmation	boolean, nullable

Tracking number 🔗

Field	Type	Notes
id	integer
tracking_number	string, nullable
tracking_url	string, nullable
carrier_identifier	string, nullable
state	string, nullable	Current tracking state

Line 🔗

Each item in lines[].

Field	Type	Notes
id	integer	Move id
product	object	Same shape as Product
quantity	number	Expected return quantity
unit	string	Unit of measure symbol
return_reason	object, nullable	See Return reason
order	object	The sale order the return came from — same shape as Order on customer shipments
unit_price	number, nullable	Original sale unit price
unit_customs_value	number, nullable
currency	string, nullable	Original sale currency

Return reason 🔗

Field	Type	Notes
id	integer	Return reason id (used as return_reason on the receive payload)
name	string	Human-readable reason
description	string, nullable
return_type	string, nullable	e.g. refund, exchange