Skip to content

Loyalty Challenge Event Schema #2068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iewilliam wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Loyalty Challenge Event Schema #2068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2cb0027
Loyalty Challenge event schema and examples
iewilliam Nov 13, 2025
43ad82f
add local time offset and remove the category map
iewilliam Nov 25, 2025
fe1f1c0
quantity should be number
iewilliam Nov 25, 2025
1fdcf26
Merge branch 'master' into loyalty_event_schema
iewilliam Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions extensions/adobe/experience/ajo/loyalty/loyalty-challenge-event-details.example.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"_experience": {
"ajo": {
"loyalty": {
"challenge": {
"locationId": "store-123",
"transactionId": "txn-456789",
"localTimezoneOffset": 420,
"itemList": [
{
"unitPrice": 29.99,
"quantity": 2,
"itemName": "Coffee Beans",
"itemSet": [
"sku-200-123",
"category-200"
]
},
{
"unitPrice": 12.50,
"quantity": 1,
"itemName": "Travel Mug",
"itemSet": [
"sku-500-789",
"category-500"
]
}
]
}
}
}
}
}

27 changes: 27 additions & 0 deletions extensions/adobe/experience/ajo/loyalty/loyalty-challenge-event-details.example.2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"_experience": {
"ajo": {
"loyalty": {
"challenge": {
"locationId": "online-store",
"transactionId": "txn-789012",
"itemList": [
{
"unitPrice": 150.00,
"quantity": 1,
"itemName": "Premium Membership",
"itemMap": {
"duration": "annual",
"tier": "gold"
},
"itemSet": [
"membership",
"premium"
]
}
]
}
}
}
}
}
95 changes: 95 additions & 0 deletions extensions/adobe/experience/ajo/loyalty/loyalty-challenge-event-details.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
{
"meta:license": [
"Copyright 2025 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/ajo/loyalty/loyalty-challenge-event-details",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Loyalty Challenge Event Details",
"type": "object",
"meta:extensible": false,
"meta:abstract": true,
"meta:intendedToExtend": [
"https://ns.adobe.com/xdm/context/experienceevent"
],
"description": "Experience event field group for loyalty events to be processed by Loyalty Challenge Service.",
"definitions": {
"loyalty-challenge-event-details": {
"properties": {
"https://ns.adobe.com/experience/ajo/loyalty/challenge": {
"title": "Challenge",
"type": "object",
"description": "Loyalty challenge event details.",
"properties": {
"https://ns.adobe.com/experience/ajo/loyalty/itemList": {
Copy link
Collaborator

@anandphatak anandphatak Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pl. change field name to "xdm:itemList", and every subsequent field in this hierarchy and its children. Only the outermost field should include the https://ns.adobe.com/experience/ajo/loyalty part, which is https://ns.adobe.com/experience/ajo/loyalty/challenge in this case.

"title": "Item List",
"type": "array",
"description": "List of items involved in the loyalty transaction.",
"items": {
"type": "object",
"properties": {
"https://ns.adobe.com/experience/ajo/loyalty/unitPrice": {
"title": "Unit Price",
"type": "number",
"description": "The price per unit of the item."
},
"https://ns.adobe.com/experience/ajo/loyalty/quantity": {
"title": "Quantity",
"type": "number",
"description": "The quantity of the item."
},
"https://ns.adobe.com/experience/ajo/loyalty/itemName": {
"title": "Item Name",
"type": "string",
"description": "The name of the item.",
"minLength": 1
},
"https://ns.adobe.com/experience/ajo/loyalty/itemSet": {
"title": "Item Set",
"type": "array",
"description": "Properties/tags of the item.",
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1
}
}
}
}
},
"https://ns.adobe.com/experience/ajo/loyalty/locationId": {
"title": "Location ID",
"type": "string",
"description": "The identifier for the location where the loyalty transaction occurred.",
"minLength": 1
},
"https://ns.adobe.com/experience/ajo/loyalty/transactionId": {
"title": "Transaction ID",
"type": "string",
"description": "The unique identifier for the loyalty transaction.",
"minLength": 1
},
"https://ns.adobe.com/experience/ajo/loyalty/localTimezoneOffset": {
"title": "Local Timezone Offset",
"type": "integer",
"description": "The current, local time zone offset in minutes from UTC for the location of this event. This will include the current DST offset if applicable.",
"minimum": -2147483648,
"maximum": 2147483647
}

}
}
},
"required": []
}
},
"allOf": [
{
"$ref": "#/definitions/loyalty-challenge-event-details"
}
],
"meta:status": "experimental"
}