Skip to main content
POST
/
api
/
goods_outs
/
{id}
/
cancel
Cancel a goods out order
curl --request POST \
  --url https://clarus-api.com/api/goods_outs/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Clarus-Subdomain: <api-key>'
{
  "data": {
    "id": 123,
    "type": "<string>",
    "attributes": {}
  }
}

​
Cancellation Behavior

Order StatusResult
Draft/PendingOrder deleted
AllocatedStock deallocated, order cancelled
PickingOutstanding picks cancelled, stock deallocated
CompletedCannot cancel - already dispatched
Note: No request body required. The order ID in the path is sufficient.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
id
integer
required

The unique identifier of the goods out order to cancel

Response

Goods out cancelled successfully

Standard successful response wrapper following JSON:API format

​
data
object

The response payload