experienceevent-upsell-details.schema.json

{
    "meta:license": [
        "Copyright 2020 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/mixins/industry-verticals/experienceevent-upsell-details",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Upsell Details",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:tags": {
        "industry": [
            "retail",
            "financial_services",
            "travel_and_hospitality",
            "telecom",
            "automotive",
            "education",
            "high_tech"
        ]
    },
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/experienceevent"
    ],
    "description": "Upsell details such as offer name, type, and ID, as well as transaction details such as type and amount.",
    "definitions": {
        "upsell-details": {
            "properties": {
                "xdm:upsells": {
                    "type": "object",
                    "description": "Upsell information including impressions and transactions associated with upsells.",
                    "properties": {
                        "xdm:upsellSteps": {
                            "title": "Upsell Steps",
                            "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage",
                            "description": "Extension of toolUsage data type.",
                            "meta:status": "deprecated",
                            "meta:titleId": "experienceevent-upsell-details##xdm:upsellSteps##title##3281",
                            "meta:descriptionId": "experienceevent-upsell-details##xdm:upsellSteps##description##55831"
                        },
                        "xdm:upsellImpressions": {
                            "title": "Upsell Impressions",
                            "type": "array",
                            "items": {
                                "$ref": "https://ns.adobe.com/xdm/datatypes/impressions"
                            },
                            "description": "Array of the impressions data type.",
                            "meta:titleId": "experienceevent-upsell-details##xdm:upsellImpressions##title##381",
                            "meta:descriptionId": "experienceevent-upsell-details##xdm:upsellImpressions##description##27091"
                        },
                        "xdm:upsellTransaction": {
                            "title": "Upsell Transaction",
                            "$ref": "https://ns.adobe.com/xdm/datatypes/transaction",
                            "description": "Extension of transaction data type.",
                            "meta:titleId": "experienceevent-upsell-details##xdm:upsellTransaction##title##29501",
                            "meta:descriptionId": "experienceevent-upsell-details##xdm:upsellTransaction##description##99481"
                        }
                    },
                    "meta:descriptionId": "experienceevent-upsell-details##xdm:upsells##description##93591"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/upsell-details"
        }
    ],
    "meta:status": "stable",
    "meta:createdDate": "2021-02-02",
    "meta:titleId": "experienceevent-upsell-details##title##14631",
    "meta:descriptionId": "experienceevent-upsell-details##description##98371",
    "examples": [
        {
            "xdm:upsells": {
                "xdm:upsellTransaction": {
                    "xdm:transaction": {
                        "xdm:transactionID": "T10291832",
                        "xdm:transactionDate": "2021-01-0715:52:25+00:00",
                        "xdm:transactionType": "transfer"
                    }
                }
            }
        }
    ]
}