Application
Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.
This specification defines merchandising rule events for create, update, and delete actions. The message schemas are structured similarly to the collection events.
Events
application/merchandising/create/v1
# This event is triggered when a merchandising rule is created.
application/merchandising/update/v1
# This event is triggered when a merchandising rule is updated.
application/merchandising/delete/v1
# This event is triggered when a merchandising rule is deleted.
Payload
Properties
application_id
array|string
Required
Sales channel ID for which this event is triggered.
company_id
integer
Required
Company ID for which this event is triggered.
contains
array of string
Required
This array will list all the keys present at the root level of the payload object.
event
object
Required
Properties
category
string
Required
Category of the event.
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds.
id
string
Required
Unique ID for the event.
name
string
Required
Name of the event.
trace_id
array of string
Required
Trace IDs for the event.
type
string
Required
Type/Action of the event (e.g., create).
version
string
Required
Version of the event.
payload
object
Required
Properties
merchandising
object
Required
Merchandising rule details.
Properties
query
object
Query details for merchandising.
Properties
collection
object
Collection details for merchandising.
Properties
display_name
string
Specifies the name of the collection to which the merchandising will be applied.
slug
string
Specifies the slug of the collection to which the merchandising will be applied.
filter
array of object
Array of Properties
attribute
string
value
string
display_name
string
query_condition
string
merchandising_rule_id
string
ID of the merchandising rule.
status
string
Status of the merchandising rule.
is_active
boolean
Indicates if the merchandising rule is active.
_schedule
object
Properties
cron
string
Nullable
duration
integer
Nullable
end
string
Nullable
next_schedule
array of object
Array of Properties
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
rule_name
string
Name of the merchandising rule.
actions
object
Properties
pin
object
Properties
item_ids
array of integer
hide
object
Properties
item_ids
array of integer
boost
array of object
Array of Properties
strength
number
display_name
string
value
string
attribute
string
bury
array of object
Array of Properties
strength
number
display_name
string
value
string
attribute
string
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "Sales channel ID for which this event is triggered."17 },18 "company_id": {19 "type": "integer",20 "description": "Company ID for which this event is triggered."21 },22 "contains": {23 "type": "array",24 "description": "This array will list all the keys present at the root level of the payload object.",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "Category of the event."44 },45 "created_timestamp": {46 "type": "integer",47 "description": "Event generation timestamp in epoch milliseconds."48 },49 "id": {50 "type": "string",51 "description": "Unique ID for the event."52 },53 "name": {54 "type": "string",55 "description": "Name of the event."56 },57 "trace_id": {58 "type": "array",59 "items": {60 "type": "string"61 },62 "description": "Trace IDs for the event."63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event (e.g., create)."67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "merchandising"78 ],79 "properties": {80 "merchandising": {81 "type": "object",82 "description": "Merchandising rule details.",83 "properties": {84 "query": {85 "type": "object",86 "description": "Query details for merchandising.",87 "properties": {88 "collection": {89 "description": "Collection details for merchandising.",90 "type": "object",91 "properties": {92 "display_name": {93 "type": "string",94 "description": "Specifies the name of the collection to which the merchandising will be applied."95 },96 "slug": {97 "type": "string",98 "description": "Specifies the slug of the collection to which the merchandising will be applied."99 }100 }101 },102 "filter": {103 "type": "array",104 "items": {105 "type": "object",106 "properties": {107 "attribute": {108 "type": "string"109 },110 "value": {111 "type": "string"112 },113 "display_name": {114 "type": "string"115 }116 }117 }118 },119 "query_condition": {120 "type": "string"121 }122 }123 },124 "merchandising_rule_id": {125 "type": "string",126 "description": "ID of the merchandising rule."127 },128 "status": {129 "type": "string",130 "description": "Status of the merchandising rule."131 },132 "is_active": {133 "type": "boolean",134 "description": "Indicates if the merchandising rule is active."135 },136 "_schedule": {137 "type": "object",138 "properties": {139 "cron": {140 "type": "string",141 "nullable": true142 },143 "duration": {144 "type": "integer",145 "nullable": true146 },147 "end": {148 "type": "string",149 "nullable": true150 },151 "next_schedule": {152 "type": "array",153 "items": {154 "type": "object",155 "properties": {156 "end": {157 "type": "string",158 "format": "date-time",159 "nullable": true,160 "description": "The end time of the schedule."161 },162 "start": {163 "type": "string",164 "format": "date-time",165 "description": "The start time of the schedule."166 }167 }168 }169 },170 "start": {171 "type": "string"172 }173 }174 },175 "rule_name": {176 "type": "string",177 "description": "Name of the merchandising rule."178 },179 "actions": {180 "type": "object",181 "properties": {182 "pin": {183 "type": "object",184 "properties": {185 "item_ids": {186 "type": "array",187 "items": {188 "type": "integer"189 }190 }191 }192 },193 "hide": {194 "type": "object",195 "properties": {196 "item_ids": {197 "type": "array",198 "items": {199 "type": "integer"200 }201 }202 }203 },204 "boost": {205 "type": "array",206 "items": {207 "type": "object",208 "properties": {209 "strength": {210 "type": "number"211 },212 "display_name": {213 "type": "string"214 },215 "value": {216 "type": "string"217 },218 "attribute": {219 "type": "string"220 }221 }222 }223 },224 "bury": {225 "type": "array",226 "items": {227 "type": "object",228 "properties": {229 "strength": {230 "type": "number"231 },232 "display_name": {233 "type": "string"234 },235 "value": {236 "type": "string"237 },238 "attribute": {239 "type": "string"240 }241 }242 }243 }244 }245 }246 }247 }248 }249 }250 }251}
Payload Example
1{2 "application_id": [3 "66e038b5e625de0c4fa9fd08",4 "*"5 ],6 "company_id": 1,7 "contains": [8 "merchandising"9 ],10 "event": {11 "type": "create",12 "name": "merchandising",13 "version": "1",14 "trace_id": [15 "silverbolt.19e41b4e-3094-11f0-b806-86ce010b3888"16 ],17 "created_timestamp": 1747207309615,18 "category": "merchandising"19 },20 "payload": {21 "merchandising": {22 "merchandising_rule_id": "uzx2b5fomo",23 "status": "live",24 "is_active": true,25 "rule_name": "AC Merchandising Rule",26 "_schedule": {27 "start": "2025-05-13T09:22:31.953000Z",28 "end": null29 },30 "query": {31 "filter": [32 {33 "value": "electronics",34 "display_name": "Electronics",35 "attribute": "department"36 }37 ],38 "query": {39 "search_query": "PHONE",40 "condition": "contains",41 "synonyms": true42 },43 "query_condition": "search_query",44 "collection": {45 "slug": "smartphones",46 "display_name": "smartphones"47 }48 },49 "actions": {50 "pin": {51 "item_ids": [52 7500527,53 750026554 ]55 },56 "boost": [57 {58 "attribute": "category",59 "value": "mobile-cases",60 "strength": 12,61 "display_name": "Mobile Cases"62 }63 ],64 "bury": [65 {66 "attribute": "brand",67 "value": "lg",68 "strength": 12,69 "display_name": "LG"70 }71 ],72 "hide": {73 "item_ids": [74 750390475 ]76 }77 }78 }79 }80}
Payload
Properties
application_id
array|string
Required
Sales channel ID for which this event is triggered.
company_id
integer
Required
Company ID for which this event is triggered.
contains
array of string
Required
This array will list all the keys present at the root level of the payload object.
event
object
Required
Properties
category
string
Required
Category of the event.
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds.
id
string
Required
Unique ID for the event.
name
string
Required
Name of the event.
trace_id
array of string
Required
Trace IDs for the event.
type
string
Required
Type/Action of the event (e.g., update).
version
string
Required
Version of the event.
payload
object
Required
Properties
merchandising
object
Required
Merchandising rule details.
Properties
query
object
Query details for merchandising.
Properties
collection
object
Collection details for merchandising.
Properties
display_name
string
Specifies the name of the collection to which the merchandising will be applied.
slug
string
Specifies the slug of the collection to which the merchandising will be applied.
filter
array of object
Array of Properties
attribute
string
value
string
display_name
string
query_condition
string
merchandising_rule_id
string
ID of the merchandising rule.
status
string
Status of the merchandising rule.
is_active
boolean
Indicates if the merchandising rule is active.
_schedule
object
Properties
cron
string
Nullable
duration
integer
Nullable
end
string
Nullable
next_schedule
array of object
Array of Properties
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
rule_name
string
Name of the merchandising rule.
actions
object
Properties
pin
object
Properties
item_ids
array of integer
hide
object
Properties
item_ids
array of integer
boost
array of object
Array of Properties
strength
number
display_name
string
value
string
attribute
string
bury
array of object
Array of Properties
strength
number
display_name
string
value
string
attribute
string
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "Sales channel ID for which this event is triggered."17 },18 "company_id": {19 "type": "integer",20 "description": "Company ID for which this event is triggered."21 },22 "contains": {23 "type": "array",24 "description": "This array will list all the keys present at the root level of the payload object.",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "Category of the event."44 },45 "created_timestamp": {46 "type": "integer",47 "description": "Event generation timestamp in epoch milliseconds."48 },49 "id": {50 "type": "string",51 "description": "Unique ID for the event."52 },53 "name": {54 "type": "string",55 "description": "Name of the event."56 },57 "trace_id": {58 "type": "array",59 "items": {60 "type": "string"61 },62 "description": "Trace IDs for the event."63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event (e.g., update)."67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "merchandising"78 ],79 "properties": {80 "merchandising": {81 "type": "object",82 "description": "Merchandising rule details.",83 "properties": {84 "query": {85 "type": "object",86 "description": "Query details for merchandising.",87 "properties": {88 "collection": {89 "description": "Collection details for merchandising.",90 "type": "object",91 "properties": {92 "display_name": {93 "type": "string",94 "description": "Specifies the name of the collection to which the merchandising will be applied."95 },96 "slug": {97 "type": "string",98 "description": "Specifies the slug of the collection to which the merchandising will be applied."99 }100 }101 },102 "filter": {103 "type": "array",104 "items": {105 "type": "object",106 "properties": {107 "attribute": {108 "type": "string"109 },110 "value": {111 "type": "string"112 },113 "display_name": {114 "type": "string"115 }116 }117 }118 },119 "query_condition": {120 "type": "string"121 }122 }123 },124 "merchandising_rule_id": {125 "type": "string",126 "description": "ID of the merchandising rule."127 },128 "status": {129 "type": "string",130 "description": "Status of the merchandising rule."131 },132 "is_active": {133 "type": "boolean",134 "description": "Indicates if the merchandising rule is active."135 },136 "_schedule": {137 "type": "object",138 "properties": {139 "cron": {140 "type": "string",141 "nullable": true142 },143 "duration": {144 "type": "integer",145 "nullable": true146 },147 "end": {148 "type": "string",149 "nullable": true150 },151 "next_schedule": {152 "type": "array",153 "items": {154 "type": "object",155 "properties": {156 "end": {157 "type": "string",158 "format": "date-time",159 "nullable": true,160 "description": "The end time of the schedule."161 },162 "start": {163 "type": "string",164 "format": "date-time",165 "description": "The start time of the schedule."166 }167 }168 }169 },170 "start": {171 "type": "string"172 }173 }174 },175 "rule_name": {176 "type": "string",177 "description": "Name of the merchandising rule."178 },179 "actions": {180 "type": "object",181 "properties": {182 "pin": {183 "type": "object",184 "properties": {185 "item_ids": {186 "type": "array",187 "items": {188 "type": "integer"189 }190 }191 }192 },193 "hide": {194 "type": "object",195 "properties": {196 "item_ids": {197 "type": "array",198 "items": {199 "type": "integer"200 }201 }202 }203 },204 "boost": {205 "type": "array",206 "items": {207 "type": "object",208 "properties": {209 "strength": {210 "type": "number"211 },212 "display_name": {213 "type": "string"214 },215 "value": {216 "type": "string"217 },218 "attribute": {219 "type": "string"220 }221 }222 }223 },224 "bury": {225 "type": "array",226 "items": {227 "type": "object",228 "properties": {229 "strength": {230 "type": "number"231 },232 "display_name": {233 "type": "string"234 },235 "value": {236 "type": "string"237 },238 "attribute": {239 "type": "string"240 }241 }242 }243 }244 }245 }246 }247 }248 }249 }250 }251}
Payload Example
1{2 "application_id": [3 "66e038b5e625de0c4fa9fd08",4 "*"5 ],6 "company_id": 1,7 "contains": [8 "merchandising"9 ],10 "event": {11 "type": "update",12 "name": "merchandising",13 "version": "1",14 "trace_id": [15 "silverbolt.19e41b4e-3094-11f0-b806-86ce010b3888"16 ],17 "created_timestamp": 1747207309615,18 "category": "merchandising"19 },20 "payload": {21 "merchandising": {22 "merchandising_rule_id": "uzx2b5fomo",23 "status": "live",24 "is_active": true,25 "rule_name": "AC Merchandising Rule",26 "_schedule": {27 "start": "2025-05-13T09:22:31.953000Z",28 "end": null29 },30 "query": {31 "filter": [32 {33 "value": "electronics",34 "display_name": "Electronics",35 "attribute": "department"36 }37 ],38 "query": {39 "search_query": "PHONE",40 "condition": "contains",41 "synonyms": true42 },43 "query_condition": "search_query",44 "collection": {45 "slug": "smartphones",46 "display_name": "smartphones"47 }48 },49 "actions": {50 "pin": {51 "item_ids": [52 7500527,53 750026554 ]55 },56 "boost": [57 {58 "attribute": "category",59 "value": "mobile-cases",60 "strength": 12,61 "display_name": "Mobile Cases"62 }63 ],64 "bury": [65 {66 "attribute": "brand",67 "value": "lg",68 "strength": 12,69 "display_name": "LG"70 }71 ],72 "hide": {73 "item_ids": [74 750390475 ]76 }77 }78 }79 }80}
Payload
Properties
application_id
array|string
Required
Sales channel ID for which this event is triggered.
company_id
integer
Required
Company ID for which this event is triggered.
contains
array of string
Required
This array will list all the keys present at the root level of the payload object.
event
object
Required
Properties
category
string
Required
Category of the event.
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds.
id
string
Required
Unique ID for the event.
name
string
Required
Name of the event.
trace_id
array of string
Required
Trace IDs for the event.
type
string
Required
Type/Action of the event (e.g., delete).
version
string
Required
Version of the event.
payload
object
Required
Properties
merchandising
object
Required
Merchandising rule details.
Properties
merchandising_rule_id
string
ID of the merchandising rule.
rule_name
string
Name of the merchandising rule.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "Sales channel ID for which this event is triggered."17 },18 "company_id": {19 "type": "integer",20 "description": "Company ID for which this event is triggered."21 },22 "contains": {23 "type": "array",24 "description": "This array will list all the keys present at the root level of the payload object.",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "Category of the event."44 },45 "created_timestamp": {46 "type": "integer",47 "description": "Event generation timestamp in epoch milliseconds."48 },49 "id": {50 "type": "string",51 "description": "Unique ID for the event."52 },53 "name": {54 "type": "string",55 "description": "Name of the event."56 },57 "trace_id": {58 "type": "array",59 "items": {60 "type": "string"61 },62 "description": "Trace IDs for the event."63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event (e.g., delete)."67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "merchandising"78 ],79 "properties": {80 "merchandising": {81 "type": "object",82 "description": "Merchandising rule details.",83 "properties": {84 "merchandising_rule_id": {85 "type": "string",86 "description": "ID of the merchandising rule."87 },88 "rule_name": {89 "type": "string",90 "description": "Name of the merchandising rule."91 }92 }93 }94 }95 }96 }97}
Payload Example
1{2 "application_id": [3 "66e038b5e625de0c4fa9fd08",4 "*"5 ],6 "company_id": 1,7 "contains": [8 "merchandising"9 ],10 "event": {11 "type": "delete",12 "name": "merchandising",13 "version": "1",14 "trace_id": [15 "silverbolt.19e41b4e-3094-11f0-b806-86ce010b3888"16 ],17 "created_timestamp": 1747207309615,18 "category": "merchandising"19 },20 "payload": {21 "merchandising": {22 "merchandising_rule_id": "uzx2b5fomo",23 "rule_name": "AC Merchandising Rule"24 }25 }26}