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.

Location quantity

This event will be generated where there is any action done on location quantity

Events

application/location-quantity/create/v1

# this event is triggered when location quantity is created

application/location-quantity/update/v1

# this event is triggered when location quantity is updated

Location Quantity/location-quantity/create/v1

this event is triggered when location quantity is created

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

quantities

array of object

Required

Show

uid

string

Required

Combination of item code and store ID to uniquely identify the article.

fynd_item_code

string

Required

Fynd's unique internal code for the product.

seller_identifier

string

Required

Unique identifier used by the seller for the product.

size

string

Required

Product size (e.g., S, M, L, XL).

item_id

integer

Required

Unique identifier for the item.

company

object

Required

Information about the company producing or selling the product.

Show

brand

object

Required

Details about the product's brand.

Show

store

object

Required

Information about the store selling the product.

Show

quantities

object

Required

Information about product quantities, including available and unavailable stock.

Show

total_quantity

integer

Required

Total quantity available for the product.

expiration_date

string

Expiration or validity end date for the product.

date_meta

object

Required

Timestamps for important events in the product's lifecycle.

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        "quantities"
78      ],
79      "properties": {
80        "quantities": {
81          "type": "array",
82          "items": {
83            "type": "object",
84            "required": [
85              "uid",
86              "size",
87              "brand",
88              "store",
89              "company",
90              "item_id",
91              "date_meta",
92              "quantities",
93              "fynd_item_code",
94              "total_quantity",
95              "seller_identifier"
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              "quantities": {
158                "type": "object",
159                "description": "Information about product quantities, including available and unavailable stock.",
160                "properties": {
161                  "sellable": {
162                    "type": "object",
163                    "description": "Sellable stock information.",
164                    "properties": {
165                      "count": {
166                        "type": "integer",
167                        "description": "Number of sellable units available."
168                      },
169                      "updated_at": {
170                        "type": "string",
171                        "description": "Timestamp of the last sellable stock update."
172                      }
173                    }
174                  },
175                  "damaged": {
176                    "type": [
177                      "object",
178                      "null"
179                    ],
180                    "description": "Details of damaged stock.",
181                    "properties": {
182                      "count": {
183                        "type": "integer",
184                        "description": "Number of damaged units."
185                      },
186                      "updated_at": {
187                        "type": "string",
188                        "description": "Timestamp of the last damaged stock update."
189                      }
190                    }
191                  },
192                  "not_available": {
193                    "type": [
194                      "object",
195                      "null"
196                    ],
197                    "description": "Information about unavailable stock.",
198                    "properties": {
199                      "count": {
200                        "type": "integer",
201                        "description": "Number of unavailable units."
202                      },
203                      "updated_at": {
204                        "type": "string",
205                        "description": "Timestamp of the last unavailable stock update."
206                      }
207                    }
208                  },
209                  "order_committed": {
210                    "type": [
211                      "object",
212                      "null"
213                    ],
214                    "description": "Details of committed orders.",
215                    "properties": {
216                      "count": {
217                        "type": "integer",
218                        "description": "Number of units committed to orders."
219                      },
220                      "updated_at": {
221                        "type": "string",
222                        "description": "Timestamp of the last order committed update."
223                      }
224                    }
225                  }
226                }
227              },
228              "total_quantity": {
229                "type": "integer",
230                "description": "Total quantity available for the product."
231              },
232              "expiration_date": {
233                "type": "string",
234                "description": "Expiration or validity end date for the product."
235              },
236              "date_meta": {
237                "type": "object",
238                "description": "Timestamps for important events in the product's lifecycle.",
239                "properties": {
240                  "created_on": {
241                    "type": "string",
242                    "format": "date-time",
243                    "description": "Date and time when the product was first created."
244                  },
245                  "modified_on": {
246                    "type": "string",
247                    "format": "date-time",
248                    "description": "Last modification timestamp of the product inventory details."
249                  },
250                  "added_on_store": {
251                    "type": "string",
252                    "format": "date-time",
253                    "description": "Date and time when the product was added to the store."
254                  },
255                  "inventory_updated_on": {
256                    "type": "string",
257                    "format": "date-time",
258                    "description": "Last inventory update timestamp."
259                  }
260                }
261              }
262            }
263          }
264        }
265      }
266    }
267  }
268}

Payload Example

1{
2  "application_id": [
3    "625e5411d6a31365b571800a",
4    "*"
5  ],
6  "company_id": 2411,
7  "contains": [
8    "quantities"
9  ],
10  "event": {
11    "category": "application",
12    "created_timestamp": 1712143541216,
13    "id": "eCbEMUrjwV8UnqXRzSbRcCBj8hKZCc3rvqPxIXTZ2rE=",
14    "name": "location-quantity",
15    "trace_id": [
16      "wildrider.e74aa68e-f1ac-11ee-aa5c-ca65ee4ea81f"
17    ],
18    "type": "create",
19    "version": "1"
20  },
21  "payload": {
22    "quantities": [
23      {
24        "brand": {
25          "id": 75
26        },
27        "company": {
28          "id": 2411
29        },
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        "quantities": {
39          "damaged": {},
40          "not_available": {},
41          "sellable": {
42            "count": 1,
43            "updated_at": "2024-04-04 06:34:05.297180"
44          }
45        },
46        "total_quantity": 1,
47        "expiration_date": "9998-01-30 23:59:00",
48        "size": "40/1.02M",
49        "store": {
50          "id": 15856
51        },
52        "uid": "15856_MCOP00015_SKYBLUE_40"
53      }
54    ]
55  }
56}

Location Quantity/location-quantity/update/v1

this event is triggered when location quantity is updated

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

quantities

array of object

Required

Show

uid

string

Required

Combination of item code and store ID to uniquely identify the article.

fynd_item_code

string

Required

Fynd's unique internal code for the product.

seller_identifier

string

Required

Unique identifier used by the seller for the product.

size

string

Required

Product size (e.g., S, M, L, XL).

item_id

integer

Required

Unique identifier for the item.

company

object

Required

Information about the company producing or selling the product.

Show

brand

object

Required

Details about the product's brand.

Show

store

object

Required

Information about the store selling the product.

Show

quantities

object

Required

Information about product quantities, including available and unavailable stock.

Show

total_quantity

integer

Required

Total quantity available for the product.

expiration_date

string

Expiration or validity end date for the product.

date_meta

object

Required

Timestamps for important events in the product's lifecycle.

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        "quantities"
78      ],
79      "properties": {
80        "quantities": {
81          "type": "array",
82          "items": {
83            "type": "object",
84            "required": [
85              "uid",
86              "size",
87              "brand",
88              "store",
89              "company",
90              "item_id",
91              "date_meta",
92              "quantities",
93              "fynd_item_code",
94              "total_quantity",
95              "seller_identifier"
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              "quantities": {
158                "type": "object",
159                "description": "Information about product quantities, including available and unavailable stock.",
160                "properties": {
161                  "sellable": {
162                    "type": "object",
163                    "description": "Sellable stock information.",
164                    "properties": {
165                      "count": {
166                        "type": "integer",
167                        "description": "Number of sellable units available."
168                      },
169                      "updated_at": {
170                        "type": "string",
171                        "description": "Timestamp of the last sellable stock update."
172                      }
173                    }
174                  },
175                  "damaged": {
176                    "type": [
177                      "object",
178                      "null"
179                    ],
180                    "description": "Details of damaged stock.",
181                    "properties": {
182                      "count": {
183                        "type": "integer",
184                        "description": "Number of damaged units."
185                      },
186                      "updated_at": {
187                        "type": "string",
188                        "description": "Timestamp of the last damaged stock update."
189                      }
190                    }
191                  },
192                  "not_available": {
193                    "type": [
194                      "object",
195                      "null"
196                    ],
197                    "description": "Information about unavailable stock.",
198                    "properties": {
199                      "count": {
200                        "type": "integer",
201                        "description": "Number of unavailable units."
202                      },
203                      "updated_at": {
204                        "type": "string",
205                        "description": "Timestamp of the last unavailable stock update."
206                      }
207                    }
208                  },
209                  "order_committed": {
210                    "type": [
211                      "object",
212                      "null"
213                    ],
214                    "description": "Details of committed orders.",
215                    "properties": {
216                      "count": {
217                        "type": "integer",
218                        "description": "Number of units committed to orders."
219                      },
220                      "updated_at": {
221                        "type": "string",
222                        "description": "Timestamp of the last order committed update."
223                      }
224                    }
225                  }
226                }
227              },
228              "total_quantity": {
229                "type": "integer",
230                "description": "Total quantity available for the product."
231              },
232              "expiration_date": {
233                "type": "string",
234                "description": "Expiration or validity end date for the product."
235              },
236              "date_meta": {
237                "type": "object",
238                "description": "Timestamps for important events in the product's lifecycle.",
239                "properties": {
240                  "created_on": {
241                    "type": "string",
242                    "format": "date-time",
243                    "description": "Date and time when the product was first created."
244                  },
245                  "modified_on": {
246                    "type": "string",
247                    "format": "date-time",
248                    "description": "Last modification timestamp of the product inventory details."
249                  },
250                  "added_on_store": {
251                    "type": "string",
252                    "format": "date-time",
253                    "description": "Date and time when the product was added to the store."
254                  },
255                  "inventory_updated_on": {
256                    "type": "string",
257                    "format": "date-time",
258                    "description": "Last inventory update timestamp."
259                  }
260                }
261              }
262            }
263          }
264        }
265      }
266    }
267  }
268}

Payload Example

1{
2  "application_id": [
3    "625e5411d6a31365b571800a",
4    "*"
5  ],
6  "company_id": 2411,
7  "contains": [
8    "quantities"
9  ],
10  "event": {
11    "category": "application",
12    "created_timestamp": 1712143541216,
13    "id": "eCbEMUrjwV8UnqXRzSbRcCBj8hKZCc3rvqPxIXTZ2rE=",
14    "name": "location-quantity",
15    "trace_id": [
16      "wildrider.e74aa68e-f1ac-11ee-aa5c-ca65ee4ea81f"
17    ],
18    "type": "update",
19    "version": "1"
20  },
21  "payload": {
22    "quantities": [
23      {
24        "brand": {
25          "id": 75
26        },
27        "company": {
28          "id": 2411
29        },
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        "quantities": {
39          "damaged": {},
40          "not_available": {},
41          "sellable": {
42            "count": 1,
43            "updated_at": "2024-04-04 06:34:05.297180"
44          }
45        },
46        "total_quantity": 1,
47        "expiration_date": "9998-01-30 23:59:00",
48        "size": "40/1.02M",
49        "store": {
50          "id": 15856
51        },
52        "uid": "15856_MCOP00015_SKYBLUE_40"
53      }
54    ]
55  }
56}

« location-price/create/v1

merchandising/create/v1 »