Cancel a vendor return

Cancel a vendor return

POST /api/v1/vendor-returns/{id}/cancel

cURL

curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.stateset.com/api/v1/vendor-returns/{id}/cancel' \
  --header 'Authorization: Bearer YOUR_API_KEY'

200

{
  "created_at": "2026-08-31T14:22:05Z",
  "credit_generated": true,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number": "ORD-10042",
  "status": "pending",
  "supplier_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "total_credit": "string"
}

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.

Path parameters

id · string · required

Vendor return ID

Request body

No request body.

Response

VendorReturnResponse

created_at · string · required

credit_generated · boolean · required

id · string · required

number · string · required

status · string · required

supplier_id · string · required

total_credit · string · required

Status codes

Code	Meaning
200	—
409	—

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

curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.stateset.com/api/v1/vendor-returns/{id}/cancel' \
  --header 'Authorization: Bearer YOUR_API_KEY'

200

{
  "created_at": "2026-08-31T14:22:05Z",
  "credit_generated": true,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number": "ORD-10042",
  "status": "pending",
  "supplier_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "total_credit": "string"
}