Skip to main content
POST
Cancel shipment

Authorizations

x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer. The key must have the BITCRM product scope and an orders resource scope; required action depends on the endpoint (READ, WRITE, or DELETE).

Path Parameters

id
string
required

Body

application/json
reason
string

Human-readable cancellation reason (max 500 chars).

Maximum string length: 500

Response

Cancelled.

data
object