Skip to main content
POST
Cancel an order - v3

Authorizations

X-Api-Key
string
header
required

Company Level Authentication

Include your API key in the X-Api-Key header for every request:

Headers

snappy-account-id
string

Optional account identifier for swag validation/filtering.

Example:

"acc123456"

snappy-company-id
string

Optional company identifier for swag validation/filtering.

Example:

"cmp123456"

Path Parameters

orderId
string
required

The unique identifier of the order to cancel. Obtained from POST /v3/orders or GET /v3/orders.

Pattern: ^[A-Za-z0-9]{8,}$
Example:

"G7nR4bD9mK"

Response

Cancelled order.

JSON:API single-resource envelope for an order.

data
object
required

Order details including line items, recipient, shipping address, fulfillments, and tracking information.

Last modified on June 17, 2026