Skip to content

OrderCancelledEvent ​

Type: schema

Description ​

Emitted when an order transitions to cancelled. A cancel that does not change the status emits nothing.

TypeScript Definition ​

typescript
OrderCancelledEvent: {{
            /**
             * @description discriminator enum property added by openapi-typescript
             * @enum {string}
             */
            event: "Order Cancelled";
            /** @description Server-issued event id (ULID). Send it with your client-side copy of this event so both copies dedupe. */
            event_id: string;
            /** @description The `Order` that was cancelled. */
            order_number: string;
        };
        /**
         * OrderCreatedEvent
         * @description Emitted when an order is placed, on every channel including POS.
         */
}

OpenAPI Schema ​

json
{
  "title": "OrderCancelledEvent",
  "description": "Emitted when an order transitions to `cancelled`. A cancel that does not change the status emits nothing.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/OrderCancelledEvent",
    "description": "API reference for the OrderCancelledEvent schema"
  },
  "required": [
    "event",
    "event_id",
    "order_number"
  ],
  "properties": {
    "event": {
      "type": "string",
      "const": "Order Cancelled"
    },
    "event_id": {
      "description": "Server-issued event id (ULID). Send it with your client-side copy of this event so both copies dedupe.",
      "type": "string",
      "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$"
    },
    "order_number": {
      "description": "The `Order` that was cancelled.",
      "type": "string"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: