commerce.schema.json

{
  "meta:license": [
    "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$id": "https://ns.adobe.com/xdm/context/commerce",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Commerce",
  "type": "object",
  "meta:extensible": true,
  "description": "The entities related to buying and selling activity.",
  "definitions": {
    "commerce": {
      "properties": {
        "xdm:order": {
          "title": "Order",
          "$ref": "https://ns.adobe.com/xdm/data/order",
          "description": "The placed order for one or more products."
        },
        "xdm:cartAbandons": {
          "$ref": "https://ns.adobe.com/xdm/data/measure",
          "description":
            "A product list has been identified as no longer accessible (e.g purchasable) by the user."
        },
        "xdm:checkouts": {
          "$ref": "https://ns.adobe.com/xdm/data/measure",
          "description":
            "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:productListAdds": {
          "$ref": "https://ns.adobe.com/xdm/data/measure",
          "description":
            "Addition of a product to the product list. Example a product is added to a shopping cart."
        },
        "xdm:productListOpens": {
          "$ref": "https://ns.adobe.com/xdm/data/measure",
          "description":
            "Initializations of a new product list. Example a shopping cart is created."
        },
        "xdm:productListRemovals": {
          "$ref": "https://ns.adobe.com/xdm/data/measure",
          "description":
            "Removal(s) of a product entry from a product list. Example a product is removed from a shopping cart."
        },
        "xdm:productListReopens": {
          "$ref": "https://ns.adobe.com/xdm/data/measure",
          "description":
            "A product list that was no longer accessible(abandoned) has been re-activated by the user. Example via a re-marketing activity."
        },
        "xdm:productListViews": {
          "$ref": "https://ns.adobe.com/xdm/data/measure",
          "description": "View(s) of a product-list has occurred."
        },
        "xdm:productViews": {
          "$ref": "https://ns.adobe.com/xdm/data/measure",
          "description": "View(s) of a product have occurred."
        },
        "xdm:purchases": {
          "$ref": "https://ns.adobe.com/xdm/data/measure",
          "description":
            "An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced."
        },
        "xdm:saveForLaters": {
          "$ref": "https://ns.adobe.com/xdm/data/measure",
          "description":
            "Product list is saved for future use. Example a product wish list."
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "#/definitions/commerce"
    }
  ],
  "meta:status": "stabilizing"
}