offer-detail.schema.json

{
    "meta:license": [
        "Copyright 2018 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/experience/offer-management/offer-detail",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Offer Detail",
    "type": "object",
    "meta:abstract": true,
    "meta:extensible": true,
    "meta:extends": [
        "https://ns.adobe.com/experience/decisioning/option-detail"
    ],
    "description": "Offer detail is used to capture the attributes of an offer in a proposition or response. Offers are the decision options in the offer management domain and the offer detail datatype extends the option detail datatype.",
    "definitions": {
        "offer-detail": {
            "properties": {
                "xdm:tags": {
                    "type": "array",
                    "title": "Tags",
                    "description": "The set of tags associated with this offer. The tags are used in offer filter expressions to constrain the overall offer inventory to a topical sub set (category).",
                    "items": {
                        "type": "string",
                        "format": "uri-reference",
                        "description": "An identifier of a tag object. The value is the @id of the tag that is referenced. See tag schema: https://ns.adobe.com/experience/offer-management/tag",
                        "meta:descriptionId": "offer-detail##items##description##3181"
                    },
                    "meta:titleId": "offer-detail##xdm:tags##title##36021",
                    "meta:descriptionId": "offer-detail##xdm:tags##description##92011"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/offer-detail"
        },
        {
            "$ref": "https://ns.adobe.com/experience/decisioning/option-detail"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "offer-detail##title##81661",
    "meta:descriptionId": "offer-detail##description##92311",
    "examples": [
        {
            "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4",
            "xdm:name": "Beach Vacations",
            "xdm:tags": [
                "xcore:tag:f68535bc217322e",
                "xcore:tag:f66f67dbe6d6ee1"
            ],
            "xdm:characteristics": {
                "cost": "$2400",
                "inventoryId": "BORA04",
                "country": "French Polynesia"
            }
        }
    ]
}