🧩 Root Key: application​
🔧 Operation: application.article.message.article/create/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/create/v1.payload.components/schemas/article_create_v1.properties.payload.properties.articles.items.properties.set - New Schema:
{
"type": "object",
"description": "Configuration of the set, if the product is sold as one.",
"properties": {
"quantity": {
"type": "integer",
"description": "Total number of items in the set."
},
"size_distribution": {
"type": "object",
"description": "Size distribution details within the set.",
"properties": {
"sizes": {
"type": "array",
"description": "List of sizes and their respective quantities.",
"items": {
"type": "object",
"properties": {
"size": {
"type": "string",
"description": "Label of the size (e.g., S, M, L)."
},
"pieces": {
"type": "integer",
"description": "Quantity of pieces for the corresponding size."
}
}
}
}
}
}
}
}
🔧 Operation: application.article.message.article/create/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/create/v1.payload.components/schemas/article_create_v1.properties.payload.properties.articles.items.properties.expiration_date - New Schema:
{
"type": "string",
"description": "Expiration or validity end date for the product."
}
🔧 Operation: application.article.message.article/create/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/create/v1.payload.components/schemas/article_create_v1.properties.payload.properties.articles.items.properties.trace_id - New Schema:
{
"type": "string",
"nullable": true,
"description": "Trace ID used for event tracking or debugging."
}
🔧 Operation: application.article.message.article/create/v1​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/create/v1.payload.components/schemas/article_create_v1.properties.payload.properties.articles.items.properties.discount_meta - New Schema:
{
"type": "object",
"description": "Details of any discounts, including start/end times and countdown timers.",
"properties": {
"start": {
"type": "string",
"format": "date-time",
"description": "Start date and time of the discount period."
},
"end": {
"type": "string",
"format": "date-time",
"description": "End date and time of the discount period."
},
"timer": {
"type": "boolean",
"description": "Indicates if a countdown timer is active for the discount."
}
}
}
🔧 Operation: application.article.message.article/create/v1​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/create/v1.payload.components/schemas/article_create_v1.properties.payload.properties.articles.items.properties.stage - New Schema:
{
"type": "string",
"description": "Current stage of the product lifecycle (e.g., verified)."
}
🔧 Operation: application.article.message.article/create/v1​
🔹 Entry 6​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/create/v1.payload.components/schemas/article_create_v1.properties.payload.properties.articles.items.properties.trader - New Schema:
{
"type": "array",
"description": "List of traders associated with the product.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Trader's name."
},
"type": {
"type": "string",
"enum": [
"Manufacturer",
"Importer",
"Packer",
"Marketer"
],
"description": "Indicates the trader type."
},
"address": {
"type": "array",
"description": "List of addresses associated with the trader.",
"items": {
"type": "string"
}
}
}
}
}
🔧 Operation: application.article.message.article/create/v1​
🔹 Entry 7​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/create/v1.payload.components/schemas/article_create_v1.properties.payload.properties.articles.items.properties._custom_json - New Schema:
{
"type": "object",
"description": "Custom JSON data associated with the product."
}
🔧 Operation: application.article.message.article/create/v1​
🔹 Entry 8​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/create/v1.payload.components/schemas/article_create_v1.properties.payload.properties.articles.items.properties.tags - New Schema:
{
"type": "array",
"description": "Tags or labels assigned to the product for categorization or search purposes.",
"items": {
"type": "string"
}
}
🔧 Operation: application.article.message.article/delete/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/delete/v1.payload.components/schemas/article_delete_v1.properties.payload.properties.articles.items.properties.weight.properties.is_default - New Schema:
{
"type": "boolean",
"description": "Indicates if this is the default weight configuration."
}
🔧 Operation: application.article.message.article/delete/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/delete/v1.payload.components/schemas/article_delete_v1.properties.payload.properties.articles.items.properties.price.properties.updated_at - New Schema:
{
"type": "string",
"format": "date-time",
"description": "Date and time when the pricing information was last updated."
}
🔧 Operation: application.article.message.article/delete/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/delete/v1.payload.components/schemas/article_delete_v1.properties.payload.properties.articles.items.properties.dimension.properties.is_default - New Schema:
{
"type": "boolean",
"description": "Indicates if these are the default dimensions."
}
🔧 Operation: application.article.message.article/delete/v1​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/delete/v1.payload.components/schemas/article_delete_v1.properties.payload.properties.articles.items.properties.quantities.properties.order_committed - New Schema:
{
"type": "object",
"description": "Details of committed orders.",
"properties": {
"count": {
"type": "integer",
"description": "Number of units committed to orders."
},
"updated_at": {
"type": "string",
"description": "Timestamp of the last order committed update."
}
}
}
🔧 Operation: application.article.message.article/delete/v1​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/delete/v1.payload.components/schemas/article_delete_v1.properties.payload.properties.articles.items.properties.manufacturer.properties.is_default - New Schema:
{
"type": "boolean",
"description": "Indicates if this is the default manufacturer for the product."
}
🔧 Operation: application.article.message.article/delete/v1​
🔹 Entry 6​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
article.channels.event.messages.article/delete/v1.payload.components/schemas/article_delete_v1.properties.payload.properties.articles.items.properties.discount_applied
🔧 Operation: application.article.message.article/delete/v1​
🔹 Entry 7​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/delete/v1.payload.components/schemas/article_delete_v1.properties.payload.properties.articles.items.properties.set - New Schema:
{
"type": "object",
"description": "Configuration of the set, if the product is sold as one.",
"properties": {
"quantity": {
"type": "integer",
"description": "Total number of items in the set."
},
"size_distribution": {
"type": "object",
"description": "Size distribution details within the set.",
"properties": {
"sizes": {
"type": "array",
"description": "List of sizes and their respective quantities.",
"items": {
"type": "object",
"properties": {
"size": {
"type": "string",
"description": "Label of the size (e.g., S, M, L)."
},
"pieces": {
"type": "integer",
"description": "Quantity of pieces for the corresponding size."
}
}
}
}
}
}
}
}
🔧 Operation: application.article.message.article/delete/v1​
🔹 Entry 8​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/delete/v1.payload.components/schemas/article_delete_v1.properties.payload.properties.articles.items.properties.trader - New Schema:
{
"type": "array",
"description": "List of traders associated with the product.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Trader's name."
},
"type": {
"type": "string",
"enum": [
"Manufacturer",
"Importer",
"Packer",
"Marketer"
],
"description": "Indicates the trader type."
},
"address": {
"type": "array",
"description": "List of addresses associated with the trader.",
"items": {
"type": "string"
}
}
}
}
}
🔧 Operation: application.article.message.article/delete/v1​
🔹 Entry 9​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/delete/v1.payload.components/schemas/article_delete_v1.properties.payload.properties.articles.items.properties._custom_json - New Schema:
{
"type": "object",
"description": "Custom JSON data associated with the product."
}
🔧 Operation: application.article.message.article/delete/v1​
🔹 Entry 10​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/delete/v1.payload.components/schemas/article_delete_v1.properties.payload.properties.articles.items.properties.tags - New Schema:
{
"type": "array",
"description": "Tags or labels assigned to the product for categorization or search purposes.",
"items": {
"type": "string"
}
}
🔧 Operation: application.article.message.article/update/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/update/v1.payload.components/schemas/article_update_v1.properties.payload.properties.articles.items.properties.weight.properties.is_default - New Schema:
{
"type": "boolean",
"description": "Indicates if this is the default weight configuration."
}
🔧 Operation: application.article.message.article/update/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/update/v1.payload.components/schemas/article_update_v1.properties.payload.properties.articles.items.properties.price.properties.updated_at - New Schema:
{
"type": "string",
"format": "date-time",
"description": "Date and time when the pricing information was last updated."
}
🔧 Operation: application.article.message.article/update/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/update/v1.payload.components/schemas/article_update_v1.properties.payload.properties.articles.items.properties.dimension.properties.is_default - New Schema:
{
"type": "boolean",
"description": "Indicates if these are the default dimensions."
}
🔧 Operation: application.article.message.article/update/v1​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/update/v1.payload.components/schemas/article_update_v1.properties.payload.properties.articles.items.properties.quantities.properties.order_committed - New Schema:
{
"type": "object",
"description": "Details of committed orders.",
"properties": {
"count": {
"type": "integer",
"description": "Number of units committed to orders."
},
"updated_at": {
"type": "string",
"description": "Timestamp of the last order committed update."
}
}
}
🔧 Operation: application.article.message.article/update/v1​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/update/v1.payload.components/schemas/article_update_v1.properties.payload.properties.articles.items.properties.manufacturer.properties.is_default - New Schema:
{
"type": "boolean",
"description": "Indicates if this is the default manufacturer for the product."
}
🔧 Operation: application.article.message.article/update/v1​
🔹 Entry 6​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
article.channels.event.messages.article/update/v1.payload.components/schemas/article_update_v1.properties.payload.properties.articles.items.properties.discount_applied
🔧 Operation: application.article.message.article/update/v1​
🔹 Entry 7​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/update/v1.payload.components/schemas/article_update_v1.properties.payload.properties.articles.items.properties.set - New Schema:
{
"type": "object",
"description": "Configuration of the set, if the product is sold as one.",
"properties": {
"quantity": {
"type": "integer",
"description": "Total number of items in the set."
},
"size_distribution": {
"type": "object",
"description": "Size distribution details within the set.",
"properties": {
"sizes": {
"type": "array",
"description": "List of sizes and their respective quantities.",
"items": {
"type": "object",
"properties": {
"size": {
"type": "string",
"description": "Label of the size (e.g., S, M, L)."
},
"pieces": {
"type": "integer",
"description": "Quantity of pieces for the corresponding size."
}
}
}
}
}
}
}
}
🔧 Operation: application.article.message.article/update/v1​
🔹 Entry 8​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/update/v1.payload.components/schemas/article_update_v1.properties.payload.properties.articles.items.properties.trader - New Schema:
{
"type": "array",
"description": "List of traders associated with the product.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Trader's name."
},
"type": {
"type": "string",
"enum": [
"Manufacturer",
"Importer",
"Packer",
"Marketer"
],
"description": "Indicates the trader type."
},
"address": {
"type": "array",
"description": "List of addresses associated with the trader.",
"items": {
"type": "string"
}
}
}
}
}
🔧 Operation: application.article.message.article/update/v1​
🔹 Entry 9​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/update/v1.payload.components/schemas/article_update_v1.properties.payload.properties.articles.items.properties._custom_json - New Schema:
{
"type": "object",
"description": "Custom JSON data associated with the product."
}
🔧 Operation: application.article.message.article/update/v1​
🔹 Entry 10​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
article.channels.event.messages.article/update/v1.payload.components/schemas/article_update_v1.properties.payload.properties.articles.items.properties.tags - New Schema:
{
"type": "array",
"description": "Tags or labels assigned to the product for categorization or search purposes.",
"items": {
"type": "string"
}
}
🔧 Operation: application.cart.message.cart/create/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
cart.channels.event.messages.cart/create/v1.payload.components/schemas/cart_create_v1.properties.payload.properties.cart.properties.items.items.properties.moq.properties.increment_unit - New Schema:
{
"type": "integer",
"description": "Increment order quantity."
}
🔧 Operation: application.cart.message.cart/update/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
cart.channels.event.messages.cart/update/v1.payload.components/schemas/cart_update_v1.properties.payload.properties.cart.properties.items.items.properties.moq.properties.increment_unit - New Schema:
{
"type": "integer",
"description": "Increment order quantity."
}
🔧 Operation: application.collection.message.collection/create/v2​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
collection.channels.event.messages.collection/create/v2.payload.components/schemas/collection_create_v2.properties.payload.properties.collection.properties.query.items.properties.action - New Schema:
{
"type": "string"
}
🔧 Operation: application.collection.message.collection/create/v2​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
collection.channels.event.messages.collection/create/v2.payload.components/schemas/collection_create_v2.properties.payload.properties.collection.properties.query.items.properties.item_id - New Schema:
{
"type": "number"
}
🔧 Operation: application.collection.message.collection/create/v2​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
collection.channels.event.messages.collection/create/v2.payload.components/schemas/collection_create_v2.properties.payload.properties.collection.properties.query.items.properties.priority - New Schema:
{
"type": "string"
}
🔧 Operation: application.collection.message.collection/create/v2​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
collection.channels.event.messages.collection/create/v2.payload.components/schemas/collection_create_v2.properties.payload.properties.collection.properties.hidden_items - New Schema:
{
"type": "array",
"items": {
"type": [
"number"
]
},
"description": "Items selected to be hidden will not appear in the collection item listing on the application."
}
🔧 Operation: application.collection.message.collection/create/v2​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
collection.channels.event.messages.collection/create/v2.payload.components/schemas/collection_create_v2.properties.payload.properties.collection.properties.pinned_items - New Schema:
{
"type": "array",
"items": {
"type": [
"number"
]
},
"description": "Items selected to be pinned will appear at the top of the collection item listing on the application, maintaining the same order in the listing."
}
🔧 Operation: application.collection.message.collection/update/v2​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
collection.channels.event.messages.collection/update/v2.payload.components/schemas/collection_update_v2.properties.payload.properties.collection.properties.query.items.properties.action - New Schema:
{
"type": "string"
}
🔧 Operation: application.collection.message.collection/update/v2​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
collection.channels.event.messages.collection/update/v2.payload.components/schemas/collection_update_v2.properties.payload.properties.collection.properties.query.items.properties.item_id - New Schema:
{
"type": "number"
}
🔧 Operation: application.collection.message.collection/update/v2​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
collection.channels.event.messages.collection/update/v2.payload.components/schemas/collection_update_v2.properties.payload.properties.collection.properties.query.items.properties.priority - New Schema:
{
"type": "string"
}
🔧 Operation: application.collection.message.collection/update/v2​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
collection.channels.event.messages.collection/update/v2.payload.components/schemas/collection_update_v2.properties.payload.properties.collection.properties.hidden_items - New Schema:
{
"type": "array",
"items": {
"type": [
"number"
]
},
"description": "Items selected to be hidden will not appear in the collection item listing on the application."
}
🔧 Operation: application.collection.message.collection/update/v2​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
collection.channels.event.messages.collection/update/v2.payload.components/schemas/collection_update_v2.properties.payload.properties.collection.properties.pinned_items - New Schema:
{
"type": "array",
"items": {
"type": [
"number"
]
},
"description": "Items selected to be pinned will appear at the top of the collection item listing on the application, maintaining the same order in the listing."
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.author.properties.approved_by - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "user id by whom the coupon approved"
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.author.properties.rejected_by - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "user id by whom the coupon rejected"
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.author.properties.reviewed_by - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "user id by whom the coupon submit for review"
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.date_meta.properties.approved_on - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Timestamp on which the coupon was approved"
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.date_meta.properties.rejected_on - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Timestamp on which the coupon was rejected"
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 6​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.date_meta.properties.reviewed_on - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Timestamp on which the coupon was submitted for review"
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 7​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.restrictions.properties.payments - New Schema:
{
"type": "object",
"properties": {},
"description": "Defines allowed payments for coupon, all if empty."
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 8​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.restrictions.properties.user_groups - New Schema:
{
"type": "array",
"items": {
"type": "integer"
},
"description": "List of user groups for whom coupon should be applicable."
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 9​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties._schedule.required.5 - New Schema:
"status"
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 10​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties._schedule.properties.status - New Schema:
{
"type": "string",
"description": "Coupon status like draft, review."
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 11​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties._id - New Schema:
{
"type": "string",
"description": "ID of the Coupon."
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 12​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.coupon_type - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Coupon type like single , bulk."
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 13​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.coupon_counts - New Schema:
{
"type": "integer",
"description": "Number of coupons to be created"
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 14​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.coupon_prefix - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Number of coupons to be created"
}
🔧 Operation: application.coupon.message.coupon/create/v1​
🔹 Entry 15​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/create/v1.payload.components/schemas/coupon_create_v1.properties.payload.properties.coupon.properties.reason - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Reason for rejecting for coupon."
}
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 1​
- Action:
replace - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_UPDATED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.required.0 - New Schema:
"user_id"
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 2​
- Action:
replace - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_UPDATED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.required.1 - New Schema:
"app_id"
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 3​
- Action:
replace - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_UPDATED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.required.2 - New Schema:
"usage_count"
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 4​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_ADDED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.required.3 - New Schema:
"coupon_id"
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 5​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.properties.coupon
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 6​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.properties.cart_id
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 7​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.properties.coupon_value
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 8​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.properties.user_id - New Schema:
{
"type": "string",
"description": "User which applied coupon."
}
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 9​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.properties.app_id - New Schema:
{
"type": "string",
"description": "Application/sales channel for which coupon is applied.\""
}
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 10​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.properties.usage_count - New Schema:
{
"type": "number",
"description": "coupon usage count."
}
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 11​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.properties._version - New Schema:
{
"type": "number",
"description": "Coupon version."
}
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 12​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.properties.order_quantity - New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "Order quantity."
}
🔧 Operation: application.coupon.message.coupon/redeem/v1​
🔹 Entry 13​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/redeem/v1.payload.components/schemas/coupon_redeem_v1.properties.payload.properties.coupon.properties.coupon_id - New Schema:
{
"type": "string",
"description": "Unique id for the coupon."
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.author.properties.approved_by - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "user id by whom the coupon approved"
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.author.properties.rejected_by - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "user id by whom the coupon rejected"
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.author.properties.reviewed_by - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "user id by whom the coupon submit for review"
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.date_meta.properties.approved_on - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Timestamp on which the coupon was approved"
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.date_meta.properties.rejected_on - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Timestamp on which the coupon was rejected"
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 6​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.date_meta.properties.reviewed_on - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Timestamp on which the coupon was submitted for review"
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 7​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.restrictions.properties.payments - New Schema:
{
"type": "object",
"properties": {},
"description": "Defines allowed payments for coupon, all if empty."
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 8​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.restrictions.properties.user_groups - New Schema:
{
"type": "array",
"items": {
"type": "integer"
},
"description": "List of user groups for whom coupon should be applicable."
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 9​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties._schedule.required.5 - New Schema:
"status"
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 10​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties._schedule.properties.status - New Schema:
{
"type": "string",
"description": "Coupon status like draft, review."
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 11​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties._id - New Schema:
{
"type": "string",
"description": "ID of the Coupon."
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 12​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.coupon_type - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Coupon type like single , bulk."
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 13​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.coupon_counts - New Schema:
{
"type": "integer",
"description": "Number of coupons to be created"
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 14​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.coupon_prefix - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Number of coupons to be created"
}
🔧 Operation: application.coupon.message.coupon/update/v1​
🔹 Entry 15​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
coupon.channels.event.messages.coupon/update/v1.payload.components/schemas/coupon_update_v1.properties.payload.properties.coupon.properties.reason - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Reason for rejecting for coupon."
}
🔧 Operation: application.coupon.message.coupon/create/v2​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
MESSAGE_ADDED - Path:
coupon.channels.event.messages.coupon/create/v2 - New Schema:
{
"description": "this event is triggered when coupon is created from platform using v2 API",
"payload": {
"components/schemas/coupon_create_v2": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"description": "The coupon payload data.",
"required": [
"coupon"
],
"properties": {
"coupon": {
"type": "object",
"description": "Coupon data consisting like _schedule, buy_rules, display_meta and other Coupon fields.",
"required": [
"display_meta",
"apply_priority",
"stackable",
"date_meta",
"application_id",
"apply_exclusive",
"discount_rules",
"apply_all_discount",
"currency",
"_schedule",
"mode",
"restrictions",
"promotion_type",
"_id",
"visibility",
"buy_rules",
"author",
"promo_group",
"code",
"ownership"
],
"properties": {
"_id": {
"type": "string",
"description": "ID of the Coupon."
},
"code": {
"type": "string",
"description": "Coupon unique code."
},
"mode": {
"type": "string",
"description": "Type of offer. Possible values: promotion, coupon."
},
"author": {
"type": "object",
"required": [
"modified_by",
"created_by"
],
"properties": {
"created_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who created the coupon."
},
"approved_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who created the coupon."
},
"modified_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who last modified the coupon."
},
"rejected_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who has rejected the coupon."
},
"reviewed_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who has submitted to review the coupon."
}
},
"description": "author details of the coupon."
},
"currency": {
"type": "string",
"description": "ISO code of the currency."
},
"_schedule": {
"type": "object",
"required": [
"start",
"next_schedule",
"published",
"status"
],
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "Coupon validity end date."
},
"cron": {
"type": [
"string",
"null"
],
"description": "cron string of the coupon, if coupon is created periodically."
},
"start": {
"type": "string",
"description": "Coupon validity start date."
},
"status": {
"type": "string",
"description": "Coupon status like draft, review.",
"enum": [
"approved",
"rejected",
"draft",
"review"
]
},
"duration": {
"type": [
"integer",
"null"
],
"description": "For how much time coupon can be active."
},
"published": {
"type": "boolean",
"description": "If Coupon is published or marked inactive."
},
"next_schedule": {
"type": "array",
"description": "next schedule of the Coupon.",
"items": {
"type": "object",
"required": [
"start"
],
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "end timestamp of the Coupon."
},
"start": {
"type": [
"string",
"null"
],
"description": "start timestamp of the Coupon."
}
}
}
}
},
"description": "schedule of the coupon."
},
"buy_rules": {
"type": "object",
"description": "Rules for purchases required to apply the Coupon.",
"properties": {}
},
"date_meta": {
"type": "object",
"required": [
"created_on",
"modified_on"
],
"description": "Date details of coupon.",
"properties": {
"created_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was created."
},
"modified_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was modified."
},
"approved_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was approved."
},
"rejected_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was rejected."
},
"reviewed_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was submitted for review."
}
}
},
"ownership": {
"type": "object",
"description": "ownership details of the coupon.",
"required": [
"payable_by",
"payable_category"
],
"properties": {
"payable_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "user id for who will pay the amount discounted by coupon."
},
"payable_category": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "user category for who will pay the amount discounted by coupon."
}
}
},
"stackable": {
"type": "boolean",
"description": "Indicates if coupon can be applied along with another coupon."
},
"promo_group": {
"type": "string",
"description": "Promotion group. Possible values: product, cart, contract, ladder_price."
},
"visibility": {
"type": "object",
"required": [
"pdp",
"coupon_list"
],
"description": "visibility details of coupon.",
"properties": {
"pdp": {
"type": "boolean",
"description": "Show coupon on PDP page."
},
"coupon_list": {
"type": "boolean",
"description": "Show coupon under coupon list. Used when mode is coupon."
}
}
},
"display_meta": {
"type": "object",
"required": [
"offer_text",
"description",
"name"
],
"description": "display details of coupon.",
"properties": {
"name": {
"type": "string",
"description": "Name of coupon on Fynd Platform Panel."
},
"offer_text": {
"type": "string",
"description": "Coupon offer text to be shown on PDP or Cart."
},
"description": {
"type": "string",
"description": "Description of the coupon."
},
"offer_label": {
"type": [
"string",
"null"
],
"default": "",
"description": "Coupon offer Label to be shown on PDP or Cart."
}
}
},
"restrictions": {
"type": "object",
"required": [
"user_id",
"uses",
"user_registered",
"post_order",
"platforms",
"payments",
"user_groups",
"email_domain"
],
"description": "restrictions of coupon.",
"properties": {
"uses": {
"type": "object",
"required": [
"maximum",
"remaining"
],
"properties": {
"maximum": {
"type": "object",
"required": [
"user",
"total"
],
"properties": {
"user": {
"type": "integer",
"description": "Maximum number of times per user the coupon can be applied."
},
"total": {
"type": "integer",
"description": "Total number of times per user the coupon can be applied."
}
},
"description": "Defines maximum usage of coupon"
},
"remaining": {
"type": "object",
"required": [
"user",
"total"
],
"properties": {
"user": {
"type": "integer",
"description": "Uses done by the customer for the coupon."
},
"total": {
"type": "integer",
"description": "total number of times the coupon applied and order placed."
}
},
"description": "Defines total usage of coupon."
}
},
"description": "Maximum and remaining usage count for coupon used by user."
},
"user_id": {
"type": "array",
"items": {},
"description": "List of only allowed user _ids for whom coupon should be applicable."
},
"payments": {
"type": "object",
"properties": {},
"description": "Defines allowed payments for coupon, all if empty."
},
"platforms": {
"type": "array",
"items": [
{
"type": "string"
}
],
"description": "List of device platforms on which coupon is allowed. Possible values: web, ios, android."
},
"post_order": {
"type": "object",
"required": [
"cancellation_allowed",
"return_allowed"
],
"properties": {
"return_allowed": {
"type": "boolean",
"description": "Indicates whether customers can return an order purchased with couoon applied."
},
"cancellation_allowed": {
"type": "boolean",
"description": "Indicates whether customers can cancel an order purchased with coupon applied."
}
},
"description": "post order actions allowed after order created with coupon."
},
"user_groups": {
"type": "array",
"items": {},
"description": "List of user groups for whom coupon should be applicable."
},
"anonymous_users": {
"type": "boolean",
"description": "Allow anonymous users to avail this coupon."
},
"user_registered": {
"type": "object",
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "end date of user registration."
},
"start": {
"type": [
"string",
"null"
],
"description": "start date of user registration."
}
},
"description": "Allow coupon to be applied for users registered within specified dates."
},
"price_range": {
"type": "object",
"properties\"": {
"max": {
"type": "number",
"description": "max price range of cart."
},
"min": {
"type": "number",
"description": "min price range of cart."
}
},
"description": "price range for the coupon."
},
"user_type": {
"type": "string",
"description": "User type for which coupon is applicable."
},
"email_domain": {
"type": "array",
"description": "List of email domain on which coupon is applicable.",
"items": {
"type": "string"
}
},
"ordering_stores": {
"type": "array",
"description": "List of store id on which coupon is applicable.",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"application_id": {
"type": "string",
"description": "ID of the application (sales channel) where coupon is applicable."
},
"apply_priority": {
"type": "integer",
"description": "Priority of applying a coupon. Higher value coupon are applied first."
},
"discount_rules": {
"type": "array",
"items": [
{
"type": "object",
"required": [
"item_criteria",
"discount_type",
"buy_condition",
"offer"
],
"properties": {
"offer": {
"type": "object",
"properties": {},
"description": "Offer given by coupon."
},
"buy_condition": {
"type": "string",
"description": "buy condition of rules for the coupon."
},
"discount_type": {
"type": "string",
"description": "type of discount by coupon."
},
"item_criteria": {
"type": "object",
"properties": {},
"description": "item criteria that should meet to apply the coupon."
}
}
}
],
"description": "Discount rules for the coupon."
},
"promotion_type": {
"type": "string",
"description": "Promotion Type. Possible values: percentage, amount, fixed_price, bogo, contract_price, ladder_price, custom."
},
"apply_exclusive": {
"type": [
"string",
"null"
],
"description": "If allowed, any other coupon after current coupon is applied.Possible values: article, cart, null"
},
"post_order_action": {
"type": "object",
"properties": {
"action_date": {
"type": [
"string",
"null"
],
"description": "action data to be used to perform."
},
"action_type": {
"type": [
"string",
"null"
],
"description": "action type to be performed after order placed with coupon."
}
},
"description": "Details of post order action for the coupon."
},
"apply_all_discount": {
"type": "boolean",
"description": "Indicates whether multiple discount rules can be applied together or not."
}
}
}
}
}
},
"examples": [
{
"event": {
"trace_id": [
"megatron.4cf2ac22-df27-446b-9110-6b4041e3c9e8"
],
"name": "coupon",
"type": "create",
"version": "2",
"created_timestamp": 1711966792722,
"id": "mfNVsudzsKMZAWTWEncsgb8dpbemcI9OkCMBzI1ECek=",
"category": "application"
},
"company_id": 507,
"application_id": "64991b4e6d274c7422bbdf7c",
"contains": [
"coupon"
],
"payload": {
"coupon": {
"buy_rules": {
"rule#1": {
"product_tags": [
"B140-50"
],
"cart_quantity": {
"greater_than_equals": 2
},
"item_store": [
18268,
19641,
19643,
19644
],
"item_brand": [
9
]
}
},
"discount_rules": [
{
"item_criteria": {
"buy_rules": [
"rule#1"
]
},
"discount_type": "percentage",
"buy_condition": "( rule#1 )",
"offer": {
"discount_percentage": 16.6666666667
}
}
],
"ownership": {
"payable_by": "",
"payable_category": "seller"
},
"currency": "INR",
"mode": "coupon",
"visiblility": {
"coupon_list": false,
"pdp": true
},
"apply_all_discount": false,
"application_id": "64991b4e6d274c7422bbdf7c",
"restrictions": {
"uses": {
"remaining": {
"total": 0,
"user": 0
},
"maximum": {
"total": 0,
"user": 0
}
},
"email_domain": [],
"platforms": [
"web",
"android",
"ios"
],
"user_id": [],
"ordering_stores": [],
"user_groups": [],
"payments": {},
"post_order": {
"return_allowed": true,
"cancellation_allowed": true
},
"user_registered": {
"start": null,
"end": null
},
"user_type": "all_user"
},
"display_meta": {
"offer_text": "Buy 1 40% Buy 2 50%",
"name": "Buy 1 40% Buy 2 50%",
"description": "<p>Buy 1 40% Buy 2 50%</p>",
"offer_label": "Buy 1 40% Buy 2 50%"
},
"_schedule": {
"published": true,
"next_schedule": [
{
"start": "2024-04-01T10:20:24+00:00",
"end": "2024-04-09T18:05:00+00:00"
}
],
"end": "2024-04-09T18:05:00+00:00",
"cron": "",
"start": "2024-04-01T10:20:24+00:00",
"duration": 0
},
"stackable": true,
"promotion_type": "percentage",
"date_meta": {
"created_on": "2024-04-01T10:19:52.706137+00:00",
"modified_on": "2024-04-01T10:19:52.706137+00:00"
},
"apply_priority": 1,
"promo_group": "product",
"apply_exclusive": null,
"_id": "660a8a4841b576969e21b105",
"calculate_on": "esp",
"post_order_action": {
"action_type": "",
"action_date": null
},
"author": {
"created_by": "cdeebdaa330629fee38306fd",
"modified_by": "cdeebdaa330629fee38306fd"
}
}
}
}
]
}
},
"schema": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"description": "The coupon payload data.",
"required": [
"coupon"
],
"properties": {
"coupon": {
"type": "object",
"description": "Coupon data consisting like _schedule, buy_rules, display_meta and other Coupon fields.",
"required": [
"display_meta",
"apply_priority",
"stackable",
"date_meta",
"application_id",
"apply_exclusive",
"discount_rules",
"apply_all_discount",
"currency",
"_schedule",
"mode",
"restrictions",
"promotion_type",
"_id",
"visibility",
"buy_rules",
"author",
"promo_group",
"code",
"ownership"
],
"properties": {
"_id": {
"type": "string",
"description": "ID of the Coupon."
},
"code": {
"type": "string",
"description": "Coupon unique code."
},
"mode": {
"type": "string",
"description": "Type of offer. Possible values: promotion, coupon."
},
"author": {
"type": "object",
"required": [
"modified_by",
"created_by"
],
"properties": {
"created_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who created the coupon."
},
"approved_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who created the coupon."
},
"modified_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who last modified the coupon."
},
"rejected_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who has rejected the coupon."
},
"reviewed_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who has submitted to review the coupon."
}
},
"description": "author details of the coupon."
},
"currency": {
"type": "string",
"description": "ISO code of the currency."
},
"_schedule": {
"type": "object",
"required": [
"start",
"next_schedule",
"published",
"status"
],
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "Coupon validity end date."
},
"cron": {
"type": [
"string",
"null"
],
"description": "cron string of the coupon, if coupon is created periodically."
},
"start": {
"type": "string",
"description": "Coupon validity start date."
},
"status": {
"type": "string",
"description": "Coupon status like draft, review.",
"enum": [
"approved",
"rejected",
"draft",
"review"
]
},
"duration": {
"type": [
"integer",
"null"
],
"description": "For how much time coupon can be active."
},
"published": {
"type": "boolean",
"description": "If Coupon is published or marked inactive."
},
"next_schedule": {
"type": "array",
"description": "next schedule of the Coupon.",
"items": {
"type": "object",
"required": [
"start"
],
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "end timestamp of the Coupon."
},
"start": {
"type": [
"string",
"null"
],
"description": "start timestamp of the Coupon."
}
}
}
}
},
"description": "schedule of the coupon."
},
"buy_rules": {
"type": "object",
"description": "Rules for purchases required to apply the Coupon.",
"properties": {}
},
"date_meta": {
"type": "object",
"required": [
"created_on",
"modified_on"
],
"description": "Date details of coupon.",
"properties": {
"created_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was created."
},
"modified_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was modified."
},
"approved_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was approved."
},
"rejected_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was rejected."
},
"reviewed_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was submitted for review."
}
}
},
"ownership": {
"type": "object",
"description": "ownership details of the coupon.",
"required": [
"payable_by",
"payable_category"
],
"properties": {
"payable_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "user id for who will pay the amount discounted by coupon."
},
"payable_category": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "user category for who will pay the amount discounted by coupon."
}
}
},
"stackable": {
"type": "boolean",
"description": "Indicates if coupon can be applied along with another coupon."
},
"promo_group": {
"type": "string",
"description": "Promotion group. Possible values: product, cart, contract, ladder_price."
},
"visibility": {
"type": "object",
"required": [
"pdp",
"coupon_list"
],
"description": "visibility details of coupon.",
"properties": {
"pdp": {
"type": "boolean",
"description": "Show coupon on PDP page."
},
"coupon_list": {
"type": "boolean",
"description": "Show coupon under coupon list. Used when mode is coupon."
}
}
},
"display_meta": {
"type": "object",
"required": [
"offer_text",
"description",
"name"
],
"description": "display details of coupon.",
"properties": {
"name": {
"type": "string",
"description": "Name of coupon on Fynd Platform Panel."
},
"offer_text": {
"type": "string",
"description": "Coupon offer text to be shown on PDP or Cart."
},
"description": {
"type": "string",
"description": "Description of the coupon."
},
"offer_label": {
"type": [
"string",
"null"
],
"default": "",
"description": "Coupon offer Label to be shown on PDP or Cart."
}
}
},
"restrictions": {
"type": "object",
"required": [
"user_id",
"uses",
"user_registered",
"post_order",
"platforms",
"payments",
"user_groups",
"email_domain"
],
"description": "restrictions of coupon.",
"properties": {
"uses": {
"type": "object",
"required": [
"maximum",
"remaining"
],
"properties": {
"maximum": {
"type": "object",
"required": [
"user",
"total"
],
"properties": {
"user": {
"type": "integer",
"description": "Maximum number of times per user the coupon can be applied."
},
"total": {
"type": "integer",
"description": "Total number of times per user the coupon can be applied."
}
},
"description": "Defines maximum usage of coupon"
},
"remaining": {
"type": "object",
"required": [
"user",
"total"
],
"properties": {
"user": {
"type": "integer",
"description": "Uses done by the customer for the coupon."
},
"total": {
"type": "integer",
"description": "total number of times the coupon applied and order placed."
}
},
"description": "Defines total usage of coupon."
}
},
"description": "Maximum and remaining usage count for coupon used by user."
},
"user_id": {
"type": "array",
"items": {},
"description": "List of only allowed user _ids for whom coupon should be applicable."
},
"payments": {
"type": "object",
"properties": {},
"description": "Defines allowed payments for coupon, all if empty."
},
"platforms": {
"type": "array",
"items": [
{
"type": "string"
}
],
"description": "List of device platforms on which coupon is allowed. Possible values: web, ios, android."
},
"post_order": {
"type": "object",
"required": [
"cancellation_allowed",
"return_allowed"
],
"properties": {
"return_allowed": {
"type": "boolean",
"description": "Indicates whether customers can return an order purchased with couoon applied."
},
"cancellation_allowed": {
"type": "boolean",
"description": "Indicates whether customers can cancel an order purchased with coupon applied."
}
},
"description": "post order actions allowed after order created with coupon."
},
"user_groups": {
"type": "array",
"items": {},
"description": "List of user groups for whom coupon should be applicable."
},
"anonymous_users": {
"type": "boolean",
"description": "Allow anonymous users to avail this coupon."
},
"user_registered": {
"type": "object",
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "end date of user registration."
},
"start": {
"type": [
"string",
"null"
],
"description": "start date of user registration."
}
},
"description": "Allow coupon to be applied for users registered within specified dates."
},
"price_range": {
"type": "object",
"properties\"": {
"max": {
"type": "number",
"description": "max price range of cart."
},
"min": {
"type": "number",
"description": "min price range of cart."
}
},
"description": "price range for the coupon."
},
"user_type": {
"type": "string",
"description": "User type for which coupon is applicable."
},
"email_domain": {
"type": "array",
"description": "List of email domain on which coupon is applicable.",
"items": {
"type": "string"
}
},
"ordering_stores": {
"type": "array",
"description": "List of store id on which coupon is applicable.",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"application_id": {
"type": "string",
"description": "ID of the application (sales channel) where coupon is applicable."
},
"apply_priority": {
"type": "integer",
"description": "Priority of applying a coupon. Higher value coupon are applied first."
},
"discount_rules": {
"type": "array",
"items": [
{
"type": "object",
"required": [
"item_criteria",
"discount_type",
"buy_condition",
"offer"
],
"properties": {
"offer": {
"type": "object",
"properties": {},
"description": "Offer given by coupon."
},
"buy_condition": {
"type": "string",
"description": "buy condition of rules for the coupon."
},
"discount_type": {
"type": "string",
"description": "type of discount by coupon."
},
"item_criteria": {
"type": "object",
"properties": {},
"description": "item criteria that should meet to apply the coupon."
}
}
}
],
"description": "Discount rules for the coupon."
},
"promotion_type": {
"type": "string",
"description": "Promotion Type. Possible values: percentage, amount, fixed_price, bogo, contract_price, ladder_price, custom."
},
"apply_exclusive": {
"type": [
"string",
"null"
],
"description": "If allowed, any other coupon after current coupon is applied.Possible values: article, cart, null"
},
"post_order_action": {
"type": "object",
"properties": {
"action_date": {
"type": [
"string",
"null"
],
"description": "action data to be used to perform."
},
"action_type": {
"type": [
"string",
"null"
],
"description": "action type to be performed after order placed with coupon."
}
},
"description": "Details of post order action for the coupon."
},
"apply_all_discount": {
"type": "boolean",
"description": "Indicates whether multiple discount rules can be applied together or not."
}
}
}
}
}
},
"examples": [
{
"event": {
"trace_id": [
"megatron.4cf2ac22-df27-446b-9110-6b4041e3c9e8"
],
"name": "coupon",
"type": "create",
"version": "2",
"created_timestamp": 1711966792722,
"id": "mfNVsudzsKMZAWTWEncsgb8dpbemcI9OkCMBzI1ECek=",
"category": "application"
},
"company_id": 507,
"application_id": "64991b4e6d274c7422bbdf7c",
"contains": [
"coupon"
],
"payload": {
"coupon": {
"buy_rules": {
"rule#1": {
"product_tags": [
"B140-50"
],
"cart_quantity": {
"greater_than_equals": 2
},
"item_store": [
18268,
19641,
19643,
19644
],
"item_brand": [
9
]
}
},
"discount_rules": [
{
"item_criteria": {
"buy_rules": [
"rule#1"
]
},
"discount_type": "percentage",
"buy_condition": "( rule#1 )",
"offer": {
"discount_percentage": 16.6666666667
}
}
],
"ownership": {
"payable_by": "",
"payable_category": "seller"
},
"currency": "INR",
"mode": "coupon",
"visiblility": {
"coupon_list": false,
"pdp": true
},
"apply_all_discount": false,
"application_id": "64991b4e6d274c7422bbdf7c",
"restrictions": {
"uses": {
"remaining": {
"total": 0,
"user": 0
},
"maximum": {
"total": 0,
"user": 0
}
},
"email_domain": [],
"platforms": [
"web",
"android",
"ios"
],
"user_id": [],
"ordering_stores": [],
"user_groups": [],
"payments": {},
"post_order": {
"return_allowed": true,
"cancellation_allowed": true
},
"user_registered": {
"start": null,
"end": null
},
"user_type": "all_user"
},
"display_meta": {
"offer_text": "Buy 1 40% Buy 2 50%",
"name": "Buy 1 40% Buy 2 50%",
"description": "<p>Buy 1 40% Buy 2 50%</p>",
"offer_label": "Buy 1 40% Buy 2 50%"
},
"_schedule": {
"published": true,
"next_schedule": [
{
"start": "2024-04-01T10:20:24+00:00",
"end": "2024-04-09T18:05:00+00:00"
}
],
"end": "2024-04-09T18:05:00+00:00",
"cron": "",
"start": "2024-04-01T10:20:24+00:00",
"duration": 0
},
"stackable": true,
"promotion_type": "percentage",
"date_meta": {
"created_on": "2024-04-01T10:19:52.706137+00:00",
"modified_on": "2024-04-01T10:19:52.706137+00:00"
},
"apply_priority": 1,
"promo_group": "product",
"apply_exclusive": null,
"_id": "660a8a4841b576969e21b105",
"calculate_on": "esp",
"post_order_action": {
"action_type": "",
"action_date": null
},
"author": {
"created_by": "cdeebdaa330629fee38306fd",
"modified_by": "cdeebdaa330629fee38306fd"
}
}
}
}
]
}
}
🔧 Operation: application.coupon.message.coupon/update/v2​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
MESSAGE_ADDED - Path:
coupon.channels.event.messages.coupon/update/v2 - New Schema:
{
"description": "this event is triggered when coupon is updated from platform using v2 API",
"payload": {
"components/schemas/coupon_update_v2": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"description": "The coupon payload data.",
"required": [
"coupon"
],
"properties": {
"coupon": {
"type": "object",
"description": "Coupon data consisting like _schedule, buy_rules, display_meta and other Coupon fields.",
"required": [
"display_meta",
"apply_priority",
"stackable",
"date_meta",
"application_id",
"apply_exclusive",
"discount_rules",
"apply_all_discount",
"currency",
"_schedule",
"mode",
"restrictions",
"promotion_type",
"_id",
"visibility",
"buy_rules",
"author",
"promo_group",
"code",
"ownership"
],
"properties": {
"_id": {
"type": "string",
"description": "ID of the coupon."
},
"code": {
"type": "string",
"description": "Coupon unique code."
},
"mode": {
"type": "string",
"description": "Type of offer. Possible values: promotion, coupon."
},
"author": {
"type": "object",
"required": [
"modified_by",
"created_by"
],
"properties": {
"created_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who created the coupon."
},
"approved_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who created the coupon."
},
"modified_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who last modified the coupon."
},
"rejected_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who has rejected the coupon."
},
"reviewed_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who has submitted to review the coupon."
}
}
},
"currency": {
"type": "string",
"description": "ISO code of the currency."
},
"_schedule": {
"type": "object",
"required": [
"start",
"next_schedule",
"published",
"status"
],
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "Coupon validity end date."
},
"cron": {
"type": [
"string",
"null"
],
"description": "cron string of the coupon, if coupon is created periodically."
},
"start": {
"type": "string",
"description": "Coupon validity start date."
},
"status": {
"type": "string",
"description": "Coupon status like draft, review.",
"enum": [
"approved",
"rejected",
"draft",
"review"
]
},
"duration": {
"type": [
"integer",
"null"
],
"description": "For how much time coupon can be active."
},
"published": {
"type": "boolean",
"description": "If coupon is published or marked inactive."
},
"next_schedule": {
"type": "array",
"description": "next schedule of the coupon.",
"items": {
"type": "object",
"required": [
"start"
],
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "end timestamp of the coupon."
},
"start": {
"type": "string",
"description": "start timestamp of the coupon."
}
}
}
}
},
"description": "schedule of the coupon."
},
"buy_rules": {
"type": "object",
"description": "Rules for purchases required to apply the coupon.",
"properties": {}
},
"date_meta": {
"type": "object",
"required": [
"created_on",
"modified_on"
],
"description": "Date details of coupon.",
"properties": {
"created_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was created."
},
"modified_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was modified."
},
"approved_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was approved."
},
"rejected_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was rejected."
},
"reviewed_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was submitted for review."
}
}
},
"ownership": {
"type": "object",
"description": "ownership details of the coupon.",
"required": [
"payable_by",
"payable_category"
],
"properties": {
"payable_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "user id for who will pay the amount discounted by coupon."
},
"payable_category": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "user category for who will pay the amount discounted by coupon."
}
}
},
"stackable": {
"type": "boolean",
"description": "Indicates if coupon can be applied along with another coupon."
},
"promo_group": {
"type": "string",
"description": "Promotion group. Possible values: product, cart, contract, ladder_price."
},
"visibility": {
"type": "object",
"required": [
"pdp",
"coupon_list"
],
"description": "visibility details of coupon.",
"properties": {
"pdp": {
"type": "boolean",
"description": "Show coupon on PDP page."
},
"coupon_list": {
"type": "boolean",
"description": "Show coupons under coupon list. Used when mode is coupon"
}
}
},
"display_meta": {
"type": "object",
"required": [
"offer_text",
"description",
"name"
],
"description": "display details of the coupon.",
"properties": {
"name": {
"type": "string",
"description": "Name of coupon on Fynd Platform Panel."
},
"offer_text": {
"type": "string",
"description": "Coupon offer text to be shown on PDP or Cart."
},
"description": {
"type": "string",
"description": "Description of the coupon."
},
"offer_label": {
"type": [
"string",
"null"
],
"default": "",
"description": "Coupon offer Label to be shown on PDP or Cart."
}
}
},
"restrictions": {
"type": "object",
"required": [
"user_id",
"uses",
"user_registered",
"post_order",
"platforms",
"payments",
"user_groups",
"email_domain"
],
"description": "restrictions of coupons.",
"properties": {
"uses": {
"type": "object",
"required": [
"maximum",
"remaining"
],
"properties": {
"maximum": {
"type": "object",
"required": [
"user",
"total"
],
"properties": {
"user": {
"type": "integer",
"description": "Maximum number of times per user the coupon can be applied."
},
"total": {
"type": "integer",
"description": "Total number of times per user the coupon can be applied."
}
},
"description": "Defines maximum usage of coupon."
},
"remaining": {
"type": "object",
"required": [
"user",
"total"
],
"properties": {
"user": {
"type": "integer",
"description": "Uses done by the customer for the coupon."
},
"total": {
"type": "integer",
"description": "total number of times the coupon applied and order placed."
}
},
"description": "Defines total usage of coupon."
}
},
"description": "Maximum and remaining usage count for coupon used by user."
},
"user_id": {
"type": "array",
"items": {},
"description": "List of only allowed user _ids for whom coupon should be applicable."
},
"payments": {
"type": "object",
"properties": {},
"description": "Defines allowed payments for coupon, all if empty."
},
"platforms": {
"type": "array",
"items": [
{
"type": "string"
}
],
"description": "List of device platforms on which coupon is allowed. Possible values: web, ios, android."
},
"post_order": {
"type": "object",
"required": [
"cancellation_allowed",
"return_allowed"
],
"properties": {
"return_allowed": {
"type": "boolean",
"description": "Indicates whether customers can return an order purchased with coupon applied."
},
"cancellation_allowed": {
"type": "boolean",
"description": "Indicates whether customers can cancel an order purchased with coupon applied."
}
},
"description": "post order actions allowed after order created with coupon."
},
"user_groups": {
"type": "array",
"items": {},
"description": "List of user groups for whom coupon should be applicable."
},
"anonymous_users": {
"type": "boolean",
"description": "Allow anonymous users to avail this coupon."
},
"user_registered": {
"type": "object",
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "end date of user registration"
},
"start": {
"type": [
"string",
"null"
],
"description": "start date of user registration"
}
},
"description": "Allow coupon to be applied for users registered within specified dates."
},
"price_range": {
"type": "object",
"properties\"": {
"max": {
"type": "number",
"description": "max price range of cart."
},
"min": {
"type": "number",
"description": "min price range of cart."
}
},
"description": "price range for the coupon."
},
"user_type": {
"type": "string",
"description": "User type for which coupon is applicable."
},
"email_domain": {
"type": "array",
"description": "List of email domain on which coupon is applicable.",
"items": {
"type": "string"
}
},
"ordering_stores": {
"type": "array",
"description": "List of store id on which coupon is applicable.",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"application_id": {
"type": "string",
"description": "ID of the application (sales channel) where coupon is applicable."
},
"apply_priority": {
"type": "integer",
"description": "Priority of applying a coupon. Higher value coupons are applied first."
},
"discount_rules": {
"type": "array",
"items": [
{
"type": "object",
"required": [
"item_criteria",
"discount_type",
"buy_condition",
"offer"
],
"properties": {
"offer": {
"type": "object",
"properties": {},
"description": "Offer given by coupon."
},
"buy_condition": {
"type": "string",
"description": "buy condition of rules for the coupon."
},
"discount_type": {
"type": "string",
"description": "type of discount by coupon."
},
"item_criteria": {
"type": "object",
"properties": {},
"description": "item criteria that should meet to apply the coupon."
}
}
}
],
"description": "Discount rules for the coupon."
},
"promotion_type": {
"type": "string",
"description": "Promotion Type. Possible values: percentage, amount, fixed_price, bogo, contract_price, ladder_price, custom."
},
"apply_exclusive": {
"type": [
"string",
"null"
],
"description": "If allowed, any other coupon after current coupon is applied. Possible values: article, cart, null."
},
"post_order_action": {
"type": "object",
"properties": {
"action_date": {
"type": [
"string",
"null"
],
"description": "action data to be used to perform."
},
"action_type": {
"type": [
"string",
"null"
],
"description": "action type to be performed after order placed with coupon."
}
},
"description": "Details of post order action for the coupon."
},
"apply_all_discount": {
"type": "boolean",
"description": "Indicates whether multiple discount rules can be applied together or not."
}
}
}
}
}
},
"examples": [
{
"event": {
"trace_id": [
"megatron.3285dc2a-49de-4bec-b86c-39918b2ed0f5"
],
"name": "coupon",
"type": "update",
"version": "2",
"created_timestamp": 1711615911887,
"id": "7Fy18D99MxxCtbzaGBv4ATqlO+P7ujzPUDTGFIRt+aU=",
"category": "application"
},
"company_id": 6440,
"application_id": "657d3e74cc90c6a66842e990",
"contains": [
"coupon"
],
"payload": {
"coupon": {
"calculate_on": "esp",
"date_meta": {
"modified_on": "2024-03-28T08:51:51.871778+00:00",
"created_on": "2024-03-28T08:50:54.397000+00:00"
},
"apply_exclusive": null,
"currency": "INR",
"restrictions": {
"user_registered": {
"start": null,
"end": null
},
"user_id": [],
"uses": {
"maximum": {
"total": 0,
"user": 0
},
"remaining": {
"total": 0,
"user": 0
}
},
"user_groups": [],
"user_type": "all_user",
"ordering_stores": [],
"post_order": {
"return_allowed": true,
"cancellation_allowed": true
},
"email_domain": [],
"platforms": [
"web",
"android",
"ios"
],
"payments": {}
},
"application_id": "657d3e74cc90c6a66842e990",
"author": {
"modified_by": "c5c674ac6533f964a0b5948f",
"created_by": "c5c674ac6533f964a0b5948f"
},
"promotion_type": "percentage",
"display_meta": {
"name": "Test",
"description": "<p>Test 50</p>",
"offer_text": "50",
"offer_label": ""
},
"discount_rules": [
{
"offer": {
"discount_percentage": 50
},
"buy_condition": "( rule#1 )",
"discount_type": "percentage",
"item_criteria": {
"item_store": [
22754
]
}
}
],
"apply_priority": 1,
"_schedule": {
"duration": 0,
"next_schedule": [
{
"start": "2024-03-28T08:49:37+00:00",
"end": "2024-03-29T18:30:00+00:00"
}
],
"start": "2024-03-28T08:49:37+00:00",
"end": "2024-03-29T18:30:00+00:00",
"cron": "",
"published": true
},
"promo_group": "product",
"mode": "coupon",
"ownership": {
"payable_category": "seller",
"payable_by": ""
},
"stackable": true,
"visiblility": {
"pdp": true,
"coupon_list": false
},
"post_order_action": {
"action_date": null,
"action_type": ""
},
"apply_all_discount": false,
"_id": "66052f6e59001f59ae1bec27",
"buy_rules": {
"rule#1": {
"cart_quantity": {
"greater_than": 10,
"equals": 10
}
},
"rule#2": {
"item_brand": [
7594
]
}
}
}
}
}
]
}
},
"schema": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"description": "The coupon payload data.",
"required": [
"coupon"
],
"properties": {
"coupon": {
"type": "object",
"description": "Coupon data consisting like _schedule, buy_rules, display_meta and other Coupon fields.",
"required": [
"display_meta",
"apply_priority",
"stackable",
"date_meta",
"application_id",
"apply_exclusive",
"discount_rules",
"apply_all_discount",
"currency",
"_schedule",
"mode",
"restrictions",
"promotion_type",
"_id",
"visibility",
"buy_rules",
"author",
"promo_group",
"code",
"ownership"
],
"properties": {
"_id": {
"type": "string",
"description": "ID of the coupon."
},
"code": {
"type": "string",
"description": "Coupon unique code."
},
"mode": {
"type": "string",
"description": "Type of offer. Possible values: promotion, coupon."
},
"author": {
"type": "object",
"required": [
"modified_by",
"created_by"
],
"properties": {
"created_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who created the coupon."
},
"approved_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who created the coupon."
},
"modified_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who last modified the coupon."
},
"rejected_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who has rejected the coupon."
},
"reviewed_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "ID of the user who has submitted to review the coupon."
}
}
},
"currency": {
"type": "string",
"description": "ISO code of the currency."
},
"_schedule": {
"type": "object",
"required": [
"start",
"next_schedule",
"published",
"status"
],
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "Coupon validity end date."
},
"cron": {
"type": [
"string",
"null"
],
"description": "cron string of the coupon, if coupon is created periodically."
},
"start": {
"type": "string",
"description": "Coupon validity start date."
},
"status": {
"type": "string",
"description": "Coupon status like draft, review.",
"enum": [
"approved",
"rejected",
"draft",
"review"
]
},
"duration": {
"type": [
"integer",
"null"
],
"description": "For how much time coupon can be active."
},
"published": {
"type": "boolean",
"description": "If coupon is published or marked inactive."
},
"next_schedule": {
"type": "array",
"description": "next schedule of the coupon.",
"items": {
"type": "object",
"required": [
"start"
],
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "end timestamp of the coupon."
},
"start": {
"type": "string",
"description": "start timestamp of the coupon."
}
}
}
}
},
"description": "schedule of the coupon."
},
"buy_rules": {
"type": "object",
"description": "Rules for purchases required to apply the coupon.",
"properties": {}
},
"date_meta": {
"type": "object",
"required": [
"created_on",
"modified_on"
],
"description": "Date details of coupon.",
"properties": {
"created_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was created."
},
"modified_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was modified."
},
"approved_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was approved."
},
"rejected_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was rejected."
},
"reviewed_on": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Timestamp on which the coupon was submitted for review."
}
}
},
"ownership": {
"type": "object",
"description": "ownership details of the coupon.",
"required": [
"payable_by",
"payable_category"
],
"properties": {
"payable_by": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "user id for who will pay the amount discounted by coupon."
},
"payable_category": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "user category for who will pay the amount discounted by coupon."
}
}
},
"stackable": {
"type": "boolean",
"description": "Indicates if coupon can be applied along with another coupon."
},
"promo_group": {
"type": "string",
"description": "Promotion group. Possible values: product, cart, contract, ladder_price."
},
"visibility": {
"type": "object",
"required": [
"pdp",
"coupon_list"
],
"description": "visibility details of coupon.",
"properties": {
"pdp": {
"type": "boolean",
"description": "Show coupon on PDP page."
},
"coupon_list": {
"type": "boolean",
"description": "Show coupons under coupon list. Used when mode is coupon"
}
}
},
"display_meta": {
"type": "object",
"required": [
"offer_text",
"description",
"name"
],
"description": "display details of the coupon.",
"properties": {
"name": {
"type": "string",
"description": "Name of coupon on Fynd Platform Panel."
},
"offer_text": {
"type": "string",
"description": "Coupon offer text to be shown on PDP or Cart."
},
"description": {
"type": "string",
"description": "Description of the coupon."
},
"offer_label": {
"type": [
"string",
"null"
],
"default": "",
"description": "Coupon offer Label to be shown on PDP or Cart."
}
}
},
"restrictions": {
"type": "object",
"required": [
"user_id",
"uses",
"user_registered",
"post_order",
"platforms",
"payments",
"user_groups",
"email_domain"
],
"description": "restrictions of coupons.",
"properties": {
"uses": {
"type": "object",
"required": [
"maximum",
"remaining"
],
"properties": {
"maximum": {
"type": "object",
"required": [
"user",
"total"
],
"properties": {
"user": {
"type": "integer",
"description": "Maximum number of times per user the coupon can be applied."
},
"total": {
"type": "integer",
"description": "Total number of times per user the coupon can be applied."
}
},
"description": "Defines maximum usage of coupon."
},
"remaining": {
"type": "object",
"required": [
"user",
"total"
],
"properties": {
"user": {
"type": "integer",
"description": "Uses done by the customer for the coupon."
},
"total": {
"type": "integer",
"description": "total number of times the coupon applied and order placed."
}
},
"description": "Defines total usage of coupon."
}
},
"description": "Maximum and remaining usage count for coupon used by user."
},
"user_id": {
"type": "array",
"items": {},
"description": "List of only allowed user _ids for whom coupon should be applicable."
},
"payments": {
"type": "object",
"properties": {},
"description": "Defines allowed payments for coupon, all if empty."
},
"platforms": {
"type": "array",
"items": [
{
"type": "string"
}
],
"description": "List of device platforms on which coupon is allowed. Possible values: web, ios, android."
},
"post_order": {
"type": "object",
"required": [
"cancellation_allowed",
"return_allowed"
],
"properties": {
"return_allowed": {
"type": "boolean",
"description": "Indicates whether customers can return an order purchased with coupon applied."
},
"cancellation_allowed": {
"type": "boolean",
"description": "Indicates whether customers can cancel an order purchased with coupon applied."
}
},
"description": "post order actions allowed after order created with coupon."
},
"user_groups": {
"type": "array",
"items": {},
"description": "List of user groups for whom coupon should be applicable."
},
"anonymous_users": {
"type": "boolean",
"description": "Allow anonymous users to avail this coupon."
},
"user_registered": {
"type": "object",
"properties": {
"end": {
"type": [
"string",
"null"
],
"description": "end date of user registration"
},
"start": {
"type": [
"string",
"null"
],
"description": "start date of user registration"
}
},
"description": "Allow coupon to be applied for users registered within specified dates."
},
"price_range": {
"type": "object",
"properties\"": {
"max": {
"type": "number",
"description": "max price range of cart."
},
"min": {
"type": "number",
"description": "min price range of cart."
}
},
"description": "price range for the coupon."
},
"user_type": {
"type": "string",
"description": "User type for which coupon is applicable."
},
"email_domain": {
"type": "array",
"description": "List of email domain on which coupon is applicable.",
"items": {
"type": "string"
}
},
"ordering_stores": {
"type": "array",
"description": "List of store id on which coupon is applicable.",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"application_id": {
"type": "string",
"description": "ID of the application (sales channel) where coupon is applicable."
},
"apply_priority": {
"type": "integer",
"description": "Priority of applying a coupon. Higher value coupons are applied first."
},
"discount_rules": {
"type": "array",
"items": [
{
"type": "object",
"required": [
"item_criteria",
"discount_type",
"buy_condition",
"offer"
],
"properties": {
"offer": {
"type": "object",
"properties": {},
"description": "Offer given by coupon."
},
"buy_condition": {
"type": "string",
"description": "buy condition of rules for the coupon."
},
"discount_type": {
"type": "string",
"description": "type of discount by coupon."
},
"item_criteria": {
"type": "object",
"properties": {},
"description": "item criteria that should meet to apply the coupon."
}
}
}
],
"description": "Discount rules for the coupon."
},
"promotion_type": {
"type": "string",
"description": "Promotion Type. Possible values: percentage, amount, fixed_price, bogo, contract_price, ladder_price, custom."
},
"apply_exclusive": {
"type": [
"string",
"null"
],
"description": "If allowed, any other coupon after current coupon is applied. Possible values: article, cart, null."
},
"post_order_action": {
"type": "object",
"properties": {
"action_date": {
"type": [
"string",
"null"
],
"description": "action data to be used to perform."
},
"action_type": {
"type": [
"string",
"null"
],
"description": "action type to be performed after order placed with coupon."
}
},
"description": "Details of post order action for the coupon."
},
"apply_all_discount": {
"type": "boolean",
"description": "Indicates whether multiple discount rules can be applied together or not."
}
}
}
}
}
},
"examples": [
{
"event": {
"trace_id": [
"megatron.3285dc2a-49de-4bec-b86c-39918b2ed0f5"
],
"name": "coupon",
"type": "update",
"version": "2",
"created_timestamp": 1711615911887,
"id": "7Fy18D99MxxCtbzaGBv4ATqlO+P7ujzPUDTGFIRt+aU=",
"category": "application"
},
"company_id": 6440,
"application_id": "657d3e74cc90c6a66842e990",
"contains": [
"coupon"
],
"payload": {
"coupon": {
"calculate_on": "esp",
"date_meta": {
"modified_on": "2024-03-28T08:51:51.871778+00:00",
"created_on": "2024-03-28T08:50:54.397000+00:00"
},
"apply_exclusive": null,
"currency": "INR",
"restrictions": {
"user_registered": {
"start": null,
"end": null
},
"user_id": [],
"uses": {
"maximum": {
"total": 0,
"user": 0
},
"remaining": {
"total": 0,
"user": 0
}
},
"user_groups": [],
"user_type": "all_user",
"ordering_stores": [],
"post_order": {
"return_allowed": true,
"cancellation_allowed": true
},
"email_domain": [],
"platforms": [
"web",
"android",
"ios"
],
"payments": {}
},
"application_id": "657d3e74cc90c6a66842e990",
"author": {
"modified_by": "c5c674ac6533f964a0b5948f",
"created_by": "c5c674ac6533f964a0b5948f"
},
"promotion_type": "percentage",
"display_meta": {
"name": "Test",
"description": "<p>Test 50</p>",
"offer_text": "50",
"offer_label": ""
},
"discount_rules": [
{
"offer": {
"discount_percentage": 50
},
"buy_condition": "( rule#1 )",
"discount_type": "percentage",
"item_criteria": {
"item_store": [
22754
]
}
}
],
"apply_priority": 1,
"_schedule": {
"duration": 0,
"next_schedule": [
{
"start": "2024-03-28T08:49:37+00:00",
"end": "2024-03-29T18:30:00+00:00"
}
],
"start": "2024-03-28T08:49:37+00:00",
"end": "2024-03-29T18:30:00+00:00",
"cron": "",
"published": true
},
"promo_group": "product",
"mode": "coupon",
"ownership": {
"payable_category": "seller",
"payable_by": ""
},
"stackable": true,
"visiblility": {
"pdp": true,
"coupon_list": false
},
"post_order_action": {
"action_date": null,
"action_type": ""
},
"apply_all_discount": false,
"_id": "66052f6e59001f59ae1bec27",
"buy_rules": {
"rule#1": {
"cart_quantity": {
"greater_than": 10,
"equals": 10
}
},
"rule#2": {
"item_brand": [
7594
]
}
}
}
}
}
]
}
}
🔧 Operation: application.courier-partner.message.courier-partner/assign/v1​
🔹 Entry 1​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
courier-partner.channels.event.messages.courier-partner/assign/v1.payload.components/schemas/courier-partner_assign_v1.properties.payload.properties.courier-partner.properties.pickup_details.properties.lat - New Schema:
{
"type": [
"number",
"null",
"string"
],
"description": "Latitude is the geographic coordinate that specifies the north-south position of an delivery address"
}
🔧 Operation: application.courier-partner.message.courier-partner/assign/v1​
🔹 Entry 2​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
courier-partner.channels.event.messages.courier-partner/assign/v1.payload.components/schemas/courier-partner_assign_v1.properties.payload.properties.courier-partner.properties.pickup_details.properties.long - New Schema:
{
"type": [
"number",
"null",
"string"
],
"description": "Longitude is the geographic coordinate that specifies the north-south position of an delivery address"
}
🔧 Operation: application.courier-partner.message.courier-partner/assign/v1​
🔹 Entry 3​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_ADDED - Path:
courier-partner.channels.event.messages.courier-partner/assign/v1.payload.components/schemas/courier-partner_assign_v1.properties.payload.properties.courier-partner.properties.pickup_details.required.11 - New Schema:
"lat"
🔧 Operation: application.courier-partner.message.courier-partner/assign/v1​
🔹 Entry 4​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_ADDED - Path:
courier-partner.channels.event.messages.courier-partner/assign/v1.payload.components/schemas/courier-partner_assign_v1.properties.payload.properties.courier-partner.properties.pickup_details.required.12 - New Schema:
"long"
🔧 Operation: application.courier-partner.message.courier-partner/assign/v1​
🔹 Entry 5​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_ADDED - Path:
courier-partner.channels.event.messages.courier-partner/assign/v1.payload.components/schemas/courier-partner_assign_v1.properties.payload.properties.courier-partner.properties.delivery_details.required.10 - New Schema:
"lat"
🔧 Operation: application.courier-partner.message.courier-partner/assign/v1​
🔹 Entry 6​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_ADDED - Path:
courier-partner.channels.event.messages.courier-partner/assign/v1.payload.components/schemas/courier-partner_assign_v1.properties.payload.properties.courier-partner.properties.delivery_details.required.11 - New Schema:
"long"
🔧 Operation: application.courier-partner.message.courier-partner/assign/v1​
🔹 Entry 7​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
courier-partner.channels.event.messages.courier-partner/assign/v1.payload.components/schemas/courier-partner_assign_v1.properties.payload.properties.courier-partner.properties.shipment_details.properties.items.items.properties.imei - New Schema:
{
"type": "string",
"description": "IMEI for the product"
}
🔧 Operation: application.courier-partner.message.courier-partner/assign/v1​
🔹 Entry 8​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
courier-partner.channels.event.messages.courier-partner/assign/v1.payload.components/schemas/courier-partner_assign_v1.properties.payload.properties.courier-partner.properties.shipment_details.properties.items.items.properties.serial_number - New Schema:
{
"type": "string",
"description": "Serial number for the product"
}
🔧 Operation: application.courier-partner.message.courier-partner/assign/v1​
🔹 Entry 9​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
courier-partner.channels.event.messages.courier-partner/assign/v1.payload.components/schemas/courier-partner_assign_v1.properties.payload.properties.courier-partner.properties.shipment_details.properties.items.items.properties.identifiers - New Schema:
{
"type": "object",
"description": "Identifier for the product"
}
🔧 Operation: application.courier-partner.message.courier-partner/ndr/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
MESSAGE_ADDED - Path:
courier-partner.channels.event.messages.courier-partner/ndr/v1 - New Schema:
{
"description": "this event is triggered when courier-partner is ndred",
"payload": {
"components/schemas/courier-partner_ndr_v1": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"properties": {
"courier-partner": {
"type": "object",
"properties": {
"extension_id": {
"type": "string"
},
"scheme_id": {
"type": "string"
},
"awb": {
"type": "string"
},
"action": {
"type": "string"
},
"schedule_date": {
"type": "string"
},
"delivery_address": {
"type": "object"
},
"alternate_phone": {
"type": "string"
},
"remark": {
"type": "string"
}
},
"required": [
"extension_id",
"awb"
]
},
"shipment_id": {
"type": "string"
}
},
"required": [
"courier-partner",
"shipment_id"
]
}
},
"examples": [
{
"event": {
"trace_id": [
"8fbfdacb721d99f2551612caffcf4626"
],
"name": "courier-partner",
"type": "ndr",
"version": "1",
"created_timestamp": 1714493912,
"id": "O8MqLspwLuLWfXQy+V+1mn4jYngKSVVNop56H0jxAVM=",
"category": "application",
"referer": "sit.fyndx1.de"
},
"company_id": 2,
"application_id": [
"64aed475db2cfb5b8a9f623d",
"*"
],
"contains": [
"shipment_info",
"shipment_id",
"courier-partner"
],
"payload": {
"shipment_info": {
"extension_id": "6543d9e612912d23cb13da1a",
"scheme_id": "6569e9eb0a578b0045552338",
"mixed_cart": false,
"order_creation_time": "2024-04-25T17:05:03+00:00",
"MPS": false,
"qc_required": true
},
"shipment_id": "17140449027591545985",
"courier-partner": {
"action": "re-schedule",
"remark": "fewfefwe",
"schedule_date": "2024-05-02T16:18:32.521183Z",
"alternate_phone": "9821012598",
"delivery_address": {
"address": "aterere",
"id": "66278f5e53c381c500fbe785",
"uid": 48923,
"area": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik",
"city": "PUNE",
"name": "ssss",
"email": "asmakhan@gofynd.com",
"phone": "9821012599",
"state": "MAHARASHTRA",
"sector": "",
"country": "India",
"pincode": "411045",
"user_id": 296,
"version": "1.0",
"address1": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik 724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik\nPUNE MAHARASHTRA 411045\nIndia",
"address2": "",
"landmark": "",
"latitude": 19.1570343,
"area_code": "411045",
"longitude": 72.93274439999999,
"created_at": "2024-04-25 17:05:02",
"state_code": "MH",
"updated_at": "2024-04-25 17:05:02",
"address_type": "office",
"country_code": "+91",
"geo_location": {
"latitude": 19.1570343,
"longitude": 72.93274439999999
},
"area_code_slug": "pincode",
"contact_person": "ssss",
"display_address": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik 724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik\nPUNE MAHARASHTRA 411045\nIndia",
"address_category": "",
"country_iso_code": "IN",
"country_phone_code": "+91",
"delivery_address_id": 48923
},
"awb": "6806110011756",
"auto_action_taken": false,
"extension_id": "6543d9e612912d23cb13da1a",
"scheme_id": "6569e9eb0a578b0045552338"
}
}
}
]
}
},
"schema": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"properties": {
"courier-partner": {
"type": "object",
"properties": {
"extension_id": {
"type": "string"
},
"scheme_id": {
"type": "string"
},
"awb": {
"type": "string"
},
"action": {
"type": "string"
},
"schedule_date": {
"type": "string"
},
"delivery_address": {
"type": "object"
},
"alternate_phone": {
"type": "string"
},
"remark": {
"type": "string"
}
},
"required": [
"extension_id",
"awb"
]
},
"shipment_id": {
"type": "string"
}
},
"required": [
"courier-partner",
"shipment_id"
]
}
},
"examples": [
{
"event": {
"trace_id": [
"8fbfdacb721d99f2551612caffcf4626"
],
"name": "courier-partner",
"type": "ndr",
"version": "1",
"created_timestamp": 1714493912,
"id": "O8MqLspwLuLWfXQy+V+1mn4jYngKSVVNop56H0jxAVM=",
"category": "application",
"referer": "sit.fyndx1.de"
},
"company_id": 2,
"application_id": [
"64aed475db2cfb5b8a9f623d",
"*"
],
"contains": [
"shipment_info",
"shipment_id",
"courier-partner"
],
"payload": {
"shipment_info": {
"extension_id": "6543d9e612912d23cb13da1a",
"scheme_id": "6569e9eb0a578b0045552338",
"mixed_cart": false,
"order_creation_time": "2024-04-25T17:05:03+00:00",
"MPS": false,
"qc_required": true
},
"shipment_id": "17140449027591545985",
"courier-partner": {
"action": "re-schedule",
"remark": "fewfefwe",
"schedule_date": "2024-05-02T16:18:32.521183Z",
"alternate_phone": "9821012598",
"delivery_address": {
"address": "aterere",
"id": "66278f5e53c381c500fbe785",
"uid": 48923,
"area": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik",
"city": "PUNE",
"name": "ssss",
"email": "asmakhan@gofynd.com",
"phone": "9821012599",
"state": "MAHARASHTRA",
"sector": "",
"country": "India",
"pincode": "411045",
"user_id": 296,
"version": "1.0",
"address1": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik 724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik\nPUNE MAHARASHTRA 411045\nIndia",
"address2": "",
"landmark": "",
"latitude": 19.1570343,
"area_code": "411045",
"longitude": 72.93274439999999,
"created_at": "2024-04-25 17:05:02",
"state_code": "MH",
"updated_at": "2024-04-25 17:05:02",
"address_type": "office",
"country_code": "+91",
"geo_location": {
"latitude": 19.1570343,
"longitude": 72.93274439999999
},
"area_code_slug": "pincode",
"contact_person": "ssss",
"display_address": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik 724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik\nPUNE MAHARASHTRA 411045\nIndia",
"address_category": "",
"country_iso_code": "IN",
"country_phone_code": "+91",
"delivery_address_id": 48923
},
"awb": "6806110011756",
"auto_action_taken": false,
"extension_id": "6543d9e612912d23cb13da1a",
"scheme_id": "6569e9eb0a578b0045552338"
}
}
}
]
}
}
🔧 Operation: application.domain.message.domain/create/v1​
🔹 Entry 1​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_ADDED - Path:
domain.channels.event.messages.domain/create/v1.payload.components/schemas/domain_create_v1.properties.payload.properties.domain.required.5 - New Schema:
"display_name"
🔧 Operation: application.domain.message.domain/create/v1​
🔹 Entry 2​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
domain.channels.event.messages.domain/create/v1.payload.components/schemas/domain_create_v1.properties.payload.properties.domain.properties.display_name - New Schema:
{
"type": "string",
"description": "Name of the domain"
}
🔧 Operation: application.domain.message.domain/delete/v1​
🔹 Entry 1​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_ADDED - Path:
domain.channels.event.messages.domain/delete/v1.payload.components/schemas/domain_delete_v1.properties.payload.properties.domain.required.5 - New Schema:
"display_name"
🔧 Operation: application.domain.message.domain/delete/v1​
🔹 Entry 2​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
domain.channels.event.messages.domain/delete/v1.payload.components/schemas/domain_delete_v1.properties.payload.properties.domain.properties.display_name - New Schema:
{
"type": "string",
"description": "Name of the domain"
}
🔧 Operation: application.order.message.order/payment_failed/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
order.channels.event.messages.order/payment_failed/v1.payload.components/schemas/order_payment_failed_v1.properties.payload.properties.order.properties.shipments.items.properties.bags.items.properties.line_number - New Schema:
{
"type": "number",
"description": "Unique identifier associated with each bag in a shipment"
}
🔧 Operation: application.order.message.order/payment_failed/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
order.channels.event.messages.order/payment_failed/v1.payload.components/schemas/order_payment_failed_v1.properties.payload.properties.order.properties.shipments.items.properties.bags.items.properties.bag_id - New Schema:
{
"type": "number",
"description": "The unique identifier associated with the bag"
}
🔧 Operation: application.order.message.order/payment_failed/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
order.channels.event.messages.order/payment_failed/v1.payload.components/schemas/order_payment_failed_v1.properties.payload.properties.order.properties.shipments.items.properties.payment_info - New Schema:
{
"type": "array",
"description": "Array of object containing payment methods used for placing an order.",
"items": {}
}
🔧 Operation: application.order.message.order/pending/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
order.channels.event.messages.order/pending/v1.payload.components/schemas/order_pending_v1.properties.payload.properties.order.properties.shipments.items.properties.bags.items.properties.line_number - New Schema:
{
"type": "number",
"description": "Unique identifier associated with each bag in a shipment"
}
🔧 Operation: application.order.message.order/pending/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
order.channels.event.messages.order/pending/v1.payload.components/schemas/order_pending_v1.properties.payload.properties.order.properties.shipments.items.properties.bags.items.properties.bag_id - New Schema:
{
"type": "number",
"description": "The unique identifier associated with the bag"
}
🔧 Operation: application.order.message.order/pending/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
order.channels.event.messages.order/pending/v1.payload.components/schemas/order_pending_v1.properties.payload.properties.order.properties.shipments.items.properties.payment_info - New Schema:
{
"type": "array",
"description": "Array of object containing payment methods used for placing an order.",
"items": {}
}
🔧 Operation: application.order.message.order/placed/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
order.channels.event.messages.order/placed/v1.payload.components/schemas/order_placed_v1.properties.payload.properties.order.properties.shipments.items.properties.bags.items.properties.line_number - New Schema:
{
"type": "number",
"description": "Unique identifier associated with each bag in a shipment"
}
🔧 Operation: application.order.message.order/placed/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
order.channels.event.messages.order/placed/v1.payload.components/schemas/order_placed_v1.properties.payload.properties.order.properties.shipments.items.properties.bags.items.properties.bag_id - New Schema:
{
"type": "number",
"description": "The unique identifier associated with the bag"
}
🔧 Operation: application.order.message.order/placed/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
order.channels.event.messages.order/placed/v1.payload.components/schemas/order_placed_v1.properties.payload.properties.order.properties.shipments.items.properties.payment_info - New Schema:
{
"type": "array",
"description": "Array of object containing payment methods used for placing an order.",
"items": {}
}
🔧 Operation: application.product.message.product/create/v2​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
MESSAGE_ADDED - Path:
product.channels.event.messages.product/create/v2 - New Schema:
{
"description": "this event is triggered when product is created",
"payload": {
"components/schemas/product_create_v2": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"properties": {
"product": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationProductsSchema"
}
}
}
}
}
}
},
"schema": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"properties": {
"product": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationProductsSchema"
}
}
}
}
}
}
}
🔧 Operation: application.product.message.product/delete/v2​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
MESSAGE_ADDED - Path:
product.channels.event.messages.product/delete/v2 - New Schema:
{
"description": "this event is triggered when product is deleted",
"payload": {
"components/schemas/product_delete_v2": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"required": [
"product"
],
"properties": {
"product": {
"type": "array",
"items": {
"type": "object",
"required": [
"item_id",
"company_id",
"brand_uid",
"item_code",
"uid"
],
"properties": {
"item_id": {
"type": "integer"
},
"uid": {
"type": "integer"
},
"company_id": {
"type": "integer"
},
"brand_uid": {
"type": "integer"
},
"item_code": {
"type": "string"
}
}
}
}
}
}
},
"examples": [
{
"event": {
"trace_id": [
"wildrider.e2a8d1a6-f660-11ee-b7a5-8edd95bdefe0"
],
"name": "product",
"type": "delete",
"version": "2",
"created_timestamp": 1712660647507,
"id": "lRlSMKsMiPDJeGTD3I+qQy0HlB5ahVEnD/G/PInOs5I=",
"category": "application",
"referer": "fyndx1.de"
},
"company_id": 1,
"application_id": [
"000000000000000000000001",
"*"
],
"contains": [
"product"
],
"payload": {
"product": [
{
"item_id": 7648605,
"company_id": 1,
"brand_uid": 65221,
"item_code": "DKJ789324789",
"uid": 7648605
}
]
}
}
]
}
},
"schema": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"required": [
"product"
],
"properties": {
"product": {
"type": "array",
"items": {
"type": "object",
"required": [
"item_id",
"company_id",
"brand_uid",
"item_code",
"uid"
],
"properties": {
"item_id": {
"type": "integer"
},
"uid": {
"type": "integer"
},
"company_id": {
"type": "integer"
},
"brand_uid": {
"type": "integer"
},
"item_code": {
"type": "string"
}
}
}
}
}
}
},
"examples": [
{
"event": {
"trace_id": [
"wildrider.e2a8d1a6-f660-11ee-b7a5-8edd95bdefe0"
],
"name": "product",
"type": "delete",
"version": "2",
"created_timestamp": 1712660647507,
"id": "lRlSMKsMiPDJeGTD3I+qQy0HlB5ahVEnD/G/PInOs5I=",
"category": "application",
"referer": "fyndx1.de"
},
"company_id": 1,
"application_id": [
"000000000000000000000001",
"*"
],
"contains": [
"product"
],
"payload": {
"product": [
{
"item_id": 7648605,
"company_id": 1,
"brand_uid": 65221,
"item_code": "DKJ789324789",
"uid": 7648605
}
]
}
}
]
}
}
🔧 Operation: application.product.message.product/update/v2​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
MESSAGE_ADDED - Path:
product.channels.event.messages.product/update/v2 - New Schema:
{
"description": "this event is triggered when product is updated",
"payload": {
"components/schemas/product_update_v2": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"properties": {
"product": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationProductsSchema"
}
}
}
}
}
}
},
"schema": {
"type": "object",
"required": [
"company_id",
"contains",
"event",
"payload",
"application_id"
],
"properties": {
"application_id": {
"type": [
"array",
"string"
],
"description": "sales channel ID for which this event is triggered"
},
"company_id": {
"type": "integer",
"description": "company ID for which this event is triggered"
},
"contains": {
"type": "array",
"description": "This array will have all the keys present at root level of 'payload' object",
"items": {
"type": "string"
}
},
"event": {
"type": "object",
"required": [
"category",
"created_timestamp",
"id",
"name",
"trace_id",
"type",
"version"
],
"properties": {
"category": {
"type": "string",
"description": "category of the event. If it is at sales channel level or company level"
},
"created_timestamp": {
"type": "integer",
"description": "event generation timestamp in epoch milliseconds"
},
"id": {
"type": "string",
"description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
},
"name": {
"type": "string",
"description": "Name of the event"
},
"trace_id": {
"type": "array",
"description": "internal trace_id for Fynd Platform services",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Type/Action of the event. e.g. create/update/delete"
},
"version": {
"type": "string",
"description": "Version of the event."
}
}
},
"payload": {
"type": "object",
"properties": {
"product": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationProductsSchema"
}
}
}
}
}
}
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 1​
- Action:
replace - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_UPDATED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.required.13 - New Schema:
"apply_exclusive"
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.author.properties.approved_by - New Schema:
{
"type": [
"string",
"null"
],
"default": null,
"nullable": true,
"description": "ID of the user who has approved the promotion."
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.author.properties.rejected_by - New Schema:
{
"type": [
"string",
"null"
],
"default": null,
"nullable": true,
"description": "ID of the user who has rejected the promotion"
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.author.properties.reviewed_by - New Schema:
{
"type": [
"string",
"null"
],
"default": null,
"nullable": true,
"description": "ID of the user who has submitted to review the promotion"
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 5​
- Action:
replace - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_UPDATED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties._schedule.required.0 - New Schema:
"status"
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 6​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties._schedule.properties.status - New Schema:
{
"type": "string",
"description": "Promotion status like draft, review.",
"enum": [
"approved",
"rejected",
"draft",
"review"
]
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 7​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.date_meta.properties.approved_on - New Schema:
{
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Promotion approved ISOdate."
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 8​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.date_meta.properties.rejected_on - New Schema:
{
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Promotion rejected ISOdate."
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 9​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.date_meta.properties.reviewed_on - New Schema:
{
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Promotion submitted for review ISOdate."
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 10​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.visiblility
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 11​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.display_meta.properties.offer_label - New Schema:
{
"type": [
"string",
"null"
],
"default": "",
"description": "Promotional offer Label to be shown on PDP or Cart."
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 12​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.restrictions.properties.user_type - New Schema:
{
"type": "string",
"description": "User type for which promotion is applicable."
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 13​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.restrictions.properties.email_domain - New Schema:
{
"type": "array",
"description": "List of email domain on which promotion is applicable.",
"items": {
"type": "string"
}
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 14​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.restrictions.properties.ordering_stores - New Schema:
{
"type": "array",
"description": "List of store id on which promotion is applicable.",
"items": {
"type": "integer",
"format": "int32"
}
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 15​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.reason - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Promotion rejection reason."
}
🔧 Operation: application.promotion.message.promotion/create/v1​
🔹 Entry 16​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/create/v1.payload.components/schemas/promotion_create_v1.properties.payload.properties.promotion.properties.visibility - New Schema:
{
"type": "object",
"required": [
"pdp",
"coupon_list"
],
"description": "visibility details of promotion.",
"properties": {
"pdp": {
"type": [
"boolean",
"null"
],
"nullable": true,
"description": "Show promotion on PDP page."
},
"coupon_list": {
"type": [
"boolean",
"null"
],
"nullable": true,
"description": "Show promotions under coupon list. Used when promotion mode is coupon."
}
}
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 1​
- Action:
replace - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_UPDATED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.required.13 - New Schema:
"apply_exclusive"
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.author.properties.approved_by - New Schema:
{
"type": [
"string",
"null"
],
"default": null,
"nullable": true,
"description": "ID of the user who has approved the promotion."
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.author.properties.rejected_by - New Schema:
{
"type": [
"string",
"null"
],
"default": null,
"nullable": true,
"description": "ID of the user who has rejected the promotion"
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.author.properties.reviewed_by - New Schema:
{
"type": [
"string",
"null"
],
"default": null,
"nullable": true,
"description": "ID of the user who has submitted to review the promotion"
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 5​
- Action:
replace - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_UPDATED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties._schedule.required.0 - New Schema:
"status"
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 6​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties._schedule.properties.status - New Schema:
{
"type": "string",
"description": "Promotion status like draft, review.",
"enum": [
"approved",
"rejected",
"draft",
"review"
]
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 7​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.date_meta.properties.approved_on - New Schema:
{
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Promotion approved ISOdate."
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 8​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.date_meta.properties.rejected_on - New Schema:
{
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Promotion rejected ISOdate."
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 9​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.date_meta.properties.reviewed_on - New Schema:
{
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"nullable": true,
"description": "Promotion submitted for review ISOdate."
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 10​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.visiblility
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 11​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.display_meta.properties.offer_label - New Schema:
{
"type": [
"string",
"null"
],
"default": "",
"description": "Promotional offer Label to be shown on PDP or Cart."
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 12​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.restrictions.properties.user_type - New Schema:
{
"type": "string",
"description": "User type for which promotion is applicable."
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 13​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.restrictions.properties.email_domain - New Schema:
{
"type": "array",
"description": "List of email domain on which promotion is applicable.",
"items": {
"type": "string"
}
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 14​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.restrictions.properties.ordering_stores - New Schema:
{
"type": "array",
"description": "List of store id on which promotion is applicable.",
"items": {
"type": "integer",
"format": "int32"
}
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 15​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.reason - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "Promotion rejection reason."
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 16​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.visibility - New Schema:
{
"type": "object",
"required": [
"pdp",
"coupon_list"
],
"description": "visibility details of promotion.",
"properties": {
"pdp": {
"type": "boolean",
"description": "Show promotion on PDP page."
},
"coupon_list": {
"type": "boolean",
"description": "Show promotions under coupon list. Used when promotion mode is coupon."
}
}
}
🔧 Operation: application.promotion.message.promotion/update/v1​
🔹 Entry 17​
- Action:
add - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
promotion.channels.event.messages.promotion/update/v1.payload.components/schemas/promotion_update_v1.properties.payload.properties.promotion.properties.apply_all_discount - New Schema:
{
"type": "boolean",
"description": "Indicates whether multiple discount rules can be applied together or not."
}
🔧 Operation: application.seo.message.seo/update/v1​
🔹 Entry 1​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_REMOVED - Path:
seo.channels.event.messages.seo/update/v1.payload.components/schemas/seo_update_v1.properties.payload.properties.seo.required.2
🔧 Operation: application.seo.message.seo/update/v1​
🔹 Entry 2​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
seo.channels.event.messages.seo/update/v1.payload.components/schemas/seo_update_v1.properties.payload.properties.seo.properties.sitemap_enabled
🔧 Operation: application.shipment.message.shipment/create/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/create/v1.payload.components/schemas/shipment_create_v1.properties.payload.properties.shipment.properties.article_details - New Schema:
{
"description": "Captures comprehensive status information for an article.",
"type": [
"object",
"null"
],
"nullable": true
}
🔧 Operation: application.shipment.message.shipment/create/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/create/v1.payload.components/schemas/shipment_create_v1.properties.payload.properties.shipment.properties.is_active - New Schema:
{
"description": "To get active shipments",
"type": "boolean"
}
🔧 Operation: application.shipment.message.shipment/create/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/create/v1.payload.components/schemas/shipment_create_v1.properties.payload.properties.shipment.properties.shipment_meta - New Schema:
{
"type": "object",
"description": "Meta information about the shipment",
"properties": {},
"required": []
}
🔧 Operation: application.shipment.message.shipment/create/v1​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/create/v1.payload.components/schemas/shipment_create_v1.properties.payload.properties.shipment.properties.transaction_meta - New Schema:
{
"type": "object",
"description": "Transaction related information",
"properties": {},
"required": []
}
🔧 Operation: application.shipment.message.shipment/create/v1​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/create/v1.payload.components/schemas/shipment_create_v1.properties.payload.properties.shipment.properties.meta - New Schema:
{
"type": "object",
"description": "Meta information about the shipment"
}
🔧 Operation: application.shipment.message.shipment/create/v1​
🔹 Entry 6​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/create/v1.payload.components/schemas/shipment_create_v1.properties.payload.properties.shipment.properties.forward_end_shipment_id - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "The forward_end_shipment_id represents the shipment ID of the original forward journey shipment. When a shipment is transitioned to a return journey, the original shipment ID from the forward journey is recorded in the forward_end_shipment_id field of the return journey shipment. Even if the return shipment is later split into multiple shipments, each of these shipments will retain the same forward_end_shipment_id value that was assigned during the initial return journey initiation. This ensures that all return shipments can be traced back to the original forward journey shipment."
}
🔧 Operation: application.shipment.message.shipment/create/v1​
🔹 Entry 7​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/create/v1.payload.components/schemas/shipment_create_v1.properties.payload.properties.shipment.properties.charges - New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceAdjustmentCharge"
}
}
🔧 Operation: application.shipment.message.shipment/create/v1​
🔹 Entry 8​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/create/v1.payload.components/schemas/shipment_create_v1.properties.payload.properties.shipment.properties.total_shipments_in_order - New Schema:
{
"type": "integer",
"description": "The total number of shipments in the order."
}
🔧 Operation: application.shipment.message.shipment/data_update/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/data_update/v1.payload.components/schemas/shipment_data_update_v1.properties.payload.properties.shipment.properties.article_details - New Schema:
{
"description": "Captures comprehensive status information for an article.",
"type": [
"object",
"null"
],
"nullable": true
}
🔧 Operation: application.shipment.message.shipment/data_update/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/data_update/v1.payload.components/schemas/shipment_data_update_v1.properties.payload.properties.shipment.properties.is_active - New Schema:
{
"description": "To get active shipments",
"type": "boolean"
}
🔧 Operation: application.shipment.message.shipment/data_update/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/data_update/v1.payload.components/schemas/shipment_data_update_v1.properties.payload.properties.shipment.properties.shipment_meta - New Schema:
{
"type": "object",
"description": "Meta information about the shipment",
"properties": {},
"required": []
}
🔧 Operation: application.shipment.message.shipment/data_update/v1​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/data_update/v1.payload.components/schemas/shipment_data_update_v1.properties.payload.properties.shipment.properties.transaction_meta - New Schema:
{
"type": "object",
"description": "Transaction related information",
"properties": {},
"required": []
}
🔧 Operation: application.shipment.message.shipment/data_update/v1​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/data_update/v1.payload.components/schemas/shipment_data_update_v1.properties.payload.properties.shipment.properties.meta - New Schema:
{
"type": "object",
"description": "Meta information about the shipment"
}
🔧 Operation: application.shipment.message.shipment/data_update/v1​
🔹 Entry 6​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/data_update/v1.payload.components/schemas/shipment_data_update_v1.properties.payload.properties.shipment.properties.forward_end_shipment_id - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "The forward_end_shipment_id represents the shipment ID of the original forward journey shipment. When a shipment is transitioned to a return journey, the original shipment ID from the forward journey is recorded in the forward_end_shipment_id field of the return journey shipment. Even if the return shipment is later split into multiple shipments, each of these shipments will retain the same forward_end_shipment_id value that was assigned during the initial return journey initiation. This ensures that all return shipments can be traced back to the original forward journey shipment."
}
🔧 Operation: application.shipment.message.shipment/data_update/v1​
🔹 Entry 7​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/data_update/v1.payload.components/schemas/shipment_data_update_v1.properties.payload.properties.shipment.properties.charges - New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceAdjustmentCharge"
}
}
🔧 Operation: application.shipment.message.shipment/data_update/v1​
🔹 Entry 8​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/data_update/v1.payload.components/schemas/shipment_data_update_v1.properties.payload.properties.shipment.properties.total_shipments_in_order - New Schema:
{
"type": "integer",
"description": "The total number of shipments in the order."
}
🔧 Operation: application.shipment.message.shipment/update/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/update/v1.payload.components/schemas/shipment_update_v1.properties.payload.properties.shipment.properties.article_details - New Schema:
{
"description": "Captures comprehensive status information for an article.",
"type": [
"object",
"null"
],
"nullable": true
}
🔧 Operation: application.shipment.message.shipment/update/v1​
🔹 Entry 2​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/update/v1.payload.components/schemas/shipment_update_v1.properties.payload.properties.shipment.properties.is_active - New Schema:
{
"description": "To get active shipments",
"type": "boolean"
}
🔧 Operation: application.shipment.message.shipment/update/v1​
🔹 Entry 3​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/update/v1.payload.components/schemas/shipment_update_v1.properties.payload.properties.shipment.properties.shipment_meta - New Schema:
{
"type": "object",
"description": "Meta information about the shipment",
"properties": {},
"required": []
}
🔧 Operation: application.shipment.message.shipment/update/v1​
🔹 Entry 4​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/update/v1.payload.components/schemas/shipment_update_v1.properties.payload.properties.shipment.properties.transaction_meta - New Schema:
{
"type": "object",
"description": "Transaction related information",
"properties": {},
"required": []
}
🔧 Operation: application.shipment.message.shipment/update/v1​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/update/v1.payload.components/schemas/shipment_update_v1.properties.payload.properties.shipment.properties.meta - New Schema:
{
"type": "object",
"description": "Meta information about the shipment"
}
🔧 Operation: application.shipment.message.shipment/update/v1​
🔹 Entry 6​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/update/v1.payload.components/schemas/shipment_update_v1.properties.payload.properties.shipment.properties.forward_end_shipment_id - New Schema:
{
"type": [
"string",
"null"
],
"nullable": true,
"description": "The forward_end_shipment_id represents the shipment ID of the original forward journey shipment. When a shipment is transitioned to a return journey, the original shipment ID from the forward journey is recorded in the forward_end_shipment_id field of the return journey shipment. Even if the return shipment is later split into multiple shipments, each of these shipments will retain the same forward_end_shipment_id value that was assigned during the initial return journey initiation. This ensures that all return shipments can be traced back to the original forward journey shipment."
}
🔧 Operation: application.shipment.message.shipment/update/v1​
🔹 Entry 7​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/update/v1.payload.components/schemas/shipment_update_v1.properties.payload.properties.shipment.properties.charges - New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceAdjustmentCharge"
}
}
🔧 Operation: application.shipment.message.shipment/update/v1​
🔹 Entry 8​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
shipment.channels.event.messages.shipment/update/v1.payload.components/schemas/shipment_update_v1.properties.payload.properties.shipment.properties.total_shipments_in_order - New Schema:
{
"type": "integer",
"description": "The total number of shipments in the order."
}
🔧 Operation: application.user.message.user/create/v1​
🔹 Entry 1​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
user.channels.event.messages.user/create/v1.payload.components/schemas/user_create_v1.properties.payload.items.properties.user.properties.rr_id - New Schema:
{
"description": "Unique Id assiciated with user",
"type": "string"
}
🔧 Operation: application.user.message.user/delete/v1​
🔹 Entry 1​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_REMOVED - Path:
user.channels.event.messages.user/delete/v1.payload.components/schemas/user_delete_v1.properties.event.required.0
🔧 Operation: application.user.message.user/delete/v1​
🔹 Entry 2​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_REMOVED - Path:
user.channels.event.messages.user/delete/v1.payload.components/schemas/user_delete_v1.properties.event.required.2
🔧 Operation: application.user.message.user/delete/v1​
🔹 Entry 3​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
user.channels.event.messages.user/delete/v1.payload.components/schemas/user_delete_v1.properties.event.properties.category
🔧 Operation: application.user.message.user/delete/v1​
🔹 Entry 4​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
user.channels.event.messages.user/delete/v1.payload.components/schemas/user_delete_v1.properties.event.properties.id
🔧 Operation: application.user.message.user/delete/v1​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
user.channels.event.messages.user/delete/v1.payload.components/schemas/user_delete_v1.properties.payload.items.properties.user.properties.rr_id - New Schema:
{
"description": "Unique Id assiciated with user",
"type": "string"
}
🔧 Operation: application.user.message.user/update/v1​
🔹 Entry 1​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_REMOVED - Path:
user.channels.event.messages.user/update/v1.payload.components/schemas/user_update_v1.properties.event.required.0
🔧 Operation: application.user.message.user/update/v1​
🔹 Entry 2​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_REQUIRED_REMOVED - Path:
user.channels.event.messages.user/update/v1.payload.components/schemas/user_update_v1.properties.event.required.2
🔧 Operation: application.user.message.user/update/v1​
🔹 Entry 3​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
user.channels.event.messages.user/update/v1.payload.components/schemas/user_update_v1.properties.event.properties.category
🔧 Operation: application.user.message.user/update/v1​
🔹 Entry 4​
- Action:
remove - Type:
breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_REMOVED - Path:
user.channels.event.messages.user/update/v1.payload.components/schemas/user_update_v1.properties.event.properties.id
🔧 Operation: application.user.message.user/update/v1​
🔹 Entry 5​
- Action:
add - Type:
non-breaking - xGroup:
application - Schema Ref:
N/A - Schema Action:
FIELD_IN_PROPERTIES_ADDED - Path:
user.channels.event.messages.user/update/v1.payload.components/schemas/user_update_v1.properties.payload.items.properties.user.properties.rr_id - New Schema:
{
"description": "Unique Id assiciated with user",
"type": "string"
}
🔧 Operation: application.zone.action.path​
🔹 Entry 1​
- Data:
"zone"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.required​
🔹 Entry 1​
- Data:
"company_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.required​
🔹 Entry 2​
- Data:
"contains"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.required​
🔹 Entry 3​
- Data:
"event"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.required​
🔹 Entry 4​
- Data:
"payload"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.required​
🔹 Entry 5​
- Data:
"application_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.application_id.type​
🔹 Entry 1​
- Data:
"array"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.application_id.type​
🔹 Entry 2​
- Data:
"string"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.event.required​
🔹 Entry 1​
- Data:
"category"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.event.required​
🔹 Entry 2​
- Data:
"created_timestamp"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.event.required​
🔹 Entry 3​
- Data:
"id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.event.required​
🔹 Entry 4​
- Data:
"name"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.event.required​
🔹 Entry 5​
- Data:
"trace_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.event.required​
🔹 Entry 6​
- Data:
"type"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.event.required​
🔹 Entry 7​
- Data:
"version"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.required​
🔹 Entry 1​
- Data:
"zone"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.zone.properties.stores.required​
🔹 Entry 1​
- Data:
"type"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.zone.properties.stores.required​
🔹 Entry 2​
- Data:
"values"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.zone.properties.product.properties.values.items.oneOf​
🔹 Entry 1​
- Action:
N/A - Type:
integer - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
N/A
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.zone.properties.product.properties.values.items.oneOf​
🔹 Entry 2​
- Action:
N/A - Type:
string - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
N/A
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.meta.required​
🔹 Entry 1​
- Data:
"event"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.meta.required​
🔹 Entry 2​
- Data:
"service"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.meta.required​
🔹 Entry 3​
- Data:
"zone_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.meta.required​
🔹 Entry 4​
- Data:
"company_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.meta.required​
🔹 Entry 5​
- Data:
"application_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.meta.required​
🔹 Entry 6​
- Data:
"trace_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.meta.required​
🔹 Entry 7​
- Data:
"created_timestamp"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.meta.properties.event.required​
🔹 Entry 1​
- Data:
"type"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.meta.properties.event.required​
🔹 Entry 2​
- Data:
"name"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.meta.properties.event.required​
🔹 Entry 3​
- Data:
"version"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.properties.payload.properties.meta.properties.service.required​
🔹 Entry 1​
- Data:
"name"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.payload.components/schemas/zone_create_v1.examples​
🔹 Entry 1​
- Action:
N/A - Type:
N/A - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
N/A
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.required​
🔹 Entry 1​
- Data:
"company_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.required​
🔹 Entry 2​
- Data:
"contains"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.required​
🔹 Entry 3​
- Data:
"event"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.required​
🔹 Entry 4​
- Data:
"payload"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.required​
🔹 Entry 5​
- Data:
"application_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.application_id.type​
🔹 Entry 1​
- Data:
"array"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.application_id.type​
🔹 Entry 2​
- Data:
"string"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.event.required​
🔹 Entry 1​
- Data:
"category"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.event.required​
🔹 Entry 2​
- Data:
"created_timestamp"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.event.required​
🔹 Entry 3​
- Data:
"id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.event.required​
🔹 Entry 4​
- Data:
"name"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.event.required​
🔹 Entry 5​
- Data:
"trace_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.event.required​
🔹 Entry 6​
- Data:
"type"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.event.required​
🔹 Entry 7​
- Data:
"version"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.required​
🔹 Entry 1​
- Data:
"zone"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.zone.properties.stores.required​
🔹 Entry 1​
- Data:
"type"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.zone.properties.stores.required​
🔹 Entry 2​
- Data:
"values"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.zone.properties.product.properties.values.items.oneOf​
🔹 Entry 1​
- Action:
N/A - Type:
integer - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
N/A
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.zone.properties.product.properties.values.items.oneOf​
🔹 Entry 2​
- Action:
N/A - Type:
string - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
N/A
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.meta.required​
🔹 Entry 1​
- Data:
"event"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.meta.required​
🔹 Entry 2​
- Data:
"service"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.meta.required​
🔹 Entry 3​
- Data:
"zone_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.meta.required​
🔹 Entry 4​
- Data:
"company_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.meta.required​
🔹 Entry 5​
- Data:
"application_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.meta.required​
🔹 Entry 6​
- Data:
"trace_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.meta.required​
🔹 Entry 7​
- Data:
"created_timestamp"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.meta.properties.event.required​
🔹 Entry 1​
- Data:
"type"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.meta.properties.event.required​
🔹 Entry 2​
- Data:
"name"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.meta.properties.event.required​
🔹 Entry 3​
- Data:
"version"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.properties.payload.properties.meta.properties.service.required​
🔹 Entry 1​
- Data:
"name"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/create/v1.schema.examples​
🔹 Entry 1​
- Action:
N/A - Type:
N/A - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
N/A
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.required​
🔹 Entry 1​
- Data:
"company_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.required​
🔹 Entry 2​
- Data:
"contains"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.required​
🔹 Entry 3​
- Data:
"event"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.required​
🔹 Entry 4​
- Data:
"payload"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.required​
🔹 Entry 5​
- Data:
"application_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.properties.application_id.type​
🔹 Entry 1​
- Data:
"array"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.properties.application_id.type​
🔹 Entry 2​
- Data:
"string"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.properties.event.required​
🔹 Entry 1​
- Data:
"category"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.properties.event.required​
🔹 Entry 2​
- Data:
"created_timestamp"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.properties.event.required​
🔹 Entry 3​
- Data:
"id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.properties.event.required​
🔹 Entry 4​
- Data:
"name"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.properties.event.required​
🔹 Entry 5​
- Data:
"trace_id"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.properties.event.required​
🔹 Entry 6​
- Data:
"type"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.properties.event.required​
🔹 Entry 7​
- Data:
"version"
🔧 Operation: application.zone.action.after.channels.event.messages.zone/delete/v1.payload.components/schemas/zone_delete_v1.properties.payload.required​
🔹 Entry 1​
- Data:
"zone"