Online Order (Opti-X)

Event Key

ootb_online_order

This event should be sent when a user confirms an online order for a single item (with variable quantity).

Event Key	Event Name	Type
`ootb_online_order`	Online Order	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 Online Order event:

{
  "context": {
    "ootb_session_id": "248rhdbuw2her1",
    "ootb_userid": "ExampleUser1234",
    "ootb_eventdatetime": "2024-03-09T06:00:12.000Z",
    "ootb_product_id": "RippedJeans1934256",
    "ootb_variant_id": "RippedJeans1934256-Blue",
    "ootb_sku_id": "RippedJeans1934256-Blue-W28H30",
    "ootb_brand": "Example Brand",
    "ootb_category": "C-22149",
    "ootb_department": "D-902es",
    "ootb_url": "https://www.example.com/jeans/1934256",
    "ootb_page_title": "Casual Ripped Blue Jeans",
    "ootb_page_category": "Clothing – Jeans",
    "ootb_currency": "USD",
    "ootb_item_name": "Casual Ripped Blue Jeans",
    "ootb_quantity": 2,
    "ootb_total_pay": 40.00,
    "ootb_discount_percentage": 10,
    "ootb_item_order_id": "OI-1298840",
    "ootb_order_id": "O-3sd82rhf",
    "ootb_tax_amount": 2.00,
    "ootb_delivery_fee": 4.99,
    "ootb_fullfillment_type": "standard_delivery"
  }
}

Parameters

Parameter Key	Parameter Name	Type	Description	Mandatory for Opti-X?
`ootb_session_id`	Session ID	String	User’s browser session identifier.	No
`ootb_userid`	User ID	String	Unique key identifying the user.	Yes
`ootb_eventdatetime`	Event Date Time	Timestamp	Date and time of the order.	Yes
`ootb_product_id`	Product ID	String	Unique key for the product ordered.	Yes
`ootb_variant_id`	Variant ID	String	Key identifying the variant of the product.	No
`ootb_sku_id`	SKU ID	String	Key identifying the SKU of the variant.	No
`ootb_brand`	Brand	String	Brand of the item.	Yes
`ootb_category`	Category	String	Key identifying the lowest level of product category.	Yes
`ootb_department`	Department	String	Key identifying the department or highest-level category.	Yes
`ootb_url`	URL	String	Link to the product page.	No
`ootb_page_title`	Page Title	String	Title of the product’s page.	No
`ootb_page_category`	Page Category	String	Category label of the product’s page.	No
`ootb_currency`	Currency	String	Currency code of the order (e.g., USD).	No
`ootb_item_name`	Item Name	String	Name of the item ordered.	No
`ootb_quantity`	Quantity	Number	Quantity of the item ordered.	No
`ootb_total_pay`	Total Pay	Number	Total payment for this item (quantity × price, after discounts).	No
`ootb_discount_percentage`	Discount Percentage	Number	Discount applied to the item as a percentage.	No
`ootb_item_order_id`	Item Order ID	String	Unique identifier for this item order line.	No
`ootb_order_id`	Order ID	String	Unique identifier for the overall order.	Yes
`ootb_tax_amount`	Tax Amount	Number	Tax amount for this item (considering quantity).	No
`ootb_delivery_fee`	Delivery Fee	Number	Delivery or shipping fee for the order (may cover multiple items).	No
`ootb_fullfillment_type`	Fulfillment Type	Enum	`bopis` or `standard_delivery` to indicate pickup vs delivery.	No

Explanation

event: Set to ootb_online_order to indicate an online order placement for a single item.
context:
- ootb_session_id, ootb_userid: Link the order to the user’s session and identity.
- ootb_eventdatetime: Timestamp when the order was confirmed.
- ootb_product_id, ootb_variant_id, ootb_sku_id, ootb_item_name, ootb_brand: Identify the specific item ordered, its variant, SKU, name, and brand.
- ootb_category, ootb_department: Provide product taxonomy (lowest and highest level categories).
- ootb_url, ootb_page_title, ootb_page_category: Context of the product page from which the item might have been ordered.
- ootb_currency, ootb_quantity, ootb_total_pay, ootb_discount_percentage, ootb_tax_amount, ootb_delivery_fee: Capture the financial details of the ordered item, including currency, quantity, total payment for the item, any discounts, taxes, and associated delivery fees.
- ootb_item_order_id, ootb_order_id: Unique identifiers for the specific line item within the order and the overall order itself.
- ootb_fullfillment_type: Indicates whether the purchase is for in-store pickup (bopis) or standard home delivery.

Updated about 10 hours ago