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. Sitecore CDP Developer Documentation
  2. Stream API

CHECKOUT event

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

AttributeTypeDescriptionExample
reference_idstring (uppercase)The order ID."MA-490094"
statusstring (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()](../../functions/engage-event.md "Engage.event(type, eventData[, extensionData])") 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!

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

Privacy policySitecore Trust CenterTerms of use
CDPCloud Portal