Data collected from addToCart

The following table describes the data collected for this event.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
commerce.productListAddsIndicates if a product was added to a shopping cart. A value of 1 indicates that a product was added.
commerce.cart.cartIDThe unique ID that identifies the customer’s cart.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.
productListItemsAn array of products that were added to the shopping cart.
productListItems.SKUStock Keeping Unit. The unique identifier for the product.
productListItems.nameThe display name or human-readable name of the product.
productListItems.priceTotalThe total price for the product line item.
productListItems.quantityThe number of product units in the cart.
productListItems.discountAmountIndicates the discount amount applied.
productListItems.currencyCodeThe ISO 4217 currency code used, such as USD or EUR.
productListItems.productImageUrlMain image URL of the product.
productListItems.selectedOptionsField used for a configurable product.
productListItems.selectedOptions.attributeIdentifies an attribute of the configurable product, such as size or color.
productListItems.selectedOptions.valueIdentifies the value of the attribute such as small or black.

openCart

DescriptionXDM 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.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
commerce.productListOpensIndicates if a cart was created. A value of 1 indicates that a cart was created.
commerce.cart.cartIDThe unique ID that identifies the customer’s cart.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.
productListItemsAn array of products that were added to the shopping cart.
productListItems.SKUStock Keeping Unit. The unique identifier for the product.
productListItems.nameThe display name or human-readable name of the product.
productListItems.priceTotalThe total price for the product line item.
productListItems.quantityThe number of product units in the cart.
productListItems.discountAmountIndicates the discount amount applied.
productListItems.currencyCodeThe ISO 4217 currency code used, such as USD or EUR.
productListItems.productImageUrlMain image URL of the product.
productListItems.selectedOptionsField used for a configurable product.
productListItems.selectedOptions.attributeIdentifies an attribute of the configurable product, such as size or color.
productListItems.selectedOptions.valueIdentifies the value of the attribute such as small or black.

removeFromCart

DescriptionXDM 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.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
commerce.productListRemovalsIndicates if a product was removed from the cart. A value of 1 indicates that a product was removed from the cart.
commerce.cart.cartIDThe unique ID that identifies the customer’s cart.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.
productListItemsAn array of products that were added to the shopping cart.
productListItems.SKUStock Keeping Unit. The unique identifier for the product.
productListItems.nameThe display name or human-readable name of the product.
productListItems.priceTotalThe total price for the product line item.
productListItems.quantityThe number of product units in the cart.
productListItems.discountAmountIndicates the discount amount applied.
productListItems.currencyCodeThe ISO 4217 currency code used, such as USD or EUR.
productListItems.productImageUrlMain image URL of the product.
productListItems.selectedOptionsField used for a configurable product.
productListItems.selectedOptions.attributeIdentifies an attribute of the configurable product, such as size or color.
productListItems.selectedOptions.valueIdentifies the value of the attribute such as small or black.

shoppingCartView

DescriptionXDM event name
Triggered when any cart page loads.commerce.productListViews

Data collected from shoppingCartView

The following table describes the data collected for this event.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
commerce.productListViewsIndicates if a product list was viewed.
commerce.cart.cartIDThe unique ID that identifies the customer’s cart.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.
commerce.orderContains information about the pending order for one or more products.
commerce.order.discountAmountIndicates the discount amount applied to the whole order.
productListItemsAn array of products that were added to the shopping cart.
productListItems.SKUStock Keeping Unit. The unique identifier for the product.
productListItems.nameThe display name or human-readable name of the product.
productListItems.priceTotalThe total price for the product line item.
productListItems.quantityThe number of product units in the cart.
productListItems.discountAmountIndicates the discount amount applied.
productListItems.currencyCodeThe ISO 4217 currency code used, such as USD or EUR.
productListItems.productImageUrlMain image URL of the product.
productListItems.selectedOptionsField used for a configurable product.
productListItems.selectedOptions.attributeIdentifies an attribute of the configurable product, such as size or color.
productListItems.selectedOptions.valueIdentifies the value of the attribute such as small or black.

pageView

DescriptionXDM event name
Triggered when any page loads.web.webpagedetails.pageViews

Data collected from pageView

The following table describes the data collected for this event.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
web.webPageDetails.pageViewsIndicates if a page was loaded. A value of 1 indicates that the page was loaded.
web.webPageDetails.URLThe 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.nameThe 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.URLThe URL of the webpage a shopper visited before clicking a link to your site.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.

productPageView

DescriptionXDM event name
Triggered when any product page loads.commerce.productViews

Data collected from productPageView

The following table describes the data collected for this event.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
commerce.productViewsIndicates if the product was viewed.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.
productListItemsAn array of products that were added to the shopping cart.
productListItems.SKUStock Keeping Unit. The unique identifier for the product.
productListItems.nameThe display name or human-readable name of the product.
productListItems.priceTotalThe total price for the product line item.
productListItems.quantityThe number of product units in the cart.
productListItems.discountAmountIndicates the discount amount applied.
productListItems.currencyCodeThe ISO 4217 currency code used, such as USD or EUR.
productListItems.productImageUrlMain image URL of the product.
productListItems.selectedOptionsField used for a configurable product.
productListItems.selectedOptions.attributeIdentifies an attribute of the configurable product, such as size or color.
productListItems.selectedOptions.valueIdentifies the value of the attribute such as small or black.

startCheckout

DescriptionXDM 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.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
commerce.checkoutsIndicates if an action occurred during the checkout process.
commerce.cart.cartIDThe unique ID that identifies the customer’s cart.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.
productListItemsAn array of products that were added to the shopping cart.
productListItems.SKUStock Keeping Unit. The unique identifier for the product.
productListItems.nameThe display name or human-readable name of the product.
productListItems.priceTotalThe total price for the product line item.
productListItems.quantityThe number of product units in the cart.
productListItems.discountAmountIndicates the discount amount applied.
productListItems.currencyCodeThe ISO 4217 currency code used, such as USD or EUR.
productListItems.productImageUrlMain image URL of the product.
productListItems.selectedOptionsField used for a configurable product.
productListItems.selectedOptions.attributeIdentifies an attribute of the configurable product, such as size or color.
productListItems.selectedOptions.valueIdentifies the value of the attribute such as small or black.

completeCheckout

DescriptionXDM 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.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
commerce.purchasesIndicates if an order has been accepted.
commerce.orderContains information about the placed order for one or more products.
commerce.order.purchaseIDUnique identifier assigned by the seller for this purchase or contract. There is no guarantee that the ID is unique.
commerce.order.paymentsThe list of payments for this order.
commerce.order.payments.paymentTransactionIDUnique identifier for this payment transaction.
commerce.order.payments.paymentAmountThe value of the payment.
commerce.order.payments.paymentTypeThe 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.currencyCodeThe ISO 4217 currency code used, such as USD or EUR.
commerce.order.taxAmountThe tax amount paid by the buyer as part of the final payment.
commerce.order.discountAmountIndicates the discount amount applied to the whole order.
commerce.order.createdDateThe time and date when a new order is created in the commerce system. For example, 2022-10-15T20:20:39+00:00.
commerce.shippingShipping details for one or more products.
commerce.shipping.shippingMethodThe method of shipping chosen by the customer, such as standard delivery, expedited delivery, pick up in store, and so on.
commerce.shipping.shippingAmountThe amount the customer had to pay for shipping.
commerce.shipping.currencyCodeThe ISO 4217 currency code used, such as USD or EUR.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.
personalEmailA personal email address.
personalEmail.addressThe technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards.
productListItemsAn array of products that were added to the shopping cart.
productListItems.SKUStock Keeping Unit. The unique identifier for the product.
productListItems.nameThe display name or human-readable name of the product.
productListItems.priceTotalThe total price for the product line item.
productListItems.quantityThe number of product units in the cart.
productListItems.discountAmountIndicates the discount amount applied.
productListItems.productImageUrlMain image URL of the product.
productListItems.selectedOptionsField used for a configurable product.
productListItems.selectedOptions.attributeIdentifies an attribute of the configurable product, such as size or color.
productListItems.selectedOptions.valueIdentifies 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

DescriptionXDM event name
Triggered when a shopper attempts to sign in.userAccount.login
NOTE
This event is triggered when the specific action is attempted. It does not indicate that the action was successful.

Data collected from signIn

The following table describes the data collected for this event.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
personAn individual actor, contact, or owner.
person.accountIDCaptures the user account ID.
person.accountTypeCaptures the user account type, such as Personal or Company, if applicable.
person.personalEmailIDThe technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards.
personalEmailCaptures contact details - an e-mail and associated information.
personalEmail.addressThe technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards.
userAccountIndicates any loyalty details, preferences, login processes, and other account preferences.
userAccount.loginIndicates if a visitor attempted to log in.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.

signOut

DescriptionXDM event name
Triggered when a shopper attempts to sign out.userAccount.logout
NOTE
This event is triggered when the specific action is attempted. It does not indicate that the action was successful.

Data collected from signOut

The following table describes the data collected for this event.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
userAccountIndicates any loyalty details, preferences, login processes, and other account preferences.
userAccount.logoutIndicates if a visitor attempted to log out.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.

createAccount

DescriptionXDM event name
Triggered when a shopper attempts to create an account.userAccount.createProfile
NOTE
This event is triggered when the specific action is attempted. It does not indicate that the action was successful.

Data collected from createAccount

The following table describes the data collected for this event.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
personAn individual actor, contact, or owner.
person.accountIDCaptures the user account ID.
person.accountTypeCaptures the user account type, such as Personal or Company, if applicable.
person.personalEmailIDThe technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards.
personalEmailCaptures contact details - an e-mail and associated information.
personalEmail.addressThe technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards.
userAccountIndicates any loyalty details, preferences, login processes, and other account preferences.
userAccount.updateProfileIndicates if a user has updated their account profile.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.

editAccount

DescriptionXDM event name
Triggered when a shopper attempts to edit an account.userAccount.updateProfile
NOTE
This event is triggered when the specific action is attempted. It does not indicate that the action was successful.

Data collected from editAccount

The following table describes the data collected for this event.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
personAn individual actor, contact, or owner.
person.accountIDCaptures the user account ID.
person.accountTypeCaptures the user account type, such as Personal or Company, if applicable.
person.personalEmailIDThe technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards.
personalEmailCaptures contact details - an e-mail and associated information.
personalEmail.addressThe technical address, for example, name@domain.com as commonly defined in RFC2822 and subsequent standards.
userAccountIndicates any loyalty details, preferences, login processes, and other account preferences.
userAccount.updateProfileIndicates if a user has updated their account profile.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe 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

DescriptionXDM 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
NOTE
Search events are not supported on an Adobe Commerce Enterprise Edition with the B2B extension installed.

Data collected from searchRequestSent

The following table describes the data collected for this event.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
searchRequestIndicates if a search request was sent.
searchRequest.idThe unique ID for this particular search request.
searchRequest.valueThe quantifiable value of the request.
siteSearchContains information about the search.
siteSearch.filterIndicates 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.isRangeWhen true, values indicate endpoints of an acceptable range of values.
siteSearch.filter.valueAttribute value used to determine which items are included in search results.
siteSearch.sortIndicates how search results should be sorted.
siteSearch.sort.attribute (sort)An attribute used to sort items in search results.
siteSearch.sort.orderThe order in which to return search results.
siteSearch.queryThe terms searched for.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.

searchResponseReceived

DescriptionXDM event name
Triggered when Live Search returns results for the “search as you type” popover or search results page.searchResponse
NOTE
Search events are not supported on an Adobe Commerce Enterprise Edition with the B2B extension installed.

Data collected from searchResponseReceived

The following table describes the data collected for this event.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
searchResponseIndicates if a search response has been received.
searchResponse.idThe unique ID for this particular search response.
searchResponse.valueThe quantifiable value of the response.
siteSearch.numberOfResultsThe number of products returned.
siteSearch.suggestionsAn array of strings that include the names of products and categories that exist in the catalog that are similar to the search query.
productListItemsAn array of products that were added to the shopping cart.
productListItems.SKUStock Keeping Unit. The unique identifier for the product.
productListItems.nameThe display name or human-readable name of the product.
productListItems.productImageUrlMain image URL of the product.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.

B2B events

B2B for Adobe Commerce For B2B merchants, you must install the 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

DescriptionXDM 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.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
commerce.requisitionListOpensIndicates initialization of a new requisition list.
commerce.requisitionListThe properties of the requisition list created by the customer.
commerce.requisitionList.IDUnique identifier of the requisition list.
commerce.requisitionList.nameName of the requisition list specified by the customer.
commerce.requisitionList.descriptionDescription of the requisition list specified by the customer.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.

addToRequisitionList

DescriptionXDM 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.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
commerce.requisitionListAddsIndicates addition of one or more products to a requisition list.
commerce.requisitionListThe properties of the requisition list created by the customer.
commerce.requisitionList.IDUnique identifier of the requisition list.
commerce.requisitionList.nameName of the requisition list specified by the customer.
commerce.requisitionList.descriptionDescription of the requisition list specified by the customer.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.
productListItemsAn array of products that were added to the requisition list.
productListItems.SKUStock Keeping Unit. The unique identifier for the product.
productListItems.nameThe display name or human-readable name of the product.
productListItems.priceTotalThe total price for the product line item.
productListItems.quantityThe number of product units in the cart.
productListItems.discountAmountIndicates the discount amount applied.
productListItems.currencyCodeThe ISO 4217 currency code used, such as USD or EUR.
productListItems.selectedOptionsField used for a configurable product.
productListItems.selectedOptions.attributeIdentifies an attribute of the configurable product, such as size or color.
productListItems.selectedOptions.valueIdentifies the value of the attribute such as small or black.

removeFromRequisitionList

DescriptionXDM 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.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
commerce.requsitionListRemovalsIndicates removal of one or more products from a requisition list.
commerce.requisitionListThe properties of the requisition list created by the customer.
commerce.requisitionList.IDUnique identifier of the requisition list.
commerce.requisitionList.nameName of the requisition list specified by the customer.
commerce.requisitionList.descriptionDescription of the requisition list specified by the customer.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.
productListItemsAn array of products that were added to the requisition list.
productListItems.SKUStock Keeping Unit. The unique identifier for the product.
productListItems.nameThe display name or human-readable name of the product.
productListItems.priceTotalThe total price for the product line item.
productListItems.quantityThe number of product units in the cart.
productListItems.discountAmountIndicates the discount amount applied.
productListItems.currencyCodeThe ISO 4217 currency code used, such as USD or EUR.
productListItems.selectedOptionsField used for a configurable product.
productListItems.selectedOptions.attributeIdentifies an attribute of the configurable product, such as size or color.
productListItems.selectedOptions.valueIdentifies the value of the attribute such as small or black.

deleteRequisitionList

DescriptionXDM 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.

FieldDescription
channelContains information about the source of the data. Both _id and _type contain namespaced values.
channel._idThe unique identifier of the channel, such as "https://ns.adobe.com/xdm/channels/web".
channel._typeIdentifies the source of the channel data, such as "https://ns.adobe.com/xdm/channel-types/web".
commerce.requisitionListDeletesIndicates that a requisition list was deleted.
commerce.requisitionListThe properties of the requisition list created by the customer.
commerce.requisitionList.IDUnique identifier of the requisition list.
commerce.requisitionList.nameName of the requisition list specified by the customer.
commerce.requisitionList.descriptionDescription of the requisition list specified by the customer.
commerce.commerceScopeIndicates where an event occurred (store view, store, website, and so on).
commerce.commerceScope.environmentIDThe environment ID. A 32-digit alphanumeric ID separated by hyphens.
commerce.commerceScope.storeCodeThe unique store code. You can have many stores per website.
commerce.commerceScope.storeViewCodeThe unique store view code. You can have many store views per store.
commerce.commerceScope.websiteCodeThe unique website code. You can have many websites in an environment.
Previous pageIntegrate the Adobe Experience Platform Mobile SDK with Commerce
Next pageBack Office Events