Cart Schema

Map an Engagement Mobile SDK cart event to the cart schema.

Source Event PropertyTarget Schema Developer NameField TypeDescriptionCustomer 360 Data Model Object / Attribute
Automatically AssignedeventIdtextRequired. Typically, the primary key for the engagement events.Engagement / Engagement Id
Automatically AssigneddateTimedatetimeRequired. Used for data partitioning for engagement events. ISO8601 supported format.Engagement / Engagement Date Time
Automatically AssignedeventType = "cart"textRequired. The developerName of an event defined in the Web Connector schema.-
Automatically AssignedsessionIdtextRequired. The session identifier.-
Automatically AssigneddeviceIdtextRequired. Typically, the primary key for profile events.Shopping Cart Engagement / Individual
Automatically Assignedcategory = "Engagement"textRequired. Possible values are:
  • Engagement
  • Profile
-
Automatically AssignedinteractionName = "Add To Cart" | "Remove From Cart" | "Replace Cart"textRequired. An event’s descriptive name.Shopping Cart Engagement / Shopping Cart Event Type
Automatically Assignedchannel = "mobile"textThe SDK event channel. For Engagement Mobile SDK, the value is mobile.Engagement / Engagement Channel Type
Automatically Assigned when Location Tracking is allowedlongitudenumberThe longitudinal coordinate, in decimal degrees, reported by the device at the time the event was captured.Device Longitude
Automatically Assigned when Location Tracking is allowedlatitudenumberThe latitudinal coordinate, in decimal degrees, reported by the device at the time the event was captured.Device Latitude

Each Line Item Attribute contained in the Cart Event is mapped to a child event where cartEventId is set to the parent cart event’s eventId.

Source Event PropertyTarget Schema Developer NameField TypeDescriptionCustomer 360 Data Model Object / Attribute
Automatically AssignedeventIdtextRequired. Typically, the primary key for the engagement events.-
Automatically AssigneddateTimedatetimeRequired. Used for data partitioning for engagement events. ISO8601 supported format.-
Automatically AssignedeventType = "cartItem"textRequired. The developerName of an event defined in the Web Connector schema.-
Automatically AssignedsessionIdtextRequired. The session identifier.-
Automatically AssigneddeviceIdtextRequired. Typically, the primary key for profile events.-
Automatically Assignedcategory = "Engagement"textRequired. Possible values are:
  • Engagement
  • Profile
-
Automatically AssignedcartEventIdtextRequired. The eventId of the cart event containing the line item.Shopping Cart Product Engagement / Shopping Cart Engagement
lineItem.catalogObjectTypecatalogObjectTypetextRequired. A type name of the catalog object referenced in the line item.Shopping Cart Product Engagement / Product Category
lineItem.catalogObjectIdcatalogObjectIdtextRequired. A unique identifier representing the catalog object referenced in the line item.Shopping Cart Product Engagement / Product
lineItem.quantityquantitynumberThe number of catalog objects in the line item.Shopping Cart Product Engagement / Product Quantity
lineItem.pricepricenumberThe price of the catalog object referenced in the line item.Shopping Cart Product Engagement / Product Price
lineItem.currencycurrencytextThe currency for the price field.Shopping Cart Product Engagement / Currency
lineItem.attributes.customField0attributeCustomField0anyA user-supplied value.-
lineItem.attributes.customFieldNattributeCustomFieldNanyA user-supplied value.-

Properties added to lineItem.attributes aren’t automatically defined in the recommended schema. They’re shown to demonstrate how the source properties are mapped to the target schema. You must manually add the properties to the schema.