Skip to content

Latest commit

 

History

History
283 lines (154 loc) · 6.58 KB

commerce.schema.md

File metadata and controls

283 lines (154 loc) · 6.58 KB

Commerce Schema

https://ns.adobe.com/xdm/context/commerce

The records related to buying and selling activity.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stabilizing No Forbidden Permitted context/commerce.schema.json

Schema Hierarchy

  • Commerce https://ns.adobe.com/xdm/context/commerce

Commerce Example

{
  "xdm:order": {
    "xdm:purchaseID": "a8g784hjq1mnp3",
    "xdm:purchaseOrderNumber": "123456",
    "xdm:payments": [
      {
        "xdm:transactionID": "transactid-a111",
        "xdm:paymentAmount": 899.99,
        "xdm:paymentType": "credit_card",
        "xdm:currencyCode": "USD"
      },
      {
        "xdm:transactionID": "transactid-a222",
        "xdm:paymentAmount": 99.99,
        "xdm:paymentType": "gift_card",
        "xdm:currencyCode": "USD"
      }
    ],
    "xdm:currencyCode": "USD",
    "xdm:priceTotal": 999.98
  },
  "xdm:purchases": {
    "xdm:value": 1
  }
}

Commerce Properties

Property Type Required Defined by
xdm:cartAbandons Measure Optional Commerce (this schema)
xdm:checkouts Measure Optional Commerce (this schema)
xdm:inStorePurchase Measure Optional Commerce (this schema)
xdm:order Order Optional Commerce (this schema)
xdm:productListAdds Measure Optional Commerce (this schema)
xdm:productListOpens Measure Optional Commerce (this schema)
xdm:productListRemovals Measure Optional Commerce (this schema)
xdm:productListReopens Measure Optional Commerce (this schema)
xdm:productListViews Measure Optional Commerce (this schema)
xdm:productViews Measure Optional Commerce (this schema)
xdm:purchases Measure Optional Commerce (this schema)
xdm:saveForLaters Measure Optional Commerce (this schema)
* any Additional this schema allows additional properties

xdm:cartAbandons

A product list has been identified as no longer accessible or purchasable by the user.

xdm:cartAbandons

  • is optional
  • type: Measure
  • defined in this schema

xdm:cartAbandons Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:checkouts

An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order.

xdm:checkouts

  • is optional
  • type: Measure
  • defined in this schema

xdm:checkouts Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:inStorePurchase

'inStore' purchase is saved for analytics use.

xdm:inStorePurchase

  • is optional
  • type: Measure
  • defined in this schema

xdm:inStorePurchase Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:order

Order

The placed order for one or more products.

xdm:order

  • is optional
  • type: Order
  • defined in this schema

xdm:order Type

  • Order – https://ns.adobe.com/xdm/data/order

xdm:productListAdds

Addition of a product to the product list, for example a product is added to a shopping cart.

xdm:productListAdds

  • is optional
  • type: Measure
  • defined in this schema

xdm:productListAdds Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:productListOpens

Initializations of a new product list, for example a shopping cart is created.

xdm:productListOpens

  • is optional
  • type: Measure
  • defined in this schema

xdm:productListOpens Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:productListRemovals

Removal or removals of a product entry from a product list, for example a product is removed from a shopping cart.

xdm:productListRemovals

  • is optional
  • type: Measure
  • defined in this schema

xdm:productListRemovals Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:productListReopens

A product list that was no longer accessible (abandoned) has been re-activated by the user. Example via a re-marketing activity.

xdm:productListReopens

  • is optional
  • type: Measure
  • defined in this schema

xdm:productListReopens Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:productListViews

View or views of a product-list has occurred.

xdm:productListViews

  • is optional
  • type: Measure
  • defined in this schema

xdm:productListViews Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:productViews

View or views of a product have occurred.

xdm:productViews

  • is optional
  • type: Measure
  • defined in this schema

xdm:productViews Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:purchases

An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced.

xdm:purchases

  • is optional
  • type: Measure
  • defined in this schema

xdm:purchases Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:saveForLaters

Product list is saved for future use, for example a product wish list.

xdm:saveForLaters

  • is optional
  • type: Measure
  • defined in this schema

xdm:saveForLaters Type

  • Measure – https://ns.adobe.com/xdm/data/measure