Skip to main content
Users
CloudPortalLogin
  • Powered byPowered by
Developing with Sitecore Personalize
Data privacy
Before you start sending data
Integrating with Sitecore Personalize
Stream API
Personalize API Flow execution
REST APIs
  • Sitecore Personalize for developers
  • Stream API
  • Sitecore Engage SDK reference
  • Objects
  • Event data object
  • 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.

RequestResponse
const eventData = {
    channel: "WEB",
    currency: "EUR",
    pointOfSale: "myretailsite/ireland",
    language: "EN",
    page: "home",
    reference_id: "MA-490094",
    status: "PURCHASED"
}

Do you have some feedback for us?

If you have suggestions for improving this article,

Privacy policySitecore Trust CenterCopyright © 1999-2025 Sitecore