Order Fulfilled
This document describes the Out-Of-The-Box (OOTB) Product Order Fulfilled event schema for use in your integrations. This event should be sent once per item that has been fulfilled in an order. This per-item structure is crucial for accurately tracking fulfillment at the item level, especially for orders involving partial shipments or staggered deliveries.
Event Key
Event Key | Event Name | Type |
---|---|---|
ootb_product_order_fulfilled | Order Fulfilled | 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 Fulfilled event.
{
"context": {
"ootb_email": "[email protected]",
"ootb_order_id": "ORD-87654321",
"ootb_fulfillment_date": "2025-04-08T12:00:00Z",
"ootb_currency": "USD",
"ootb_shipping_method": "Express",
"ootb_shipping_carrier": "UPS",
"ootb_tracking_number": "1Z999AA10123456784",
"ootb_product_id": "SKU12345",
"ootb_product_name": "Wireless Headphones",
"ootb_category": "Electronics",
"ootb_price": 99.99,
"ootb_quantity": 1,
"ootb_image_url": "https://example.com/products/sku12345.jpg"
}
}
Parameters
Parameter Key | Parameter Name | Type | Description |
---|---|---|---|
ootb_email | OOTB Email | String | Customer’s email address. |
ootb_order_id | OOTB Order ID | String | The full order ID to which this fulfilled item belongs. |
ootb_fulfillment_date | OOTB Fulfillment Date | Timestamp | Date and time this specific item was fulfilled (ISO 8601). |
ootb_currency | OOTB Currency | String | Currency code of the order (e.g., USD, EUR). |
ootb_shipping_method | OOTB Shipping Method | String | Shipping method used for this item/shipment (e.g., Express). |
ootb_shipping_carrier | OOTB Shipping Carrier | String | Shipping carrier used for this item/shipment (e.g., UPS). |
ootb_tracking_number | OOTB Tracking Number | String | Carrier tracking number for this item/shipment. |
ootb_product_id | OOTB Product ID | String | Unique identifier for the fulfilled product. |
ootb_product_name | OOTB Product Name | String | Name of the fulfilled product. |
ootb_category | OOTB Category | String | Category the fulfilled product belongs to (e.g., Electronics). |
ootb_price | OOTB Price | Number | Unit price of the fulfilled product. |
ootb_quantity | OOTB Quantity | Number | Quantity of this specific product that was fulfilled. |
ootb_image_url | OOTB Image URL | String | URL of the product image (optional). |
Explanation
- event: Set to
ootb_product_order_fulfilled
to signify that a specific item from an order has been fulfilled. - context:
ootb_email
,ootb_order_id
: Identify the customer and the overall order associated with this fulfillment.ootb_fulfillment_date
: Pinpoints when this specific item was fulfilled.ootb_currency
: Specifies the currency used in the transaction for this item.ootb_shipping_method
,ootb_shipping_carrier
,ootb_tracking_number
: Provide shipment details for the fulfilled item.- Product Details (
ootb_product_id
,ootb_product_name
,ootb_category
,ootb_price
,ootb_quantity
,ootb_image_url
): Describe the actual item that has been fulfilled, including its identity, classification, price, and the quantity fulfilled in this instance.
Updated 3 days ago