Product Refund

This document describes the Out-Of-The-Box (OOTB) Product Refund event schema for use in your integrations. This event should be sent whenever an item refund is issued, whether partial or full. This can occur after return processing, customer service intervention, or automated refund workflows. Crucially, an event should be sent on a product level, meaning one event is triggered for each product that was refunded.

Event Key

Event Key	Event Name	Type
`ootb_product_refund`	Product Refund	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 Refund event.

{
  "context": {
    "ootb_session_id": "248rhdbuw2her1",
    "ootb_order_id": "ORD-4498TREF",
    "ootb_item_order_id": "OI-1298840",
    "ootb_refund_id": "RFND-98732",
    "ootb_product_id": "Sneakers93824",
    "ootb_variant_id": "Sneakers93824-White9",
    "ootb_sku_id": "Sneakers93824-White9-S9",
    "ootb_item_name": "White High-Top Sneakers - Size 9",
    "ootb_brand": "ExampleBrand",
    "ootb_category": "C-Footwear",
    "ootb_department": "D-Shoes",
    "ootb_refund_amount": 89.99,
    "ootb_refund_reason": "damaged_item"
  }
}

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 ID if the refund was processed online.	Optional
`ootb_order_id`	OOTB Order ID	String	The order associated with the refund.	Mandatory
`ootb_item_order_id`	OOTB Item Order ID	String	ID of the specific item being refunded from the order.	Mandatory
`ootb_refund_id`	OOTB Refund ID	String	Unique identifier for this specific refund transaction.	Mandatory
`ootb_product_id`	OOTB Product ID	String	Refunded product’s ID.	Mandatory
`ootb_variant_id`	OOTB Variant ID	String	Variant identifier of the refunded product.	Optional
`ootb_sku_id`	OOTB SKU ID	String	SKU identifier of the refunded product.	Optional
`ootb_item_name`	OOTB Item Name	String	Name of the refunded item.	Optional
`ootb_brand`	OOTB Brand	String	Brand of the refunded product.	Optional
`ootb_category`	OOTB Category	String	Lowest-level category of the refunded product.	Optional
`ootb_department`	OOTB Department	String	Top-level department or category of the refunded product.	Optional
`ootb_refund_amount`	OOTB Refund Amount	Number	The amount refunded for this specific item (can be full or partial).	Mandatory
`ootb_refund_reason`	OOTB Refund Reason	String	Reason for the refund (e.g., `damaged_item`, `late_delivery`, `changed_mind`).	Optional