Skip to main content
Events/order

Order placement session started

Event Type: com.futureordering.order.place_order_session.started

Sent when a placement session is started for an order

Schema (Version 1)

tenantIdstringrequired
The tenant ID associated with the order.
orderIdstringrequired
The unique identifier of the order that was created.
versionIdstringrequired
The version identifier of the order.
storeIdstringrequired
The ID of the store on which the order was created.
transactionIdsstring[]required
An array of transaction IDs associated with the order.
Array items:
orderTypeIdstringrequired
The identifier for the type of order that was created.
salesChannelTypestringrequired
The type of sales channel through which the order was created.
collectionDetailTypestringrequired
The type of collection detail for the order, such as pickup or curbside.
userIdstringrequired
The ID of the user who created the order.

Example Event

{
  "specversion": "1.0",
  "data": {
    "tenantId": "my-tenant",
    "orderId": "D8aiVH8uEO8",
    "versionId": "9",
    "storeId": "22",
    "userId": "12345678-ffc4-4f3a-b5c7-9630ee0e7017",
    "transactionIds": [
      "uykgjbj4tzew7bit9mgkdkz97y-r9u6y4e"
    ],
    "orderTypeId": "eatIn",
    "salesChannelType": "browser",
    "collectionDetailType": "pickup"
  },
  "dataContentType": "application/json",
  "id": "c3db8281-5e03-4608-a597-8afb3c8d7bde",
  "source": "https://api.futureordering.com",
  "time": "2026-02-26T14:32:02.9140538+00:00",
  "type": "com.futureordering.order.place_order_session.started"
}
info

The event schema can be downloaded from the events index page.