Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
CDPCloud Portal
Sitecore CDP Developer Documentation
  • Developing with Sitecore CDP
            • Settings object
                • VIEW event
                • IDENTITY event
                • ORDER_CHECKOUT event
                • ADD event
                • CONFIRM event
                • CHECKOUT event
                • PAYMENT event
                • CLEAR_CART event
                • SEARCH event
                • Custom event
            • Extension data object
        • Troubleshooting
        • Release notes
  1. Event data object
  1. Stream API
  2. Objects
  3. Event data object
  4. CHECKOUT event

CHECKOUT event

The event data object for a CHECKOUT event must include all the required attributes for event data objects plus the following attributes:

Attribute

Type

Description

Example

reference_id

string (uppercase)

The order ID.

"MA-490094"

status

string (uppercase)

The order status.

Must be one of:

  • "PURCHASED"

  • "PAYMENT_PENDING"

  • "CONFIRMED"

  • "CANCELLED"

  • "REFUNDED"

After you create this event data object, you can optionally extend this event using the extension data object. Then, you can send the event using the Engage.event() function.

const eventData = {
    channel: "WEB",
    currency: "EUR",
    pointOfSale: "myretailsite/ireland",
    language: "EN",
    page: "home",
    reference_id: "MA-490094",
    status: "PURCHASED"
}
If you have suggestions for improving this article, let us know!

Documentation Assistant

This assistant uses AI to generate responses based on Sitecore documentation. While it has access to official sources, answers may be incomplete or inaccurate and should not be considered official advice or support.
Powered by
k
kapa.ai
Protected by reCAPTCHA

© Copyright 2026, Sitecore A/S or a Sitecore affiliated company.
All rights reserved.

Privacy policySitecore Trust CenterTerms of use