curl --silent --show-error --fail-with-body --request PATCH \
--url 'https://api.stateset.com/api/v1/returns/{id}' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"notes": "Two-person tent, green — replacement for damaged pole set.",
"refund_amount": "49.00",
"refund_method": "string",
"status": "pending",
"tracking_number": "1Z999AA10123456784",
"write_off_undispositioned": true
}'
{
"created_at": "2026-08-31T14:22:05Z",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reason": "Two-person tent, green — replacement for damaged pole set.",
"refund_amount": "49.00",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
Update a return
The general-purpose update: set the tracking number, the refund amount and method, notes, or drive the status machine…
PATCH
/
api
/
v1
/
returns
/
{id}
curl --silent --show-error --fail-with-body --request PATCH \
--url 'https://api.stateset.com/api/v1/returns/{id}' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"notes": "Two-person tent, green — replacement for damaged pole set.",
"refund_amount": "49.00",
"refund_method": "string",
"status": "pending",
"tracking_number": "1Z999AA10123456784",
"write_off_undispositioned": true
}'
{
"created_at": "2026-08-31T14:22:05Z",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reason": "Two-person tent, green — replacement for damaged pole set.",
"refund_amount": "49.00",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
completed here
settles the refund against the order’s captured payments in the same
transaction (unless refund_method settles out of band).
Path parameters
string
required
Return ID (UUID)
Request body
UpdateReturnRequest
string,null
string,null
Refund total. Non-negative and at most the sum of the line refunds.
string,null
original_payment (the default) settles through the payments ledger on completion; anything else (store credit, exchange, …) is recorded only.string,null
Target status:
requested, approved, rejected, in_transit, received, inspecting, completed or cancelled.string,null
boolean
Complete even though some received items have no disposition; the undispositioned units are written off.
Response
ReturnResponse
string (date-time)
required
string (uuid)
required
string (uuid)
required
string (uuid)
required
string
required
string,null
string
required
string (date-time)
required
Status codes
| Code | Meaning |
|---|---|
200 | Return updated |
400 | Invalid field or illegal status transition |
403 | Terminal return, or completion with undispositioned items |
404 | Return not found |
409 | Rejecting or cancelling after a disposition |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request PATCH \
--url 'https://api.stateset.com/api/v1/returns/{id}' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"notes": "Two-person tent, green — replacement for damaged pole set.",
"refund_amount": "49.00",
"refund_method": "string",
"status": "pending",
"tracking_number": "1Z999AA10123456784",
"write_off_undispositioned": true
}'
{
"created_at": "2026-08-31T14:22:05Z",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reason": "Two-person tent, green — replacement for damaged pole set.",
"refund_amount": "49.00",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
Last modified on October 20, 2026