experienceevent-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/experienceevent-commerce",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Commerce Details",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:tags": {
        "industry": [
            "all"
        ]
    },
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/experienceevent"
    ],
    "description": "Commerce data such as product information (SKU, name, quantity), and standard cart operations (order, checkout, abandon).",
    "definitions": {
        "experienceevent-commerce": {
            "properties": {
                "xdm:productListItems": {
                    "title": "Product list items",
                    "type": "array",
                    "description": "A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record.",
                    "items": {
                        "$ref": "https://ns.adobe.com/xdm/content/productlistitem"
                    },
                    "meta:titleId": "experienceevent-commerce##xdm:productListItems##title##38781",
                    "meta:descriptionId": "experienceevent-commerce##xdm:productListItems##description##34691"
                },
                "xdm:commerce": {
                    "title": "Commerce",
                    "$ref": "https://ns.adobe.com/xdm/context/commerce",
                    "description": "Product returns, warranty registration, and shopping cart/order process.",
                    "meta:titleId": "experienceevent-commerce##xdm:commerce##title##36691",
                    "meta:descriptionId": "experienceevent-commerce##xdm:commerce##description##4271"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
        },
        {
            "$ref": "#/definitions/experienceevent-commerce"
        }
    ],
    "meta:status": "stable",
    "meta:createdDate": "2020-08-10",
    "meta:titleId": "experienceevent-commerce##title##83091",
    "meta:descriptionId": "experienceevent-commerce##description##81391",
    "examples": [
        {
            "xdm:productListItems": [
                {
                    "xdm:SKU": "1002352692",
                    "xdm:lineItemId": "12345678",
                    "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light",
                    "xdm:currencyCode": "USD",
                    "xdm:quantity": 1,
                    "xdm:priceTotal": 159
                }
            ],
            "xdm:commerce": {
                "xdm:order": {
                    "xdm:purchaseID": "a8g784hjq1mnp3",
                    "xdm:purchaseOrderNumber": "123456",
                    "xdm:payments": [
                        {
                            "xdm:transactionID": "transactid-a111",
                            "xdm:paymentAmount": 59,
                            "xdm:paymentType": "credit_card",
                            "xdm:currencyCode": "USD"
                        },
                        {
                            "xdm:transactionId": "transactid-a222",
                            "xdm:paymentAmount": 100,
                            "xdm:paymentType": "gift_card",
                            "xdm:currencyCode": "USD"
                        }
                    ],
                    "xdm:currencyCode": "USD",
                    "xdm:priceTotal": 159
                },
                "xdm:purchases": {
                    "xdm:value": 1
                }
            }
        }
    ]
}