Create or Update Return

Time	Status	User Agent
Retrieving recent requests…

warehouse

string

required

length ≥ 1

Code of the warehouse that will process this return.

rma

string

required

length ≥ 1

Return Merchandise Authorization (RMA) number; must be unique per return and is used as the upsert key.

order_key

string | null

Order key of the original outbound order this return relates to. Optional; supply to link the return to a known order.

store_id

integer

required

Identifier of the store this return belongs to.

return_reason

string

enum

required

Reason code for the return, used for reporting: exchange, changed_mind, undeliverable, unknown, or incorrect_product.

Allowed:

note

string | null

Optional free-text note attached to the return for internal reference.

tracking_number

string | null

Carrier tracking number of the parcel returning to the warehouse; optional, supply when known to enable inbound matching. Mutually exclusive with tracking_numbers.

tracking_numbers

array of strings

Carrier tracking numbers of the parcels returning to the warehouse; optional, supply when known to enable inbound matching. Mutually exclusive with tracking_number.

tracking_numbers

items

array of objects

required

items*

custom_data

array of objects

Free-form key/value metadata stored on the return; not interpreted by fulfillment logic and returned as-is in return reads.

custom_data

references_to_related_order

object

Optional lookup criteria used to associate this return with an existing order when order_key is unknown.

200Success