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

📘
Events-based Integration (EBI): parameter classification
The Events-based Integration column shows how each parameter is treated when you onboard using an Events-based Integration:

Mandatory — required for the event to be ingested and processed correctly.

Mandatory if required for the execution channel integration — required only when the relevant execution channel (e.g., email, SMS, push, WhatsApp) is part of your integration.

Enrichment- used for out-of-the-box attribute — not required, but when provided it powers an Optimove out-of-the-box attribute.

Optional — accepted and stored when provided; not required and not tied to an OOTB attribute.

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