POST
/
v1
/
returns
/
:id
/
exchange
curl --location --request POST 'https://api.stateset.com/v1/returns/:id/exchange' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
    "exchange_product_id": "prod_abc789",
    "exchange_variant_id": "var_size_large",
    "exchange_reason": "Wrong size ordered",
    "price_difference": 0,
    "shipping_method": "standard",
    "expedited": false
}'

{
  "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
  "object": "return",
  "exchanged": true,
  "exchange_order_id": "ord_exch_789xyz",
  "exchange_status": "processing",
  "original_product_id": "prod_xyz123",
  "exchange_product_id": "prod_abc789",
  "exchange_variant_id": "var_size_large",
  "price_difference": 0,
  "payment_status": "no_payment_required",
  "tracking_number": "1Z999AA10123456785",
  "estimated_delivery": "2024-01-18"
}

​
Body

​
return_id
string
The ID provided in the data tab may be used to identify the return
​
exchange_product_id
string
The product ID of the item to exchange for
​
exchange_variant_id
string
The variant ID if exchanging for a different variant (size, color, etc.)
​
exchange_reason
string
The reason for the exchange
​
price_difference
number
The price difference between original and exchange items (positive if customer owes, negative if refund due)
​
shipping_method
string
The shipping method for the exchange item
​
expedited
boolean
Whether to expedite the exchange shipment

​
Response

​
id
string
The ID provided in the data tab may be used to identify the return
​
object
string
The object type
​
exchange_order_id
string
The new order ID for the exchange
​
exchange_status
string
The status of the exchange (e.g., “pending”, “processing”, “shipped”)
​
original_product_id
string
The original product that was returned
​
exchange_product_id
string
The new product being sent as exchange
​
price_difference
number
The price difference between items
​
payment_status
string
Status of any additional payment or refund
​
tracking_number
string
Tracking number for the exchange shipment
​
success
number
Indicates whether the call was successful. true if successful, false if not.
curl --location --request POST 'https://api.stateset.com/v1/returns/:id/exchange' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
    "exchange_product_id": "prod_abc789",
    "exchange_variant_id": "var_size_large",
    "exchange_reason": "Wrong size ordered",
    "price_difference": 0,
    "shipping_method": "standard",
    "expedited": false
}'

{
  "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
  "object": "return",
  "exchanged": true,
  "exchange_order_id": "ord_exch_789xyz",
  "exchange_status": "processing",
  "original_product_id": "prod_xyz123",
  "exchange_product_id": "prod_abc789",
  "exchange_variant_id": "var_size_large",
  "price_difference": 0,
  "payment_status": "no_payment_required",
  "tracking_number": "1Z999AA10123456785",
  "estimated_delivery": "2024-01-18"
}