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.
Events
application/location-price/create/v1
# this event is triggered when location price is create
application/location-price/update/v1
# this event is triggered when location price is updated
application/location-price/delete/v1
# this event is triggered when location is deleted
Payload
Hide
application_id
array of 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 have all the keys present at root level of 'payload' object
event
object
Required
Show
payload
object
Required
Show
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": "array",13 "items": {14 "type": "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 have all the keys present at root level of '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. If it is at sales channel level or company level"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 an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "prices"78 ],79 "properties": {80 "prices": {81 "type": "array",82 "items": {83 "type": "object",84 "required": [85 "uid",86 "size",87 "brand",88 "price",89 "store",90 "company",91 "item_id",92 "date_meta",93 "fynd_item_code",94 "seller_identifier",95 "is_active"96 ],97 "properties": {98 "uid": {99 "type": "string",100 "description": "Combination of item code and store ID to uniquely identify the article."101 },102 "fynd_item_code": {103 "type": "string",104 "description": "Fynd's unique internal code for the product."105 },106 "seller_identifier": {107 "type": "string",108 "description": "Unique identifier used by the seller for the product."109 },110 "size": {111 "type": "string",112 "description": "Product size (e.g., S, M, L, XL)."113 },114 "item_id": {115 "type": "integer",116 "description": "Unique identifier for the item."117 },118 "company": {119 "type": "object",120 "description": "Information about the company producing or selling the product.",121 "properties": {122 "id": {123 "type": "integer",124 "description": "Unique identifier for the company."125 }126 },127 "required": [128 "id"129 ]130 },131 "brand": {132 "type": "object",133 "description": "Details about the product's brand.",134 "properties": {135 "id": {136 "type": "integer",137 "description": "Unique identifier for the brand."138 }139 },140 "required": [141 "id"142 ]143 },144 "store": {145 "type": "object",146 "description": "Information about the store selling the product.",147 "properties": {148 "id": {149 "type": "integer",150 "description": "Unique identifier for the store."151 }152 },153 "required": [154 "id"155 ]156 },157 "price": {158 "type": "object",159 "description": "Pricing details of the product, including various price types.",160 "properties": {161 "transfer": {162 "type": "number",163 "description": "Transfer price of the product."164 },165 "effective": {166 "type": "number",167 "description": "Final price after applying discounts."168 },169 "currency": {170 "type": "string",171 "description": "Currency used for the product's pricing (e.g., USD, EUR)."172 },173 "marked": {174 "type": "number",175 "description": "Marked price or original listed price of the product."176 },177 "selling": {178 "type": "number",179 "description": "Selling price of the product."180 },181 "cost": {182 "type": "number",183 "description": "The original price incurred to produce or acquire a product before any markup."184 },185 "updated_at": {186 "type": [187 "string",188 "null"189 ],190 "format": "date-time",191 "description": "Date and time when the pricing information was last updated."192 }193 },194 "required": [195 "transfer",196 "effective",197 "currency",198 "marked"199 ]200 },201 "date_meta": {202 "type": "object",203 "description": "Timestamps for important events in the product's lifecycle.",204 "properties": {205 "created_on": {206 "type": "string",207 "format": "date-time",208 "description": "Date and time when the product was first created."209 },210 "modified_on": {211 "type": "string",212 "format": "date-time",213 "description": "Last modification timestamp of the product inventory details."214 },215 "added_on_store": {216 "type": "string",217 "format": "date-time",218 "description": "Date and time when the product was added to the store."219 },220 "inventory_updated_on": {221 "type": "string",222 "format": "date-time",223 "description": "Last inventory update timestamp."224 }225 }226 },227 "is_active": {228 "type": "boolean",229 "description": "Indicates if the product is currently active (available for sale)."230 },231 "stage": {232 "type": "string",233 "description": "Current stage of the product lifecycle (e.g., verified)."234 },235 "tags": {236 "type": "array",237 "description": "Tags or labels assigned to the product for categorization or search purposes.",238 "items": {239 "type": "string"240 }241 },242 "discount_meta": {243 "type": "object",244 "description": "Details of any discounts, including start/end times and countdown timers.",245 "properties": {246 "start": {247 "type": "string",248 "format": "date-time",249 "description": "Start date and time of the discount period."250 },251 "end": {252 "type": "string",253 "format": "date-time",254 "description": "End date and time of the discount period."255 },256 "timer": {257 "type": "boolean",258 "description": "Indicates if a countdown timer is active for the discount."259 }260 }261 },262 "discount_applied": {263 "type": "boolean",264 "description": "flag to know whether discount is applied or not."265 },266 "discount_job_id": {267 "type": "string",268 "description": "Identifier for the discount job, if any discount is live."269 }270 }271 }272 }273 }274 }275 }276}
Payload Example
1{2 "application_id": [3 "625e5411d6a31365b571800a",4 "*"5 ],6 "company_id": 2411,7 "contains": [8 "prices"9 ],10 "event": {11 "category": "application",12 "created_timestamp": 1712143541216,13 "id": "eCbEMUrjwV8UnqXRzSbRcCBj8hKZCc3rvqPxIXTZ2rE=",14 "name": "location-price",15 "trace_id": [16 "wildrider.e74aa68e-f1ac-11ee-aa5c-ca65ee4ea81f"17 ],18 "type": "create",19 "version": "1"20 },21 "payload": {22 "prices": [23 {24 "brand": {25 "id": 7526 },27 "company": {28 "id": 241129 },30 "date_meta": {31 "added_on_store": "test",32 "created_on": "test",33 "inventory_updated_on": "2024-04-03 11:25:38.723172",34 "modified_on": "2024-04-03 11:25:38.723172"35 },36 "fynd_item_code": "MCOP00015_SKYBLUE",37 "item_id": 8609293,38 "price": {39 "currency": "INR",40 "effective": 6500,41 "marked": 7999,42 "selling": 7000,43 "transfer": 044 },45 "seller_identifier": "MCOP00015_SKYBLUE_40",46 "size": "40/1.02M",47 "store": {48 "id": 1585649 },50 "uid": "15856_MCOP00015_SKYBLUE_40",51 "discount_meta": {52 "start": "2024-09-06T13:52:27Z",53 "end": "2024-09-06T14:20:27.304000Z",54 "timer": false55 },56 "discount_applied": true,57 "is_active": true,58 "stage": "verified",59 "tags": []60 }61 ]62 }63}
Payload
Hide
application_id
array of 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 have all the keys present at root level of 'payload' object
event
object
Required
Show
payload
object
Required
Show
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": "array",13 "items": {14 "type": "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 have all the keys present at root level of '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. If it is at sales channel level or company level"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 an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "prices"78 ],79 "properties": {80 "prices": {81 "type": "array",82 "items": {83 "type": "object",84 "required": [85 "uid",86 "size",87 "brand",88 "price",89 "store",90 "company",91 "item_id",92 "date_meta",93 "fynd_item_code",94 "seller_identifier",95 "is_active"96 ],97 "properties": {98 "uid": {99 "type": "string",100 "description": "Combination of item code and store ID to uniquely identify the article."101 },102 "fynd_item_code": {103 "type": "string",104 "description": "Fynd's unique internal code for the product."105 },106 "seller_identifier": {107 "type": "string",108 "description": "Unique identifier used by the seller for the product."109 },110 "size": {111 "type": "string",112 "description": "Product size (e.g., S, M, L, XL)."113 },114 "item_id": {115 "type": "integer",116 "description": "Unique identifier for the item."117 },118 "company": {119 "type": "object",120 "description": "Information about the company producing or selling the product.",121 "properties": {122 "id": {123 "type": "integer",124 "description": "Unique identifier for the company."125 }126 },127 "required": [128 "id"129 ]130 },131 "brand": {132 "type": "object",133 "description": "Details about the product's brand.",134 "properties": {135 "id": {136 "type": "integer",137 "description": "Unique identifier for the brand."138 }139 },140 "required": [141 "id"142 ]143 },144 "store": {145 "type": "object",146 "description": "Information about the store selling the product.",147 "properties": {148 "id": {149 "type": "integer",150 "description": "Unique identifier for the store."151 }152 },153 "required": [154 "id"155 ]156 },157 "price": {158 "type": "object",159 "description": "Pricing details of the product, including various price types.",160 "properties": {161 "transfer": {162 "type": "number",163 "description": "Transfer price of the product."164 },165 "effective": {166 "type": "number",167 "description": "Final price after applying discounts."168 },169 "currency": {170 "type": "string",171 "description": "Currency used for the product's pricing (e.g., USD, EUR)."172 },173 "marked": {174 "type": "number",175 "description": "Marked price or original listed price of the product."176 },177 "selling": {178 "type": "number",179 "description": "Selling price of the product."180 },181 "cost": {182 "type": "number",183 "description": "The original price incurred to produce or acquire a product before any markup."184 },185 "updated_at": {186 "type": [187 "string",188 "null"189 ],190 "format": "date-time",191 "description": "Date and time when the pricing information was last updated."192 }193 },194 "required": [195 "transfer",196 "effective",197 "currency",198 "marked"199 ]200 },201 "date_meta": {202 "type": "object",203 "description": "Timestamps for important events in the product's lifecycle.",204 "properties": {205 "created_on": {206 "type": "string",207 "format": "date-time",208 "description": "Date and time when the product was first created."209 },210 "modified_on": {211 "type": "string",212 "format": "date-time",213 "description": "Last modification timestamp of the product inventory details."214 },215 "added_on_store": {216 "type": "string",217 "format": "date-time",218 "description": "Date and time when the product was added to the store."219 },220 "inventory_updated_on": {221 "type": "string",222 "format": "date-time",223 "description": "Last inventory update timestamp."224 }225 }226 },227 "is_active": {228 "type": "boolean",229 "description": "Indicates if the product is currently active (available for sale)."230 },231 "stage": {232 "type": "string",233 "description": "Current stage of the product lifecycle (e.g., verified)."234 },235 "tags": {236 "type": "array",237 "description": "Tags or labels assigned to the product for categorization or search purposes.",238 "items": {239 "type": "string"240 }241 },242 "discount_meta": {243 "type": "object",244 "description": "Details of any discounts, including start/end times and countdown timers.",245 "properties": {246 "start": {247 "type": "string",248 "format": "date-time",249 "description": "Start date and time of the discount period."250 },251 "end": {252 "type": "string",253 "format": "date-time",254 "description": "End date and time of the discount period."255 },256 "timer": {257 "type": "boolean",258 "description": "Indicates if a countdown timer is active for the discount."259 }260 }261 },262 "discount_applied": {263 "type": "boolean",264 "description": "flag to know whether discount is applied or not."265 },266 "discount_job_id": {267 "type": "string",268 "description": "Identifier for the discount job, if any discount is live."269 }270 }271 }272 }273 }274 }275 }276}
Payload Example
1{2 "application_id": [3 "625e5411d6a31365b571800a",4 "*"5 ],6 "company_id": 2411,7 "contains": [8 "prices"9 ],10 "event": {11 "category": "application",12 "created_timestamp": 1712143541216,13 "id": "eCbEMUrjwV8UnqXRzSbRcCBj8hKZCc3rvqPxIXTZ2rE=",14 "name": "location-price",15 "trace_id": [16 "wildrider.e74aa68e-f1ac-11ee-aa5c-ca65ee4ea81f"17 ],18 "type": "update",19 "version": "1"20 },21 "payload": {22 "prices": [23 {24 "brand": {25 "id": 7526 },27 "company": {28 "id": 241129 },30 "date_meta": {31 "added_on_store": "test",32 "created_on": "test",33 "inventory_updated_on": "2024-04-03 11:25:38.723172",34 "modified_on": "2024-04-03 11:25:38.723172"35 },36 "fynd_item_code": "MCOP00015_SKYBLUE",37 "item_id": 8609293,38 "price": {39 "currency": "INR",40 "effective": 6500,41 "marked": 7999,42 "selling": 7000,43 "transfer": 044 },45 "seller_identifier": "MCOP00015_SKYBLUE_40",46 "size": "40/1.02M",47 "store": {48 "id": 1585649 },50 "uid": "15856_MCOP00015_SKYBLUE_40",51 "discount_meta": {52 "start": "2024-09-06T13:52:27Z",53 "end": "2024-09-06T14:20:27.304000Z",54 "timer": false55 },56 "discount_applied": true,57 "is_active": true,58 "stage": "verified",59 "tags": []60 }61 ]62 }63}
Payload
Hide
application_id
array of 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 have all the keys present at root level of 'payload' object
event
object
Required
Show
payload
object
Required
Show
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": "array",13 "items": {14 "type": "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 have all the keys present at root level of '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. If it is at sales channel level or company level"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 an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "prices"78 ],79 "properties": {80 "prices": {81 "type": "array",82 "items": {83 "type": "object",84 "required": [85 "uid",86 "size",87 "brand",88 "store",89 "company",90 "item_id",91 "fynd_item_code",92 "seller_identifier"93 ],94 "properties": {95 "uid": {96 "type": "string",97 "description": "Combination of item code and store ID to uniquely identify the article."98 },99 "fynd_item_code": {100 "type": "string",101 "description": "Fynd's unique internal code for the product."102 },103 "seller_identifier": {104 "type": "string",105 "description": "Unique identifier used by the seller for the product."106 },107 "size": {108 "type": "string",109 "description": "Product size (e.g., S, M, L, XL)."110 },111 "item_id": {112 "type": "integer",113 "description": "Unique identifier for the item."114 },115 "company": {116 "type": "object",117 "description": "Information about the company producing or selling the product.",118 "properties": {119 "id": {120 "type": "integer",121 "description": "Unique identifier for the company."122 }123 },124 "required": [125 "id"126 ]127 },128 "brand": {129 "type": "object",130 "description": "Details about the product's brand.",131 "properties": {132 "id": {133 "type": "integer",134 "description": "Unique identifier for the brand."135 }136 },137 "required": [138 "id"139 ]140 },141 "store": {142 "type": "object",143 "description": "Information about the store selling the product.",144 "properties": {145 "id": {146 "type": "integer",147 "description": "Unique identifier for the store."148 }149 },150 "required": [151 "id"152 ]153 }154 }155 }156 }157 }158 }159 }160}
Payload Example
1{2 "event": {3 "trace_id": [4 "wildrider.be76f10c-edd0-11ee-9d9e-024a9286e161"5 ],6 "name": "location-price",7 "type": "delete",8 "version": "1",9 "created_timestamp": 1711719129951,10 "id": "qlNoqByKLeAOXIc1b1VDFX9rKHePYE7r5ryWbnylDI8=",11 "category": "application"12 },13 "company_id": 46,14 "application_id": [15 "5eafc9121cfbb666d7959353",16 "*"17 ],18 "contains": [19 "prices"20 ],21 "payload": {22 "prices": [23 {24 "uid": "19592_000000410243861090",25 "fynd_item_code": "M1110008A@N6I",26 "seller_identifier": "000000410243861090",27 "size": "3XL",28 "item_id": 7737047,29 "company": {30 "id": 4631 },32 "brand": {33 "id": 23534 },35 "store": {36 "id": 1959237 }38 }39 ]40 }41}