Skip to main content
DELETE
/
v1
/
orders
/
:id
curl --location --request DELETE 'https://api.stateset.com/v1/orders/ord_123abc' \
--header 'Authorization: Token <token>'

{
  "id": "ord_123abc",
  "deleted": true,
  "archived": false,
  "related_records": {
    "payments": 0,
    "shipments": 0,
    "returns": 0,
    "refunds": 0
  },
  "deleted_at": "2024-01-15T14:30:00Z",
  "deleted_by": "user_123"
}

​
Path Parameters

​
id
string
required
The unique identifier of the order to delete

​
Query Parameters

​
force
boolean
Force deletion even if there are related records (requires admin permission)
​
archive_instead
boolean
Archive the order instead of deleting it (recommended for audit trail)

​
Response

​
id
string
The ID of the deleted order
​
deleted
boolean
Indicates whether the order was successfully deleted
​
archived
boolean
Indicates if the order was archived instead of deleted
​
related_records
object
Summary of related records affected
​
deleted_at
string
Timestamp when the order was deleted
​
deleted_by
string
User who deleted the order

​
Error Responses

​
error
object
Error object containing details about what went wrong
curl --location --request DELETE 'https://api.stateset.com/v1/orders/ord_123abc' \
--header 'Authorization: Token <token>'

{
  "id": "ord_123abc",
  "deleted": true,
  "archived": false,
  "related_records": {
    "payments": 0,
    "shipments": 0,
    "returns": 0,
    "refunds": 0
  },
  "deleted_at": "2024-01-15T14:30:00Z",
  "deleted_by": "user_123"
}