Complete list of storefront events

The following section lists all the events deployed to your storefront.

addToCart

Description
XDM event name
Triggered when a product is added to the cart or when the quantity of a product in the cart is incremented.
commerce.productListAdds

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.

signIn

Description
XDM event name
Triggered when a shopper attempts to sign in.
userAccount.login
data-variant=info

data-slots=text
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.

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-variant=info

data-slots=text
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.

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-variant=info

data-slots=text
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.

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-variant=info

data-slots=text
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.

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.

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.

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-variant=info

data-slots=text
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.

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-variant=info

data-slots=text
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.

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.

searchProductClick

Description
XDM event name
Triggered when a shopper clicks a product in the "search as you type" popover or on the search results page.
Not applicable
data-variant=info

data-slots=text
Search events are not supported on an Adobe Commerce Enterprise Edition with the B2B extension installed.

Data collected from searchProductClick

The following table describes the data collected for this event.

Field
Description
page
schema
storefront
schema
searchResults
schema

searchResultsView

Description
XDM event name
Triggered when results appear in the "search as you type" popover or search results page.
Not applicable
data-variant=info

data-slots=text
Search events are not supported on an Adobe Commerce Enterprise Edition with the B2B extension installed.

Data collected from searchResultsView

The following table describes the data collected for this event.

Field
Description
page
schema
storefront
schema
searchResults
schema

searchSuggestionClick

Description
XDM event name
Triggered when a shopper clicks a product suggestion in the "search as you type" popover.
Not applicable
data-variant=info

data-slots=text
Search events are not supported on an Adobe Commerce Enterprise Edition with the B2B extension installed.

Data collected from searchSuggestionClick

The following table describes the data collected for this event.

Field
Description
page
schema
storefront
schema
searchResults
schema

impression-render

Description
XDM event name
Triggered when the recommendation unit is rendered on the page. If a page has two recommendation units (bought-bought, view-view), then two impression-render events are sent. This event is used to track the metric for impressions.
Not applicable

Data collected from impression-render

The following table describes the data collected for this event.

Field
Description
page
schema
storefront
schema
recommendations
schema

rec-add-to-cart-click

Description
XDM event name
Triggered when the shopper clicks the Add to cart button for an item in the recommendation unit.
Not applicable

Data collected from rec-add-to-cart-click

The following table describes the data collected for this event.

Field
Description
page
schema
storefront
schema
recommendations
schema

rec-click

Description
XDM event name
Triggered when the shopper clicks a product in the recommendation unit.
Not applicable

Data collected from rec-click

The following table describes the data collected for this event.

Field
Description
page
schema
storefront
schema
recommendations
schema

view

Description
XDM event name
Triggered when the recommendation unit becomes at least 50 percent viewable, such as by scrolling down the page. For example, if a recommendation unit has two lines, a view event is sent when one line plus one pixel of the second line becomes visible to the shopper. If the shopper scrolls the page up and down several times, the view event is sent as many times as the shopper sees the whole recommendation unit again on the page.
Not applicable

Data collected from view

The following table describes the data collected for this event.

Field
Description
page
schema
storefront
schema
recommendations
schema