Product Return

OOTB Product Return Event

This document describes the Out-Of-The-Box (OOTB) Product Return event schema. This event should be sent when a user completes a return for a specific item from a previously completed order.

Event Key

Event Key	Event Name	Type
`ootb_product_return`	OOTB Product Return	Simple event

Event Structure

The mandatory properties (tenant, timestamp, event, and customer) are required for all events and are documented separately.

Below is the JSON structure for the context-specific properties of the OOTB Product Return event.

{
  "context": {
    "ootb_session_id": "248rhdbuw2her1",
    "ootb_return_id": "r567890123",
    "ootb_order_id": "o987654321",
    "ootb_product_id": "SKU98765",
    "ootb_item_name": "Phone Case",
    "ootb_item_description": "Durable silicone phone case",
    "ootb_category": "Accessories",
    "ootb_item_price": 25.00,
    "ootb_quantity": 1,
    "ootb_reason": "Item not as described",
    "ootb_refund_method": "Original Payment Method",
    "ootb_total_return_value": 25.00,
    "ootb_item_image_url": "[https://example.com/products/sku98765.jpg](https://example.com/products/sku98765.jpg)",
    "ootb_item_page_link": "[https://example.com/product/sku98765](https://example.com/product/sku98765)"
  }
}

Parameters

Mandatory fields are marked with an asterisk (*).

Parameter Key	Parameter Name	Type	Description
`ootb_session_id`	OOTB Session ID	String	User’s browser session ID.
`ootb_return_id`*	OOTB Return ID*	String	Unique ID of the return request.
`ootb_order_id`*	OOTB Order ID*	String	Associated order ID.
`ootb_product_id`*	OOTB Product ID*	String	Product ID of the returned item.
`ootb_item_name`*	OOTB Item Name*	String	Name of the returned item.
`ootb_item_description`*	OOTB Item Description*	String	Description of the item.
`ootb_category`*	OOTB Category*	String	Category the item belongs to.
`ootb_item_price`*	OOTB Item Price*	Number	Unit price of the returned item.
`ootb_quantity`*	OOTB Quantity*	Number	Quantity returned.
`ootb_reason`*	OOTB Reason*	String	Return reason.
`ootb_refund_method`*	OOTB Refund Method*	String	Method used for the refund.
`ootb_total_return_value`*	OOTB Total Return Value*	Number	Total refunded amount for the item.
`ootb_item_image_url`*	OOTB Item Image URL*	String	Image URL of the product.
`ootb_item_page_link`	OOTB Item Page Link	String	URL to the product’s detail page.

Explanation

event: Set to ootb_product_return to indicate a customer has returned a purchased item.
context:
- ootb_return_id and ootb_order_id link the return to a specific return process and the original purchase.
- The various product-specific parameters (ootb_product_id, ootb_item_name, etc.) provide detailed information about what was returned.
- ootb_reason and ootb_refund_method offer valuable insights into customer satisfaction and operational processes.