Customer Data Platform Developer Guide
jOrder Schema
An order interaction is a commerce action that captures actions performed by a user to
manage new, in progress, or completed orders.
| Source Event Property | Target Schema Developer Name | Field Type | Description | Customer 360 Data Model Object / Attribute |
|---|---|---|---|---|
| <Automatically Assigned> | eventId | text | Required. Typically the primary key for the engagement events. | Engagement / Engagement Id |
| <Automatically Assigned> | dateTime | datetime | Required. Used for data partitioning for engagement events. ISO8601 supported format. | Engagement / Engagement Date Time |
| <Automatically Assigned> | eventType = "order" | text | Required. The developerName of an event defined in the Web Connector schema. | - |
| <Automatically Assigned> | sessionId | text | Required. The identifier of the session. | - |
| <Automatically Assigned> | deviceId | text | Required. Typically the primary key for profile events. | Product Order Engagement / Individual |
| <Automatically Assigned> | category = "Engagement" | text | Required. Possible values are:
|
- |
| <Automatically Assigned> | interactionName = "Cancel | Deliver | Exchange | Preorder | Purchase | Return | Ship" | text | Required. A descriptive name for the event. | Product Order Engagement / Product Order Event Type |
| <Automatically Assigned> | channel = "mobile" | text | The SDK event channel. For Engagement Mobile SDK the value is mobile. | Engagement / Engagement Channel Type |
| <Automatically Assigned if Location Tracking is allowed> | longitude | number | The longitudinal coordinate in decimal degrees reported by the device at the time the event was captured. | Engagement / Device Longitude |
| <Automatically Assigned if Location Tracking is allowed> | latitude | number | The latidudinal coordinate in decimal degrees reported by the device at the time the event was captured. | Engagement / Device Latitude |
Each Line Item Attribute contained in the Order Event gets mapped to a child event where order EventId is set to the eventId of the parent order event:
| Source Event Property | Target Schema Developer Name | Data Type | Description | Customer 360 Data Model Object / Attribute |
|---|---|---|---|---|
| <Automatically Assigned> | eventId | text | Required. Typically the primary key for the engagement events. | - |
| <Automatically Assigned> | dateTime | datetime | Required. Used for data partitioning for engagement events. ISO8601 supported format. | - |
| <Automatically Assigned> | eventType = "orderItem" | text | Required. The developerName of an event defined in the Web Connector schema. | - |
| <Automatically Assigned> | sessionId | text | Required. An identifier for a session. | - |
| <Automatically Assigned> | deviceId | text | Required. Typically the primary key for profile events. | - |
| <Automatically Assigned> | category = "Engagement" | text | Required. Possible values are:
|
- |
| <Automatically Assigned> | orderEventId | text | Required. The eventId of the order event containing this Line Item. | Product Order Engagement |
| lineItem.catalogObjectType | catalogObjectType | text | Required. A type name of the catalog object referenced in the line item. | - |
| lineItem.catalogObjectId | catalogObjectId | text | Required. A unique identifier representing the catalog object referenced in the line item. | - |
| lineItem.quantity | quantity | number | The number of catalog objects in the line item. | Product Order Engagement / Currency |
| lineItem.price | price | number | The price of the catalog object referenced in the line item. | Product Order Engagement / Currency |
| lineItem.currency | currency | text | The currency for the price field. | Product Order Engagement / Currency |
| lineItem.attributes.customField0 | attributeCustomField0 | any | A user-supplied value. | - |
| lineItem.attributes.customFieldN | attributeCustomFieldN | any | A user-supplied value. | - |