Sign in

v3

latestOpenAPI 3.1.02026-08-0619186200.1 KB
Returns

Create or Update Return

post/v1/integrations/returns

Request body

warehousestring required

Code of the warehouse that will process this return.

rmastring required

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

order_keystring nullable

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

store_idinteger required

Identifier of the store this return belongs to.

return_reason'reason_exchange' | 'reason_changed_mind' | 'reason_undeliverable' | 'reason_unknown' | 'reason_incorrect_product' required
notestring nullable

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

tracking_numberstring nullable

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

tracking_numbersstring[]

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

Example request

{
  "warehouse": "PA1",
  "order_key": "327b5abd-017a-4504-a50d-54f1cea80269",
  "store_id": 123456,
  "references_to_related_order": {
    "order_number": "Order-123"
  }
}

Response

Success

statusinteger required