Order Shipped

This document describes the Out-Of-The-Box (OOTB) Order Shipped event schema. This event should be sent when an entire customer order (potentially containing multiple items) has been shipped. It includes details about the shipment, carrier, shipping address, and information for each product included in the shipment.

Event Key

Event Key	Event Name	Type
`ootb_order_shipped`	Order Shipped	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 Order Shipped event.

{
  "context": {
    "ootb_email": "[email protected]",
    "ootb_order_id": "o987654321",
    "ootb_shipment_date": "2025-04-07T16:30:00Z",
    "ootb_shipping_carrier": "UPS",
    "ootb_tracking_number": "1Z999AA10123456784",
    "ootb_shipping_method": "Express",
    "ootb_shipping_address_country": "US",
    "ootb_shipping_address_city": "New York",
    "ootb_shipping_address_zip": "10001",
    "ootb_shipping_address_line1": "123 Example St",
    "ootb_shipping_address_line2": "Apt 4B",
    "ootb_item1_product_id": "SKU12345",
    "ootb_item1_product_name": "Wireless Headphones",
    "ootb_item1_category": "Electronics",
    "ootb_item1_price": 99.99,
    "ootb_item1_quantity": 1,
    "ootb_item1_image_url": "https://example.com/products/sku12345.jpg",
    "ootb_item2_product_id": "SKU98765",
    "ootb_item2_product_name": "Phone Case",
    "ootb_item2_category": "Accessories",
    "ootb_item2_price": 25.00,
    "ootb_item2_quantity": 2,
    "ootb_item2_image_url": "https://example.com/products/sku98765.jpg",
    "ootb_total_value": 149.99
  }
}

(Note: ootb_total_value in the example above is illustrative and should represent the sum of all items and any shipping/tax if applicable to the shipment value.)

Parameters

Parameter Key	Parameter Name	Type	Description
`ootb_email`	OOTB Email	String	Customer’s email address.
`ootb_order_id`	OOTB Order ID	String	Unique identifier of the shipped order.
`ootb_shipment_date`	OOTB Shipment Date	Timestamp	Date and time the order was shipped (ISO 8601).
`ootb_shipping_carrier`	OOTB Shipping Carrier	String	Shipping provider (e.g., UPS, FedEx, DHL).
`ootb_tracking_number`	OOTB Tracking Number	String	Tracking number provided by the carrier.
`ootb_shipping_method`	OOTB Shipping Method	String	Shipping method selected at checkout (e.g., Express, Standard).
`ootb_shipping_address_country`	OOTB Shipping Address Country	String	Country code for the shipping address (e.g., US).
`ootb_shipping_address_city`	OOTB Shipping Address City	String	City of the shipping address.
`ootb_shipping_address_zip`	OOTB Shipping Address Zip	String	ZIP/postal code of the shipping address.
`ootb_shipping_address_line1`	OOTB Shipping Address Line 1	String	Primary address line for shipping.
`ootb_shipping_address_line2`	OOTB Shipping Address Line 2	String	Secondary address line for shipping (optional).
`ootb_itemN_product_id`	OOTB Item N Product ID	String	Product ID for item N (where N is the 1-based index of the item).
`ootb_itemN_product_name`	OOTB Item N Product Name	String	Product name for item N.
`ootb_itemN_category`	OOTB Item N Category	String	Product category for item N.
`ootb_itemN_price`	OOTB Item N Price	Number	Unit price of item N.
`ootb_itemN_quantity`	OOTB Item N Quantity	Number	Quantity shipped for item N.
`ootb_itemN_image_url`	OOTB Item N Image URL	String	Image URL of item N (optional).
`ootb_total_value`	OOTB Total Value	Number	Total value of the items in this shipment.

(Note: For parameters like ootb_itemN_product_id, N represents the 1-based index of the item in the shipment, e.g., ootb_item1_product_id, ootb_item2_product_id, etc., for however many items are in the shipment.)

Explanation

event: Set to ootb_order_shipped to signify that a customer's order has been dispatched.
context:
- ootb_email, ootb_order_id: Identify the customer and the specific order that was shipped.
- ootb_shipment_date, ootb_shipping_carrier, ootb_tracking_number, ootb_shipping_method: Provide details about the shipment logistics.
- Shipping Address Fields (ootb_shipping_address_country, ootb_shipping_address_city, etc.): Detail the destination of the shipment.
- Item Details (ootb_itemN_product_id, ootb_itemN_product_name, etc.): List each item included in this specific shipment, including its identifier, name, category, price, and quantity. The N indicates the item's sequence in the list.
- ootb_total_value: Represents the total monetary value of the items included in this shipment.