Skip to content
ajar.Book a demo

Orders cancel

amazon.orders.cancel

View connector

Cancel every eligible item in an Amazon order

POST /v1/operations/amazon.orders.cancel

Headers

Authorization: Bearer YOUR_AJAR_API_KEY
x-amazon-token: YOUR_AMAZON_TOKEN
x-idempotency-key: YOUR_UNIQUE_ATTEMPT_KEY
Content-Type: application/json

x-idempotency-key identifies one intended action. Generate a unique value, such as crypto.randomUUID(), before sending it. Use 1–128 letters, numbers, hyphens, underscores or periods. A duplicate attempt is rejected; it does not return a cached success. If a request times out, check the provider’s state before starting a new attempt with a new key. See the idempotency guide.

Inputs

ParameterExample typeExample value
order_idstring"000-0000000-0000000"
expected_item_countnumber1
confirm_cancelbooleantrue

Example input

{
  "order_id": "000-0000000-0000000",
  "expected_item_count": 1,
  "confirm_cancel": true
}
Open JSON schema

Input schema

{
  "$id": "https://useajar.com/schemas/amazon/orders-cancel.input.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "confirm_cancel": {
      "const": true
    },
    "expected_item_count": {
      "maximum": 100,
      "minimum": 1,
      "type": "integer"
    },
    "order_id": {
      "pattern": "^[0-9-]{10,40}$",
      "type": "string"
    }
  },
  "required": [
    "order_id",
    "expected_item_count",
    "confirm_cancel"
  ],
  "title": "Amazon orders-cancel input",
  "type": "object"
}