ORDER_CHECKOUT event
To use the flight data model, assemble orders using multiple events instead of sending an ORDER_CHECKOUT event.
Before you can send an ORDER_CHECKOUT event, the guest must be identified by sending an IDENTITY event.
To send an ORDER_CHECKOUT event, use the following required attributes:
|
Attribute |
Type |
Description |
Example |
|---|---|---|---|
|
|
string (uppercase) |
The touchpoint where the user interacts with your brand. |
|
|
|
string (uppercase) |
The type of the event that takes place when the user interacts with your brand. |
|
|
|
string (uppercase ISO 639-1) |
The language the user is using your app in. |
|
|
|
string (uppercase ISO 4217) |
The alphabetic currency code of the currency the user is using in your app. |
|
|
|
string |
The name of the webpage where the interaction with your brand takes place. This is a custom value of your choice. |
|
|
|
string |
The name of the point of sale where the interaction with your brand takes place. |
|
|
|
string |
The browser ID. |
|
|
|
object |
The guest's purchase order. |
N/A |
The order object:
|
Attribute |
Type |
Description |
Example |
Required/optional |
|---|---|---|---|---|
|
|
string |
A unique ID generated by your organization to reference the order. |
|
Required |
|
|
ISO 8601 Date/Time UTC |
The date and time the order was made. |
|
Required |
|
|
string (uppercase) |
The status of the order. |
|
Required |
|
|
string (uppercase ISO 4217) |
The currency the guest used to complete a purchase. |
|
Required |
|
|
number (currency) |
The amount paid for the order. |
|
Required |
|
|
string (title case recommended) |
The method of payment for the order. |
|
Required |
|
|
string (title case recommended) |
The card type used to pay for the order. |
|
Required if |
|
|
array of objects |
A list of data extensions associated with the order. |
N/A |
Optional |
|
|
array of objects |
Items in the order. |
N/A |
Optional |
The order.extensions array of objects. All attributes are optional.
|
Attribute |
Type |
Description |
Example |
|---|---|---|---|
|
|
string enum |
Set this to |
|
|
|
string enum |
Set this to |
|
|
attribute |
This is a custom attribute of your choice. Supported types for the value:
|
One or many key-value pairs attributes for custom data. |
|
The order.orderItems array of objects. All attributes are optional.
|
Attribute |
Type |
Description |
Example |
|---|---|---|---|
|
|
string (uppercase) |
The type of order item. The accepted values must be predefined for your organization in the schema. |
|
|
|
string |
An ID generated by the client to reference the order item. |
|
|
|
string (ISO 8601) |
The date and time the order item was made. |
|
|
|
string enum |
The status of the order item. |
|
|
|
string (uppercase ISO 4217) |
The organization’s currency code for the order item. |
|
|
|
number (currency) |
The organization’s price for the order item. |
|
|
|
string (title case recommended) |
The name of the order item. A free text value for the name of the order item. Max limit: 128 |
|
|
|
string |
The ID of the product code. |
|
|
|
number |
The number or quantity of the order item. |
|
|
|
array of objects |
A list of data extensions associated with the order item. Only one data extension is supported. You can request this feature from your Sitecore representative. |
N/A |
The order.orderItems.extensions array of objects. All attributes are optional.
|
Attribute |
Type |
Description |
Example |
|---|---|---|---|
|
|
string enum |
Set this to |
|
|
|
string enum |
Set this to |
|
|
attribute |
This is a custom attribute of your choice. Supported types for the value:
|
One or many key-value pairs attributes for custom data. |
|
{
"type": "ORDER_CHECKOUT",
"channel": "WEB",
"pos": "myretailsite/ireland",
"browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925",
"language": "EN",
"currency": "EUR",
"page":"checkout page",
"order": {
"referenceId": "123456",
"orderedAt": "2024-08-23T16:17:16.000Z",
"status": "PURCHASED",
"currencyCode": "EUR",
"price": 200,
"paymentType": "Card",
"cardType": "Visa",
"extensions": [
{
"name": "ext",
"key": "default",
"refundable": true
}
],
"orderItems": [
{
"type": "MOBILE_PHONE",
"referenceId": "REF-123",
"orderedAt": "2024-08-23T16:17:16.000Z",
"status": "PURCHASED",
"currencyCode": "EUR",
"price": 200,
"name": "Mobile phone of type x",
"productId": "MOBILE_PHONE_TYPE_X",
"quantity": 1,
"extensions": [
{
"name": "ext",
"key": "default",
"phoneColor": "Gold",
"insurance": false
}
]
}
]
}
}