Order Failed

Event Key

ootb_order_failed

This event should be sent when a payment or order submission fails—typically due to invalid payment details, declined card, system errors, etc.

Event Key	Event Name	Type
`ootb_order_failed`	Order/Payment Failed	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 Order Failed event:

{
  "context": {
    "ootb_session_id": "248rhdbuw2her1",
    "ootb_userid": "ExampleUser1234",
    "ootb_eventdatetime": "2024-03-09T07:12:00.000Z",
    "ootb_cart_id": "C-8830225XYZ",
    "ootb_order_attempt_id": "ORD-ATT-234235",
    "ootb_failure_reason": "payment_declined",
    "ootb_payment_method": "credit_card",
    "ootb_total_attempted_amount": 50.00,
    "ootb_currency": "USD",
    "ootb_fullfillment_type": "standard_delivery"
  }
}

Parameters

Parameter Key	Parameter Name	Type	Description
`ootb_session_id`	Session ID	String	User’s browser session identifier.
`ootb_userid`	User ID	String	Unique key identifying the user.
`ootb_eventdatetime`	Event Date Time	Timestamp	Time when the failure occurred.
`ootb_cart_id`	Cart ID	String	Cart associated with the failed attempt.
`ootb_order_attempt_id`	Order Attempt ID	String	Unique ID of the failed order attempt.
`ootb_failure_reason`	Failure Reason	String	High-level reason for failure (e.g., `payment_declined`, `timeout`).
`ootb_payment_method`	Payment Method	String	Method attempted for payment (e.g., `credit_card`, `paypal`).
`ootb_total_attempted_amount`	Total Attempted Amount	Number	Total value attempted for payment.
`ootb_currency`	Currency	String	Currency used during the attempt (e.g., USD).
`ootb_fullfillment_type`	Fulfillment Type	Enum	`bopis` or `standard_delivery` — used for follow-up actions.

Explanation

event: Set to ootb_order_failed to indicate an order or payment submission has failed.
context:
- ootb_session_id, ootb_userid: Link the failure to the user’s session and identity.
- ootb_eventdatetime: Timestamp when the failure occurred.
- ootb_cart_id, ootb_order_attempt_id: Identify which cart and which attempt failed.
- ootb_failure_reason: Provides the code or message explaining why the order failed.
- ootb_payment_method, ootb_total_attempted_amount, ootb_currency: Capture the attempted payment method, amount, and currency.
- ootb_fullfillment_type: Indicates whether the intended order was for in-store pickup (bopis) or standard delivery.