Order Started
Event Key
ootb_order_started
This event should be sent when a user starts the order process—usually at the first step of the checkout or payment screen—before they complete or confirm the purchase.
| Event Key | Event Name | Type |
|---|---|---|
ootb_order_started | Order Started | Simple event |
Event Structure
The mandatory properties (tenant, timestamp, event, and customer) are required for all events and documented in detail on the Mandatory Properties page. Below is the JSON structure for the context-specific properties of the Order Started event:
{
"context": {
"ootb_session_id": "248rhdbuw2her1",
"ootb_userid": "ExampleUser1234",
"ootb_email": "[email protected]",
"ootb_eventdatetime": "2025-04-07T17:00:00Z",
"ootb_cart_id": "C-START102838",
"ootb_currency": "USD",
"ootb_item_count": 3,
"ootb_total_cart_value": 124.99,
"ootb_discount_code": "SPRING10",
"ootb_discount_value": 20.00,
"ootb_referral_source": "email",
"ootb_is_guest_checkout": true,
"ootb_language": "en",
"ootb_country": "US"
}
}Parameters
| Parameter Key | Parameter Name | Type | Description |
|---|---|---|---|
ootb_session_id | Session ID | String | User’s browser session identifier. |
ootb_userid | User ID | String | Unique key identifying the user. |
ootb_email | String | Customer’s email (if available at this stage). | |
ootb_eventdatetime | Event Date Time | Timestamp | Time when the order process was initiated. |
ootb_cart_id | Cart ID | String | Unique cart identifier. |
ootb_currency | Currency | String | Currency used for the cart (e.g., USD). |
ootb_item_count | Item Count | Number | Number of items in the cart. |
ootb_total_cart_value | Total Cart Value | Number | Total value of all items in the cart. |
ootb_discount_code | Discount Code | String | Promo code applied (if any). |
ootb_discount_value | Discount Value | Number | Value of the discount applied. |
ootb_referral_source | Referral Source | String | Channel/source that brought user to checkout. |
ootb_is_guest_checkout | Guest Checkout | Boolean | true if the user is checking out as a guest; false otherwise. |
ootb_language | Language | String | Language of the checkout/session. |
ootb_country | Country | String | Country from which the order is started. |
Explanation
- event: Set to
ootb_order_startedto indicate the user has begun the checkout or order process. - context:
ootb_session_id,ootb_userid,ootb_email: Link the event to the user’s session, identity, and email.ootb_eventdatetime: When the order process was initiated.ootb_cart_id,ootb_currency,ootb_item_count,ootb_total_cart_value: Core cart identifiers and totals at the start of checkout.ootb_discount_code,ootb_discount_value: Any promotional code applied and its value.ootb_referral_source,ootb_is_guest_checkout: Source of the checkout and whether guest checkout is used.ootb_language,ootb_country: Locale context for the checkout.
Updated 11 days ago
