OrderCreatedEvent
Type: schema
Description
Emitted when an order is placed, on every channel including POS.
TypeScript Definition
typescript
OrderCreatedEvent: {{
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
event: "Order Created";
/** @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 created. */
order_number: string;
/** @description The cart the order was created from, or `null` when it did not originate from a cart. */
cart_id: string | null;
};
/** OrderDetail */
}OpenAPI Schema
json
{
"description": "Emitted when an order is placed, on every channel including POS.",
"type": "object",
"properties": {
"event": {
"type": "string",
"const": "Order Created"
},
"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 created.",
"type": "string"
},
"cart_id": {
"description": "The cart the order was created from, or `null` when it did not originate from a cart.",
"type": [
"string",
"null"
]
}
},
"externalDocs": {
"url": "https://llm-docs.commercengine.io/storefront/schemas/OrderCreatedEvent",
"description": "API reference for the OrderCreatedEvent schema"
},
"required": [
"event",
"event_id",
"order_number",
"cart_id"
],
"title": "OrderCreatedEvent"
}Auto-generated from OpenAPI spec and TypeScript definitions