Order Completed

This document describes the Out-Of-The-Box (OOTB) Product Order Completed event schema for use in your integrations. This event signifies the confirmation of an order after items have been processed through the cart. It's designed to capture details for each item within an order; therefore, one event should be sent for each unique item in a completed order, including its quantity. This event is crucial for tracking purchases and enabling post-conversion marketing activities.

Event Key

Event Key	Event Name	Type
`ootb_product_order_completed`	Order Completed	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 OOTB Product Order Completed event.

{
  "context": {
    "ootb_session_id": "248rhdbuw2her1",
    "ootb_email": "[email protected]",
    "ootb_order_id": "O-3sd82rhf",
    "ootb_item_order_id": "OI-1298840",
    "ootb_product_id": "RippedJeans1934256",
    "ootb_variant_id": "RippedJeans1934256-Blue",
    "ootb_sku_id": "RippedJeans1934256-Blue-W28H30",
    "ootb_item_name": "Casual Ripped Blue Jeans",
    "ootb_item_description": "Men's ripped blue jeans made from stretch denim",
    "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_item_price": 20.00,
    "ootb_quantity": 2,
    "ootb_total_pay": 40.00,
    "ootb_discount_percentage": 10,
    "ootb_promo_code": "SPRING10",
    "ootb_payment_method": "Credit Card",
    "ootb_store_type": "Online",
    "ootb_tax_amount": 2.00,
    "ootb_delivery_fee": 4.99,
    "ootb_fullfillment_type": "standard_delivery"
  }
}

Parameters

Optional fields are marked with an asterisk (*).

Parameter Key	Parameter Name	Type	Description
`ootb_session_id`*	OOTB Session ID	String	User's browser session.
`ootb_email`	OOTB Email	String	Customer’s email address.
`ootb_order_id`	OOTB Order ID	String	Unique identifier for the order.
`ootb_item_order_id`*	OOTB Item Order ID	String	Unique ID for the specific item’s order line.
`ootb_product_id`	OOTB Product ID	String	Product identifier.
`ootb_variant_id`*	OOTB Variant ID	String	Variant of the product ordered.
`ootb_sku_id`*	OOTB SKU ID	String	SKU of the variant.
`ootb_item_name`*	OOTB Item Name	String	Name of the item ordered.
`ootb_item_description`*	OOTB Item Description	String	Description of the item.
`ootb_brand`	OOTB Brand	String	Brand of the product.
`ootb_category`	OOTB Category	String	Lowest-level category.
`ootb_department`	OOTB Department	String	Top-level category or department.
`ootb_url`*	OOTB Page URL	String	Link to the product page.
`ootb_page_title`*	OOTB Page Title	String	Title of the product page.
`ootb_page_category`*	OOTB Page Category	String	Category of the product page.
`ootb_item_price`	OOTB Item Price	Number	Single unit price at time of order.
`ootb_quantity`	OOTB Quantity	Number	Number of units ordered for this item.
`ootb_total_pay`	OOTB Total Pay	Number	Total pay after quantity considered (includes discount).
`ootb_discount_percentage`*	OOTB Discount Percentage	Number	Discount applied as a percentage.
`ootb_promo_code`*	OOTB Promo Code	String	Promotion code used during checkout.
`ootb_payment_method`	OOTB Payment Method	String	Payment method selected at checkout.
`ootb_store_type`	OOTB Store Type	String	Type of store (`Online`, `In-Store`, `Marketplace`).
`ootb_tax_amount`*	OOTB Tax Amount	Number	Total tax applied for this item line.
`ootb_delivery_fee`*	OOTB Delivery Fee	Number	Associated delivery/shipping fee.
`ootb_fullfillment_type`*	OOTB Fulfillment Type	Enum	`bopis` (Buy Online Pickup In Store) or `standard_delivery`.

Explanation

event: Set to ootb_product_order_completed to signify that an item within an order has been successfully purchased.
context:
- ootb_session_id, ootb_email: Link the order to the user’s session and identity.
- ootb_order_id, ootb_item_order_id: Uniquely identify the overall order and the specific line item within that order.
- Product Details (ootb_product_id, ootb_variant_id, ootb_sku_id, ootb_item_name, ootb_item_description, ootb_brand, ootb_category, ootb_department): Provide comprehensive information about the item purchased.
- Page Context (ootb_url, ootb_page_title, ootb_page_category): Information about the product page from which the item might have originated.
- Pricing & Payment (ootb_item_price, ootb_quantity, ootb_total_pay, ootb_discount_percentage, ootb_promo_code, ootb_payment_method, ootb_tax_amount, ootb_delivery_fee): Capture all financial details related to the purchase of this specific item.
- ootb_store_type, ootb_fullfillment_type: Detail the nature of the purchase environment and how the item will be received by the customer.