Sending events

CHECKOUT event

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 required attributes:

Attribute	Type	Description	Example
`channel`	string (uppercase)	The touchpoint where the user interacts with your brand.	`"MOBILE_APP"` `"MOBILE_WEB"` `"WEB"`
`type`	string (uppercase)	The type of the event that takes place when the user interacts with your brand.	`"CHECKOUT"`
`language`	string (uppercase ISO 639-1)	The language the user is using your app in.	`"DE"` `"EN"` `"FR"`
`currency`	string (uppercase ISO 4217)	The alphabetic currency code of the currency the user is using in your app.	`"EUR"` `"GBP"` `"USD"`
`page`	string	The name of the webpage where the interaction with your brand takes place. This is a custom value of your choice.	`"home"` `"contact-us.html"`
`pos`	string	The name of the point of sale where the interaction with your brand takes place.	`"myretailsite/ireland"` `"spinair.com/france"`
`browser_id`	string	The browser ID.	`"a38b230c-11eb-4cf9-8d5d-274e9f344925"`
`reference_id`	string (uppercase)	The reference of the order.	`"ABC123"`
`status`	string enum	The method of payment associated with a checkout.	`"PURCHASED"` `"PAYMENT_PENDING"` `"CONFIRMED"` `"REFUNDED"` `"CANCELLED"`

Example 52. CHECKOUT event object

{
    "channel": "MOBILE_APP",
    "type": "CHECKOUT",
    "language": "EN",
    "currency": "EUR",
    "page": "home page",
    "pos": "myretailsite/ireland",
    "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925",
    "reference_id": "ABC123",
    "status": "PURCHASED"
}

If you have suggestions for improving this article, let us know!