Send a CHECKOUT event to Sitecore CDP

Abstract

Provides the required attributes and a JSON example of how to send a CHECKOUT event to Sitecore CDP (Data model 2.1).

The CHECKOUT event captures a guest's action of checking out an order. After you send this event, you can view the event in the guest profile.

To send a CHECKOUT event, use the following attributes:

Attribute	Description	Type	Example(s)	Required/optional
`channel`	The channel captured on each page the guest visited.	string (uppercase)	`"WEB", "MOBILE_WEB", "MOBILE_APP"`	Required
`type`	The type of event.	string (uppercase)	`"CHECKOUT"`	Required
`language`	The language captured on each page the guest visited.	string (2 letter ISO 639 language code)	`"EN", "FR", "DE"`	Required
`currency`	The type of currency.	string (3 letter ISO 4217)	`"EUR", "USD", "GBP"`	Required
`page`	The name of the webpage the guest visited.	string	`"home page", "search page" "/home", "/confirm"`	Required
`pos`	The point of sale (storefront) captured on each page the guest visited.	string (predefined by client)	`"myretailsite.com"`	Required
`browser_id`	The ID of a browser generated by Sitecore CDP.	string (UUID)	`"56860bff-94ba-4d84-aa37-2b5a83d5411b"`	Required
`reference_id`	The reference of the order.	string (uppercase)	`"ABC123"`	Required
`status`	The status of the order.	string	`“PURCHASED”, “PAYMENT_PENDING”, “CONFIRMED”, “CANCELLED”, “REFUNDED”`	Required

The following JSON example demonstrates how to send a CHECKOUT event:

{
    "channel": "WEB",
    "type": "CHECKOUT",
    "language": "EN",
    "currency": "EUR",
    "page": "home page",
    "pos": "myretailsite.com",
    "browser_id": "56860bff-94ba-4d84-aa37-2b5a83d5411b",
    "reference_id": "ABC123",
    "status": "PURCHASED"
}