curl --silent --show-error --fail-with-body --request PATCH \
--url 'https://api.stateset.com/api/v1/returns/{id}/complete' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"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"
}
Complete a return
Settles the refund against the order’s captured payments in the same transaction as the status write…
PATCH
/
api
/
v1
/
returns
/
{id}
/
complete
curl --silent --show-error --fail-with-body --request PATCH \
--url 'https://api.stateset.com/api/v1/returns/{id}/complete' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"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.
write_off_undispositioned.
Path parameters
string
required
Return ID (UUID)
Request body
CompleteReturnRequest,null
boolean
Complete even though some received items have no disposition. Off by default so received goods cannot silently vanish.
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 completed and refund settled |
400 | Return cannot be completed from its current status |
403 | Items are still undispositioned |
404 | Return not found |
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}/complete' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"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