Data collected from addToCart
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
commerce.productListAdds | Indicates if a product was added to a shopping cart. A value of 1 indicates that a product was added. |
commerce.cart.cartID | The unique ID that identifies the customer’s cart. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
productListItems | An array of products that were added to the shopping cart. |
productListItems.SKU | Stock Keeping Unit. The unique identifier for the product. |
productListItems.name | The display name or human-readable name of the product. |
productListItems.priceTotal | The total price for the product line item. |
productListItems.quantity | The number of product units in the cart. |
productListItems.discountAmount | Indicates the discount amount applied. |
productListItems.currencyCode | The ISO 4217 currency code used, such as USD or EUR . |
productListItems.productImageUrl | Main image URL of the product. |
productListItems.selectedOptions | Field used for a configurable product. |
productListItems.selectedOptions.attribute | Identifies an attribute of the configurable product, such as size or color . |
productListItems.selectedOptions.value | Identifies the value of the attribute such as small or black . |
openCart
Description | XDM event name |
---|---|
Triggered when a new cart is created, which is when a product is added to an empty cart. | commerce.productListOpens |
Data collected from openCart
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
commerce.productListOpens | Indicates if a cart was created. A value of 1 indicates that a cart was created. |
commerce.cart.cartID | The unique ID that identifies the customer’s cart. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
productListItems | An array of products that were added to the shopping cart. |
productListItems.SKU | Stock Keeping Unit. The unique identifier for the product. |
productListItems.name | The display name or human-readable name of the product. |
productListItems.priceTotal | The total price for the product line item. |
productListItems.quantity | The number of product units in the cart. |
productListItems.discountAmount | Indicates the discount amount applied. |
productListItems.currencyCode | The ISO 4217 currency code used, such as USD or EUR . |
productListItems.productImageUrl | Main image URL of the product. |
productListItems.selectedOptions | Field used for a configurable product. |
productListItems.selectedOptions.attribute | Identifies an attribute of the configurable product, such as size or color . |
productListItems.selectedOptions.value | Identifies the value of the attribute such as small or black . |
removeFromCart
Description | XDM event name |
---|---|
Triggered every time a product is removed or every time the quantity of a product in the cart is decremented. | commerce.productListRemovals |
Data collected from removeFromCart
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
commerce.productListRemovals | Indicates if a product was removed from the cart. A value of 1 indicates that a product was removed from the cart. |
commerce.cart.cartID | The unique ID that identifies the customer’s cart. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
productListItems | An array of products that were added to the shopping cart. |
productListItems.SKU | Stock Keeping Unit. The unique identifier for the product. |
productListItems.name | The display name or human-readable name of the product. |
productListItems.priceTotal | The total price for the product line item. |
productListItems.quantity | The number of product units in the cart. |
productListItems.discountAmount | Indicates the discount amount applied. |
productListItems.currencyCode | The ISO 4217 currency code used, such as USD or EUR . |
productListItems.productImageUrl | Main image URL of the product. |
productListItems.selectedOptions | Field used for a configurable product. |
productListItems.selectedOptions.attribute | Identifies an attribute of the configurable product, such as size or color . |
productListItems.selectedOptions.value | Identifies the value of the attribute such as small or black . |
shoppingCartView
Description | XDM event name |
---|---|
Triggered when any cart page loads. | commerce.productListViews |
Data collected from shoppingCartView
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
commerce.productListViews | Indicates if a product list was viewed. |
commerce.cart.cartID | The unique ID that identifies the customer’s cart. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
commerce.order | Contains information about the pending order for one or more products. |
commerce.order.discountAmount | Indicates the discount amount applied to the whole order. |
productListItems | An array of products that were added to the shopping cart. |
productListItems.SKU | Stock Keeping Unit. The unique identifier for the product. |
productListItems.name | The display name or human-readable name of the product. |
productListItems.priceTotal | The total price for the product line item. |
productListItems.quantity | The number of product units in the cart. |
productListItems.discountAmount | Indicates the discount amount applied. |
productListItems.currencyCode | The ISO 4217 currency code used, such as USD or EUR . |
productListItems.productImageUrl | Main image URL of the product. |
productListItems.selectedOptions | Field used for a configurable product. |
productListItems.selectedOptions.attribute | Identifies an attribute of the configurable product, such as size or color . |
productListItems.selectedOptions.value | Identifies the value of the attribute such as small or black . |
pageView
Description | XDM event name |
---|---|
Triggered when any page loads. | web.webpagedetails.pageViews |
Data collected from pageView
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
web.webPageDetails.pageViews | Indicates if a page was loaded. A value of 1 indicates that the page was loaded. |
web.webPageDetails.URL | The normative or usual URL of the web page. This can be the actual URL used to reach the page, which would be recorded using Web Link . |
web.webPageDetails.name | The normative name of the web page. This name is not necessarily the page title or directly associated with page content, but is used to organize a site’s pages for classification purposes. |
web.webReferrer.URL | The URL of the webpage a shopper visited before clicking a link to your site. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
productPageView
Description | XDM event name |
---|---|
Triggered when any product page loads. | commerce.productViews |
Data collected from productPageView
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
commerce.productViews | Indicates if the product was viewed. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
productListItems | An array of products that were added to the shopping cart. |
productListItems.SKU | Stock Keeping Unit. The unique identifier for the product. |
productListItems.name | The display name or human-readable name of the product. |
productListItems.priceTotal | The total price for the product line item. |
productListItems.quantity | The number of product units in the cart. |
productListItems.discountAmount | Indicates the discount amount applied. |
productListItems.currencyCode | The ISO 4217 currency code used, such as USD or EUR . |
productListItems.productImageUrl | Main image URL of the product. |
productListItems.selectedOptions | Field used for a configurable product. |
productListItems.selectedOptions.attribute | Identifies an attribute of the configurable product, such as size or color . |
productListItems.selectedOptions.value | Identifies the value of the attribute such as small or black . |
startCheckout
Description | XDM event name |
---|---|
Triggered when the shopper clicks a checkout button. | commerce.checkouts |
Data collected from startCheckout
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
commerce.checkouts | Indicates if an action occurred during the checkout process. |
commerce.cart.cartID | The unique ID that identifies the customer’s cart. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
productListItems | An array of products that were added to the shopping cart. |
productListItems.SKU | Stock Keeping Unit. The unique identifier for the product. |
productListItems.name | The display name or human-readable name of the product. |
productListItems.priceTotal | The total price for the product line item. |
productListItems.quantity | The number of product units in the cart. |
productListItems.discountAmount | Indicates the discount amount applied. |
productListItems.currencyCode | The ISO 4217 currency code used, such as USD or EUR . |
productListItems.productImageUrl | Main image URL of the product. |
productListItems.selectedOptions | Field used for a configurable product. |
productListItems.selectedOptions.attribute | Identifies an attribute of the configurable product, such as size or color . |
productListItems.selectedOptions.value | Identifies the value of the attribute such as small or black . |
completeCheckout
Description | XDM event name |
---|---|
Triggered when the shopper places an order. | commerce.purchases |
Data collected from completeCheckout
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
commerce.purchases | Indicates if an order has been accepted. |
commerce.order | Contains information about the placed order for one or more products. |
commerce.order.purchaseID | Unique identifier assigned by the seller for this purchase or contract. There is no guarantee that the ID is unique. |
commerce.order.payments | The list of payments for this order. |
commerce.order.payments.paymentTransactionID | Unique identifier for this payment transaction. |
commerce.order.payments.paymentAmount | The value of the payment. |
commerce.order.payments.paymentType | The method of payment for this order. Options are: cash , credit_card , debit_card , gift_card , check , paypal , wire_transfer , credit_card_reference , other . |
commerce.order.payments.currencyCode | The ISO 4217 currency code used, such as USD or EUR . |
commerce.order.taxAmount | The tax amount paid by the buyer as part of the final payment. |
commerce.order.discountAmount | Indicates the discount amount applied to the whole order. |
commerce.order.createdDate | The time and date when a new order is created in the commerce system. For example, 2022-10-15T20:20:39+00:00 . |
commerce.shipping | Shipping details for one or more products. |
commerce.shipping.shippingMethod | The method of shipping chosen by the customer, such as standard delivery, expedited delivery, pick up in store, and so on. |
commerce.shipping.shippingAmount | The amount the customer had to pay for shipping. |
commerce.shipping.currencyCode | The ISO 4217 currency code used, such as USD or EUR . |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
personalEmail | A personal email address. |
personalEmail.address | The technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards. |
productListItems | An array of products that were added to the shopping cart. |
productListItems.SKU | Stock Keeping Unit. The unique identifier for the product. |
productListItems.name | The display name or human-readable name of the product. |
productListItems.priceTotal | The total price for the product line item. |
productListItems.quantity | The number of product units in the cart. |
productListItems.discountAmount | Indicates the discount amount applied. |
productListItems.productImageUrl | Main image URL of the product. |
productListItems.selectedOptions | Field used for a configurable product. |
productListItems.selectedOptions.attribute | Identifies an attribute of the configurable product, such as size or color . |
productListItems.selectedOptions.value | Identifies the value of the attribute such as small or black . |
Customer profile events
Profile events captured from the storefront include account information, such as signIn
, signOut
, createAccount
, and editAccount
. This data is used to help populate key customer details that are needed to better define segments or execute marketing campaigns, such as sending sign-up discount offers, account change confirmations, and so on. There are similar profile events captured from the server-side.
signIn
Description | XDM event name |
---|---|
Triggered when a shopper attempts to sign in. | userAccount.login |
Data collected from signIn
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
person | An individual actor, contact, or owner. |
person.accountID | Captures the user account ID. |
person.accountType | Captures the user account type, such as Personal or Company , if applicable. |
person.personalEmailID | The technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards. |
personalEmail | Captures contact details - an e-mail and associated information. |
personalEmail.address | The technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards. |
userAccount | Indicates any loyalty details, preferences, login processes, and other account preferences. |
userAccount.login | Indicates if a visitor attempted to log in. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
signOut
Description | XDM event name |
---|---|
Triggered when a shopper attempts to sign out. | userAccount.logout |
Data collected from signOut
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
userAccount | Indicates any loyalty details, preferences, login processes, and other account preferences. |
userAccount.logout | Indicates if a visitor attempted to log out. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
createAccount
Description | XDM event name |
---|---|
Triggered when a shopper attempts to create an account. | userAccount.createProfile |
Data collected from createAccount
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
person | An individual actor, contact, or owner. |
person.accountID | Captures the user account ID. |
person.accountType | Captures the user account type, such as Personal or Company , if applicable. |
person.personalEmailID | The technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards. |
personalEmail | Captures contact details - an e-mail and associated information. |
personalEmail.address | The technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards. |
userAccount | Indicates any loyalty details, preferences, login processes, and other account preferences. |
userAccount.updateProfile | Indicates if a user has updated their account profile. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
editAccount
Description | XDM event name |
---|---|
Triggered when a shopper attempts to edit an account. | userAccount.updateProfile |
Data collected from editAccount
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
person | An individual actor, contact, or owner. |
person.accountID | Captures the user account ID. |
person.accountType | Captures the user account type, such as Personal or Company , if applicable. |
person.personalEmailID | The technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards. |
personalEmail | Captures contact details - an e-mail and associated information. |
personalEmail.address | The technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards. |
userAccount | Indicates any loyalty details, preferences, login processes, and other account preferences. |
userAccount.updateProfile | Indicates if a user has updated their account profile. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
Search events
The search events provide data relevant to the shopper’s intent. Insight into a shopper’s intent helps merchants see how shoppers are searching for items, what they click, and ultimately purchase or abandon. An example of how you might use this data is if you want to target existing shoppers who search for your top product, but never purchase the product. You must install the Live Search extension to access these events.
Use the searchRequest.id
and searchResponse.id
fields found in both the searchRequestSent
and searchResponseReceived
events to cross-reference a search request to the corresponding search response.
searchRequestSent
Description | XDM event name |
---|---|
Triggered by the following events in the “search as you type” popover: Press Enter, Click View All Triggered by the following events on search results pages: Select a filter, Change the sort order (Sort By), Change the sort direction (ascending or descending), Change the number of results per page (Show # per page), Navigate to the next page, Navigate to the previous page, Navigate to a different page | searchRequest |
Data collected from searchRequestSent
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
searchRequest | Indicates if a search request was sent. |
searchRequest.id | The unique ID for this particular search request. |
searchRequest.value | The quantifiable value of the request. |
siteSearch | Contains information about the search. |
siteSearch.filter | Indicates if any filters were applied to limit search results. |
siteSearch.filter.attribute (filter) | The facet of an item used to determine whether to include it in search results. |
siteSearch.filter.isRange | When true, values indicate endpoints of an acceptable range of values. |
siteSearch.filter.value | Attribute value used to determine which items are included in search results. |
siteSearch.sort | Indicates how search results should be sorted. |
siteSearch.sort.attribute (sort) | An attribute used to sort items in search results. |
siteSearch.sort.order | The order in which to return search results. |
siteSearch.query | The terms searched for. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
searchResponseReceived
Description | XDM event name |
---|---|
Triggered when Live Search returns results for the “search as you type” popover or search results page. | searchResponse |
Data collected from searchResponseReceived
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
searchResponse | Indicates if a search response has been received. |
searchResponse.id | The unique ID for this particular search response. |
searchResponse.value | The quantifiable value of the response. |
siteSearch.numberOfResults | The number of products returned. |
siteSearch.suggestions | An array of strings that include the names of products and categories that exist in the catalog that are similar to the search query. |
productListItems | An array of products that were added to the shopping cart. |
productListItems.SKU | Stock Keeping Unit. The unique identifier for the product. |
productListItems.name | The display name or human-readable name of the product. |
productListItems.productImageUrl | Main image URL of the product. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
B2B events
experience-platform-connector-b2b
extension to access these events.
The B2B events contain requisition list information, such as if a requisition list was created, added to, or deleted from. By tracking events specific to requisition lists, you can see which products your customers purchase frequently and create campaigns based on that data.
createRequisitionList
Description | XDM event name |
---|---|
Triggered when a shopper creates a requisition list. | commerce.requisitionListOpens |
Data collected from createRequisitionList
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
commerce.requisitionListOpens | Indicates initialization of a new requisition list. |
commerce.requisitionList | The properties of the requisition list created by the customer. |
commerce.requisitionList.ID | Unique identifier of the requisition list. |
commerce.requisitionList.name | Name of the requisition list specified by the customer. |
commerce.requisitionList.description | Description of the requisition list specified by the customer. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
addToRequisitionList
Description | XDM event name |
---|---|
Triggered when a shopper adds a product to an existing requisition list or while creating a list. | commerce.requisitionListAdds |
Data collected from addToRequisitionList
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
commerce.requisitionListAdds | Indicates addition of one or more products to a requisition list. |
commerce.requisitionList | The properties of the requisition list created by the customer. |
commerce.requisitionList.ID | Unique identifier of the requisition list. |
commerce.requisitionList.name | Name of the requisition list specified by the customer. |
commerce.requisitionList.description | Description of the requisition list specified by the customer. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
productListItems | An array of products that were added to the requisition list. |
productListItems.SKU | Stock Keeping Unit. The unique identifier for the product. |
productListItems.name | The display name or human-readable name of the product. |
productListItems.priceTotal | The total price for the product line item. |
productListItems.quantity | The number of product units in the cart. |
productListItems.discountAmount | Indicates the discount amount applied. |
productListItems.currencyCode | The ISO 4217 currency code used, such as USD or EUR . |
productListItems.selectedOptions | Field used for a configurable product. |
productListItems.selectedOptions.attribute | Identifies an attribute of the configurable product, such as size or color . |
productListItems.selectedOptions.value | Identifies the value of the attribute such as small or black . |
removeFromRequisitionList
Description | XDM event name |
---|---|
Triggered when a shopper removes a product from a requisition list. | commerce.requisitionListRemovals |
Data collected from removeFromRequisitionList
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
commerce.requsitionListRemovals | Indicates removal of one or more products from a requisition list. |
commerce.requisitionList | The properties of the requisition list created by the customer. |
commerce.requisitionList.ID | Unique identifier of the requisition list. |
commerce.requisitionList.name | Name of the requisition list specified by the customer. |
commerce.requisitionList.description | Description of the requisition list specified by the customer. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |
productListItems | An array of products that were added to the requisition list. |
productListItems.SKU | Stock Keeping Unit. The unique identifier for the product. |
productListItems.name | The display name or human-readable name of the product. |
productListItems.priceTotal | The total price for the product line item. |
productListItems.quantity | The number of product units in the cart. |
productListItems.discountAmount | Indicates the discount amount applied. |
productListItems.currencyCode | The ISO 4217 currency code used, such as USD or EUR . |
productListItems.selectedOptions | Field used for a configurable product. |
productListItems.selectedOptions.attribute | Identifies an attribute of the configurable product, such as size or color . |
productListItems.selectedOptions.value | Identifies the value of the attribute such as small or black . |
deleteRequisitionList
Description | XDM event name |
---|---|
Triggered when a shopper deletes a requisition list. | commerce.requisitionListDeletes |
Data collected from deleteRequisitionList
The following table describes the data collected for this event.
Field | Description |
---|---|
channel | Contains information about the source of the data. Both _id and _type contain namespaced values. |
channel._id | The unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web" . |
channel._type | Identifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web" . |
commerce.requisitionListDeletes | Indicates that a requisition list was deleted. |
commerce.requisitionList | The properties of the requisition list created by the customer. |
commerce.requisitionList.ID | Unique identifier of the requisition list. |
commerce.requisitionList.name | Name of the requisition list specified by the customer. |
commerce.requisitionList.description | Description of the requisition list specified by the customer. |
commerce.commerceScope | Indicates where an event occurred (store view, store, website, and so on). |
commerce.commerceScope.environmentID | The environment ID. A 32-digit alphanumeric ID separated by hyphens. |
commerce.commerceScope.storeCode | The unique store code. You can have many stores per website. |
commerce.commerceScope.storeViewCode | The unique store view code. You can have many store views per store. |
commerce.commerceScope.websiteCode | The unique website code. You can have many websites in an environment. |