Skip to content

Latest commit

 

History

History
433 lines (221 loc) · 13.6 KB

productlistitem.schema.md

File metadata and controls

433 lines (221 loc) · 13.6 KB
Raw

Adobe Analytics extension to XDM Product List Item Schema

https://ns.adobe.com/experience/analytics/productlistitem

XDM Product List Item extension properties specific to Adobe Analytics that implements Merchandizing support.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted adobe/experience/analytics/productlistitem.schema.json

Schema Hierarchy

Adobe Analytics extension to XDM Product List Item Properties

Property Type Required Defined by
@id string Optional Product list item
https://ns.adobe.com/experience/analytics/customDimensions customDimensions.schema Optional Adobe Analytics extension to XDM Product List Item (this schema)
https://ns.adobe.com/experience/analytics/event101to200 event101to200.schema Optional Adobe Analytics Custom Events
https://ns.adobe.com/experience/analytics/event1to100 event1to100.schema Optional Adobe Analytics Custom Events
https://ns.adobe.com/experience/analytics/event201to300 event201to300.schema Optional Adobe Analytics Custom Events
https://ns.adobe.com/experience/analytics/event301to400 event301to400.schema Optional Adobe Analytics Custom Events
https://ns.adobe.com/experience/analytics/event401to500 event401to500.schema Optional Adobe Analytics Custom Events
https://ns.adobe.com/experience/analytics/event501to600 event501to600.schema Optional Adobe Analytics Custom Events
https://ns.adobe.com/experience/analytics/event601to700 event601to700.schema Optional Adobe Analytics Custom Events
https://ns.adobe.com/experience/analytics/event701to800 event701to800.schema Optional Adobe Analytics Custom Events
https://ns.adobe.com/experience/analytics/event801to900 event801to900.schema Optional Adobe Analytics Custom Events
https://ns.adobe.com/experience/analytics/event901to1000 event901to1000.schema Optional Adobe Analytics Custom Events
xdm:SKU string Optional Product list item
xdm:currencyCode string Optional Product list item
xdm:name string Optional Product list item
xdm:priceTotal number Optional Product list item
xdm:product string Optional Product list item
xdm:productAddMethod string Optional Product list item
xdm:quantity integer Optional Product list item
xdm:unitOfMeasureCode string Optional Product list item
* any Additional this schema allows additional properties

@id

Line item ID.

The line item identifier for this product entry. The product itself is identified through xdm:product.

@id

@id Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

https://ns.adobe.com/experience/analytics/customDimensions

Merchandizing Custom Dimensions

https://ns.adobe.com/experience/analytics/customDimensions

  • is optional
  • type: customDimensions.schema
  • defined in this schema

https://ns.adobe.com/experience/analytics/customDimensions Type

https://ns.adobe.com/experience/analytics/event101to200

Event 101 to 200

https://ns.adobe.com/experience/analytics/event101to200

https://ns.adobe.com/experience/analytics/event101to200 Type

https://ns.adobe.com/experience/analytics/event1to100

Event 1 to 100

https://ns.adobe.com/experience/analytics/event1to100

https://ns.adobe.com/experience/analytics/event1to100 Type

https://ns.adobe.com/experience/analytics/event201to300

Event 201 to 300

https://ns.adobe.com/experience/analytics/event201to300

https://ns.adobe.com/experience/analytics/event201to300 Type

https://ns.adobe.com/experience/analytics/event301to400

Event 301 to 400

https://ns.adobe.com/experience/analytics/event301to400

https://ns.adobe.com/experience/analytics/event301to400 Type

https://ns.adobe.com/experience/analytics/event401to500

Event 401 to 500

https://ns.adobe.com/experience/analytics/event401to500

https://ns.adobe.com/experience/analytics/event401to500 Type

https://ns.adobe.com/experience/analytics/event501to600

Event 501 to 600

https://ns.adobe.com/experience/analytics/event501to600

https://ns.adobe.com/experience/analytics/event501to600 Type

https://ns.adobe.com/experience/analytics/event601to700

Event 601 to 700

https://ns.adobe.com/experience/analytics/event601to700

https://ns.adobe.com/experience/analytics/event601to700 Type

https://ns.adobe.com/experience/analytics/event701to800

Event 701 to 800

https://ns.adobe.com/experience/analytics/event701to800

https://ns.adobe.com/experience/analytics/event701to800 Type

https://ns.adobe.com/experience/analytics/event801to900

Event 801 to 900

https://ns.adobe.com/experience/analytics/event801to900

https://ns.adobe.com/experience/analytics/event801to900 Type

https://ns.adobe.com/experience/analytics/event901to1000

Event 901 to 1000

https://ns.adobe.com/experience/analytics/event901to1000

https://ns.adobe.com/experience/analytics/event901to1000 Type

xdm:SKU

SKU

Stock keeping unit (SKU), the unique identifier for a product defined by the vendor.

xdm:SKU

xdm:SKU Type

string

xdm:currencyCode

Currency code

The ISO 4217 alphabetic currency code used for pricing the product.

xdm:currencyCode

xdm:currencyCode Type

string

All instances must conform to this regular expression

^[A-Z]{3}$
  • test example: USD
  • test example: EUR

xdm:currencyCode Examples

"USD"
"EUR"

xdm:name

Name

The display name for the product as presented to the user for this product view.

xdm:name

xdm:name Type

string

xdm:priceTotal

Price total

The total price for the product line item.

xdm:priceTotal

xdm:priceTotal Type

number

xdm:product

Product

The XDM identifier of the product itself.

xdm:product

xdm:product Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:productAddMethod

Product add method

The method that was used to add a product item to the list by the visitor. Set with product list add metrics.

xdm:productAddMethod

xdm:productAddMethod Type

string

xdm:quantity

Quantity

The number of units the customer has indicated they require of the product.

xdm:quantity

xdm:quantity Type

integer

xdm:unitOfMeasureCode

Product Unit Of Measure Code

Standard unit of measure of the product and or variation and relates the units for the size measurement.

xdm:unitOfMeasureCode

xdm:unitOfMeasureCode Type

string