Order Canceled

EVENT_ORDER_CANCELED is sent when an order is canceled.

When it fires

Fires on an order CDC update when the order status changes to internal cancelled. The delivery body copies the internal order ID, vendor reference, and status.

Example payload

V3

{
  "type": "order_cancelled",
  "order": {
    "gearment_id": "260909P-DEMO01-2D8N6R4W",
    "gearment_name": "260909P-DEMO01-2D8N6R4W",
    "vendor_id": "ETSY-782144",
    "status": "cancelled"
  }
}

V1

{
  "api_key": "ck_demo_8f2c",
  "type": "order_canceled",
  "data": {
    "api_key": "ck_demo_8f2c",
    "gearment_ord_id": "109876544",
    "gearment_ord_name": "260909P-DEMO01-2D8N6R4W",
    "ord_status": "canceled",
    "order_id": "ETSY-782144"
  }
}

Fields

Version	Field	Type	Presence	Description
V1	`api_key`	string	A	Default credential client key
V1	`type`	string	A	Literal "order_canceled"
V1	`data`	object	A	Legacy payload container
V1	`data.api_key`	string	A	Duplicate default credential client key
V1	`data.gearment_ord_id`	string	A	Legacy numeric ID as a string when mapped; otherwise internal ID
V1	`data.gearment_ord_name`	string	A	Internal Gearment order ID
V1	`data.ord_status`	string	A	Literal "canceled"
V1	`data.order_id`	string	A/empty	Order vendor reference
V3	`type`	string	A	Literal "order_cancelled"
V3	`order`	object	A	Order identity and state
V3	`order.gearment_id`	string	A	Internal Gearment order ID
V3	`order.gearment_name`	string	A	Same internal ID copied into the name field
V3	`order.vendor_id`	string	A/empty	Order vendor reference
V3	`order.status`	string	A	Internal status, "cancelled" on this event

Presence: A is always emitted; A/empty is always emitted but the value can be ""; Per item is emitted for every array element.

Verify the signature before parsing the body. See Verifying a payload.

Payload handling

Confirm the exact topic and payload version with the Webhook simulator. Preserve unknown fields, process the event idempotently, and do not depend on JSON property ordering.