Webhooks
Overview
Webhook Configuration
Filters and Reducer
Best Practices
Kafka
Amazon EventBridge
Amazon SQS
Google Pub/Sub
Temporal
Change Log
article/create/v1
article/update/v1
article/delete/v1
brand/create/v1
brand/update/v1
company/create/v2
company/update/v2
company/delete/v2
courier-partner/account-status/v1
customfield_definition/create/v1
customfield_definition/update/v1
customfield_definition/delete/v1
customfields/inventory-update/v1
customfields/inventory-delete/v1
customfields/product-update/v1
customfields/product-delete/v1
customfields/product-size-update/v1
customfields/product-size-delete/v1
customfields/selling-location-update/v1
customobject_definition/create/v1
customobject_definition/update/v1
customobject_definition/delete/v1
customobjects/create/v1
customobjects/update/v1
customobjects/delete/v1
location/create/v2
location/update/v2
location-price/create/v1
location-price/update/v1
location-price/delete/v1
location-quantity/create/v1
location-quantity/update/v1
logistics-configuration/update/v1
product/create/v3
product/update/v3
product/delete/v3
product-size/create/v2
product-size/delete/v2
product-size/update/v2
support-ticket/create/v1
support-ticket/update/v1
address/create/v1
address/update/v1
address/delete/v1
article/create/v1
article/update/v1
article/delete/v1
available_pages/create/v1
available_pages/update/v1
available_pages/delete/v1
cart/create/v1
cart/update/v1
cart-price-adjustment/create/v1
cart-price-adjustment/update/v1
cart-price-adjustment/remove/v1
collection/create/v2
collection/update/v2
collection/delete/v2
configuration/create/v1
configuration/update/v1
coupon/create/v1
coupon/update/v1
coupon/redeem/v1
courier-partner/assign/v1
courier-partner/ndr/v1
courier-partner/cancel/v1
customer_credit_note_configuration/create/v1
customer_credit_note_configuration/update/v1
customfield_definition/create/v1
customfield_definition/update/v1
customfield_definition/delete/v1
customfields/bag-update/v1
customfields/coupon-update/v1
customfields/product-update/v1
customfields/promotion-update/v1
customobject_definition/create/v1
customobject_definition/update/v1
customobject_definition/delete/v1
customobjects/create/v1
customobjects/update/v1
customobjects/delete/v1
details_groups/create/v1
details_groups/update/v1
details_groups/delete/v1
discount/create/v1
discount/update/v1
discount/start/v1
discount/end/v1
domain/create/v1
domain/delete/v1
faq/create/v1
faq/update/v1
faq/delete/v1
filter/create/v1
filter/update/v1
filter/delete/v1
legal/update/v1
location-price/create/v1
location-price/update/v1
location-price/delete/v1
location-quantity/create/v1
location-quantity/update/v1
merchandising/create/v1
merchandising/update/v1
merchandising/delete/v1
offer/create/v1
offer/update/v1
offer/redeem/v1
order/placed/v1
order/pending/v1
order/payment_failed/v1
payment/complete/v1
payment/pending/v1
payment/failed/v1
product/create/v2
product/update/v2
product/delete/v2
product-price/create/v1
product-price/update/v1
product-price/delete/v1
promotion/create/v1
promotion/update/v1
promotion_usage/update/v1
refund/refund_initiated/v1
refund/refund_pending/v1
refund/refund_done/v1
refund/refund_failed/v1
return_config/update/v1
return_config_categories/update/v1
return_config_categories/delete/v1
rma_rule/create/v2
rma_rule/update/v2
rma_rule/create/v1
rma_rule/update/v1
seo/update/v1
shipment/create/v1
shipment/update/v1
shipment/data_update/v1
sort/create/v1
sort/update/v1
sort/delete/v1
tags/create/v1
tags/update/v1
tags/delete/v1
theme/create/v1
theme/update/v1
theme/delete/v1
user/create/v1
user/update/v1
user/delete/v1
variant/create/v1
variant/update/v1
variant/delete/v1
zone/create/v1
zone/update/v1
category/create/v1
category/update/v1
department/create/v1
department/update/v1
extension/install/v1
extension/uninstall/v1
extension-subscription/create/v1
extension-subscription/update/v1

Company

Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.

Product size

This event will be generated where there is any action done on product-size

Events
company/product-size/create/v2
# Occurs whenever product size is created.
company/product-size/delete/v2
# Occurs whenever product size is deleted.
company/product-size/update/v2
# Occurs whenever product size is updated.

Product Size/product-size/create/v2

Occurs whenever product size is created.

Payload
Hide
company_id
integer
Required
Unique identifier of the company 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  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Unique identifier of the company for which this event is triggered."
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "Specifies the scope of the event, indicating whether it applies at the sales channel level or the company level."
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "Timestamp in epoch milliseconds when the event was generated."
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique identifier for an event. This identifier can be used to verify if the event is already processed by receiver."
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "Internal trace identifier for Fynd Commerce services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type of the event"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event"
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "required": [
69        "product-size"
70      ],
71      "properties": {
72        "product-size": {
73          "description": "Product size event",
74          "type": "array",
75          "items": {
76            "type": "object",
77            "required": [
78              "seller_identifier",
79              "item_code",
80              "price",
81              "identifiers",
82              "size",
83              "company_id",
84              "currency",
85              "brand_uid"
86            ],
87            "properties": {
88              "seller_identifier": {
89                "type": "string",
90                "description": "The identifier of the seller for the product"
91              },
92              "brand_uid": {
93                "type": "integer",
94                "description": "The ID of the brand the product belongs to"
95              },
96              "item_code": {
97                "type": "string",
98                "description": "The unique item code of the product",
99                "x-not-enum": true
100              },
101              "price": {
102                "type": "number",
103                "description": "Price of the item"
104              },
105              "price_transfer": {
106                "type": "number",
107                "description": "Transfer price of the item"
108              },
109              "identifiers": {
110                "type": "array",
111                "description": "List of identifiers for the product",
112                "items": {
113                  "type": "object",
114                  "properties": {
115                    "gtin_type": {
116                      "type": "string",
117                      "description": "GTIN type",
118                      "enum": [
119                        "sku_code",
120                        "ean",
121                        "upc",
122                        "alu",
123                        "isbn",
124                        "vendor_sku"
125                      ]
126                    },
127                    "gtin_value": {
128                      "type": "string",
129                      "description": "GTIN value"
130                    },
131                    "primary": {
132                      "type": "boolean",
133                      "description": "Whether the identifier is primary or not"
134                    }
135                  }
136                }
137              },
138              "is_set": {
139                "type": "boolean",
140                "description": "Whether the product is a set of multiple items or not"
141              },
142              "size": {
143                "type": "string",
144                "description": "Size of the item"
145              },
146              "track_inventory": {
147                "type": "boolean",
148                "description": "Whether to track inventory for the product or not"
149              },
150              "price_effective": {
151                "type": "number",
152                "description": "Effective price of the item"
153              },
154              "company_id": {
155                "type": "integer",
156                "description": "Unique identifier of the company the product belongs to"
157              },
158              "currency": {
159                "type": "string",
160                "description": "Currency used for pricing the product"
161              },
162              "return_config": {
163                "type": "object",
164                "required": [
165                  "returnable"
166                ],
167                "properties": {
168                  "returnable": {
169                    "type": "boolean",
170                    "description": "Indicates whether the product is returnable or not"
171                  },
172                  "time": {
173                    "type": "integer",
174                    "description": "Time duration for returns"
175                  },
176                  "unit": {
177                    "type": "string",
178                    "description": "Unit of time for return duration"
179                  },
180                  "allow_partial_return": {
181                    "type": "boolean",
182                    "description": "Flag indicating if partial return of bundle child product is allowed or not."
183                  }
184                },
185                "description": "Return configuration for the product"
186              },
187              "is_active": {
188                "type": "boolean",
189                "description": "Whether the product is currently active or not"
190              },
191              "trader": {
192                "type": "array",
193                "description": "Trader information",
194                "items": {
195                  "type": "object",
196                  "required": [
197                    "address",
198                    "type",
199                    "name"
200                  ],
201                  "properties": {
202                    "address": {
203                      "type": "array",
204                      "items": {
205                        "type": "string"
206                      },
207                      "description": "The address of the trader"
208                    },
209                    "type": {
210                      "type": "string",
211                      "description": "Type of trader"
212                    },
213                    "name": {
214                      "type": "string",
215                      "description": "Name of the trader"
216                    }
217                  },
218                  "description": "Trader information"
219                }
220              },
221              "item_id": {
222                "type": "integer",
223                "description": "Unique identifier of the item"
224              },
225              "dimensions": {
226                "type": "object",
227                "description": "Dimensions of the item",
228                "properties": {
229                  "item_length": {
230                    "type": "number",
231                    "description": "Length of the item in centimeters"
232                  },
233                  "item_width": {
234                    "type": "number",
235                    "description": "Width of the item in centimeters"
236                  },
237                  "item_height": {
238                    "type": "number",
239                    "description": "Height of the item in centimeters"
240                  },
241                  "item_weight": {
242                    "type": "number",
243                    "description": "Weight of the item in grams"
244                  },
245                  "item_weight_unit_of_measure": {
246                    "type": "string",
247                    "description": "Unit of measure for the item's weight (e.g., \"gram\")"
248                  },
249                  "item_dimensions_unit_of_measure": {
250                    "type": "string",
251                    "description": "Unit of measure for the item's dimensions (e.g., \"cm\")"
252                  }
253                }
254              },
255              "tax_identifier": {
256                "type": "object",
257                "description": "Tax identifier for the product",
258                "properties": {
259                  "hsn_code_id": {
260                    "type": "string",
261                    "description": "Unique identifier of the HSN code associated with the tax"
262                  }
263                }
264              },
265              "_custom_json": {
266                "type": "object",
267                "description": "Custom JSON data for the product"
268              },
269              "created_on": {
270                "type": "string",
271                "format": "date-time",
272                "description": "The date and time when the product size was created"
273              },
274              "modified_on": {
275                "type": "string",
276                "format": "date-time",
277                "description": "The date and time when the product size was last modified"
278              },
279              "modified_by": {
280                "type": "object",
281                "description": "Details of the user who last modified the product size",
282                "properties": {
283                  "user_id": {
284                    "type": "string",
285                    "description": "Unique identifier of the user who last modified the product size"
286                  },
287                  "super_user": {
288                    "type": "boolean",
289                    "description": "Indicates if the user is a super user"
290                  }
291                }
292              },
293              "size_priority": {
294                "type": "integer",
295                "description": "Priority of the size for display purposes"
296              },
297              "_id": {
298                "type": "string",
299                "description": "Unique identifier for the company product size"
300              },
301              "use_individual_product_packaging": {
302                "type": "boolean",
303                "description": "Flag indicating if individual product packaging should be used instead of bundle packaging"
304              }
305            }
306          }
307        }
308      }
309    }
310  }
311}
Payload Example
1{
2  "event": {
3    "category": "company",
4    "created_timestamp": 1712153363458,
5    "id": "LwLNywt40aw0FZSrK9CdnSo35J/3EWZnxnFT93dNyI8=",
6    "name": "product-size",
7    "trace_id": [
8      "silverbolt.c5cde860-f1c3-11ee-8e32-1670e4e67cd9"
9    ],
10    "type": "create",
11    "version": "2"
12  },
13  "company_id": 1202,
14  "contains": [
15    "product-size"
16  ],
17  "payload": {
18    "product-size": [
19      {
20        "_custom_json": {},
21        "_id": "660d63135ae21da9bedc046f",
22        "brand_uid": 6828,
23        "company_id": 1202,
24        "created_on": "2024-04-03T14:09:23.026532",
25        "currency": "INR",
26        "dimensions": {
27          "item_dimensions_unit_of_measure": "cm",
28          "item_height": 10,
29          "item_length": 10,
30          "item_weight": 200,
31          "item_weight_unit_of_measure": "gram",
32          "item_width": 10
33        },
34        "identifiers": [
35          {
36            "gtin_type": "sku_code",
37            "gtin_value": "ABCROHINI",
38            "primary": true
39          }
40        ],
41        "is_active": true,
42        "is_set": false,
43        "item_code": "ITEM123",
44        "item_id": 10242321,
45        "modified_by": {
46          "super_user": false,
47          "user_id": "c068a675de437e48d5db3537",
48          "username": "test_example_com_12345"
49        },
50        "modified_on": "2024-04-03T14:09:23.026537",
51        "price": 1,
52        "price_effective": 1,
53        "price_transfer": 0,
54        "return_config": {
55          "returnable": false,
56          "time": 0,
57          "unit": "days"
58        },
59        "seller_identifier": "ABCROHINI",
60        "size": "L",
61        "tax_identifier": {
62          "hsn_code_id": "65fd783dc528d7515782df49"
63        },
64        "track_inventory": true,
65        "trader": [
66          {
67            "address": [
68              "Mumbai, Maharashtra, India"
69            ],
70            "name": "ABC",
71            "type": "Manufacturer"
72          }
73        ]
74      }
75    ]
76  }
77}

Product Size/product-size/delete/v2

Occurs whenever product size is deleted.

Payload
Hide
company_id
integer
Required
Unique identifier of the company 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  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Unique identifier of the company for which this event is triggered."
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "Specifies the scope of the event, indicating whether it applies at the sales channel level or the company level."
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "Timestamp in epoch milliseconds when the event was generated."
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique identifier for an event. This identifier can be used to verify if the event is already processed by the receiver."
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "Internal trace identifier for Fynd Commerce services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type of the event. e.g. create, update, delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event"
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "required": [
69        "product-size"
70      ],
71      "properties": {
72        "product-size": {
73          "description": "Product size event",
74          "type": "array",
75          "items": {
76            "type": "object",
77            "required": [
78              "seller_identifier",
79              "item_code",
80              "price",
81              "identifiers",
82              "size",
83              "company_id",
84              "currency",
85              "brand_uid"
86            ],
87            "properties": {
88              "seller_identifier": {
89                "type": "string",
90                "description": "Identifier of the seller for the product"
91              },
92              "brand_uid": {
93                "type": "integer",
94                "description": "Identifier of the brand the product belongs to"
95              },
96              "item_code": {
97                "type": "string",
98                "description": "The unique item code of the product"
99              },
100              "price": {
101                "type": "number",
102                "description": "Price of the item"
103              },
104              "price_transfer": {
105                "type": "number",
106                "description": "Transfer price of the item"
107              },
108              "identifiers": {
109                "type": "array",
110                "description": "List of identifiers for the product",
111                "items": {
112                  "type": "object",
113                  "properties": {
114                    "gtin_type": {
115                      "type": "string",
116                      "description": "GTIN type",
117                      "enum": [
118                        "sku_code",
119                        "ean",
120                        "upc",
121                        "alu",
122                        "isbn",
123                        "vendor_sku"
124                      ]
125                    },
126                    "gtin_value": {
127                      "type": "string",
128                      "description": "GTIN value"
129                    },
130                    "primary": {
131                      "type": "boolean",
132                      "description": "Whether the identifier is primary or not"
133                    }
134                  }
135                }
136              },
137              "is_set": {
138                "type": "boolean",
139                "description": "Whether the product is a set of multiple items or not"
140              },
141              "size": {
142                "type": "string",
143                "description": "Size of the item"
144              },
145              "track_inventory": {
146                "type": "boolean",
147                "description": "Whether to track inventory for the product or not"
148              },
149              "price_effective": {
150                "type": "number",
151                "description": "Effective price of the item"
152              },
153              "company_id": {
154                "type": "integer",
155                "description": "Identifier of the company the product belongs to"
156              },
157              "currency": {
158                "type": "string",
159                "description": "Currency used for pricing the product"
160              },
161              "dimensions": {
162                "type": "object",
163                "description": "Dimensions of the item",
164                "properties": {
165                  "item_length": {
166                    "type": "number",
167                    "description": "Length of the item in centimeters"
168                  },
169                  "item_width": {
170                    "type": "number",
171                    "description": "Width of the item in centimeters"
172                  },
173                  "item_height": {
174                    "type": "number",
175                    "description": "Height of the item in centimeters"
176                  },
177                  "item_weight": {
178                    "type": "number",
179                    "description": "Weight of the item in grams"
180                  },
181                  "item_weight_unit_of_measure": {
182                    "type": "string",
183                    "description": "Unit of measure for the item's weight (e.g., \"gram\")"
184                  },
185                  "item_dimensions_unit_of_measure": {
186                    "type": "string",
187                    "description": "Unit of measure for the item's dimensions (e.g., \"cm\")"
188                  }
189                }
190              },
191              "_custom_json": {
192                "type": "object",
193                "description": "Custom JSON data for the product (can contain any key value pair)"
194              },
195              "size_priority": {
196                "type": "integer",
197                "description": "Priority of the size for display purposes"
198              },
199              "item_id": {
200                "type": "integer",
201                "description": "Unique identifier of the item"
202              },
203              "created_on": {
204                "type": "string",
205                "format": "date-time",
206                "description": "The date and time when the product size was created"
207              },
208              "modified_on": {
209                "type": "string",
210                "format": "date-time",
211                "description": "The date and time when the product size was last modified"
212              },
213              "modified_by": {
214                "type": "object",
215                "description": "Details of the user who last modified the product size.",
216                "properties": {
217                  "user_id": {
218                    "type": "string",
219                    "description": "Unique identifier of the user who last modified the product size"
220                  }
221                }
222              }
223            }
224          }
225        }
226      }
227    }
228  }
229}
Payload Example
1{
2  "event": {
3    "category": "company",
4    "created_timestamp": 1712153387199,
5    "id": "OmEm07QXl8nfqOvqB5KLTpmVjBQ7CzoT8q3FULcyqhU=",
6    "name": "product-size",
7    "trace_id": [
8      "silverbolt.d3f47256-f1c3-11ee-b8a2-2aedd5776368"
9    ],
10    "type": "delete",
11    "version": "2"
12  },
13  "company_id": 1202,
14  "contains": [
15    "product-size"
16  ],
17  "payload": {
18    "product-size": [
19      {
20        "_custom_json": {},
21        "_id": "660d63135ae21da9bedc046f",
22        "brand_uid": 6828,
23        "company_id": 1202,
24        "created_on": "2024-04-03T14:09:23.026000",
25        "currency": "INR",
26        "dimensions": {
27          "item_dimensions_unit_of_measure": "cm",
28          "item_height": 10,
29          "item_length": 10,
30          "item_weight": 200,
31          "item_weight_unit_of_measure": "gram",
32          "item_width": 10
33        },
34        "identifiers": [
35          {
36            "gtin_type": "sku_code",
37            "gtin_value": "ABCROHINI",
38            "primary": true
39          }
40        ],
41        "is_set": false,
42        "item_code": "ITEM123",
43        "modified_on": "2024-04-03T14:09:23.026000",
44        "price": 1,
45        "price_effective": 1,
46        "price_transfer": 0,
47        "seller_identifier": "ABCROHINI",
48        "size": "L",
49        "track_inventory": true
50      }
51    ]
52  }
53}

Product Size/product-size/update/v2

Occurs whenever product size is updated.

Payload
Hide
company_id
integer
Required
Unique identifier of the company 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  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "Unique identifier of the company for which this event is triggered."
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "Specifies the scope of the event, indicating whether it applies at the sales channel level or the company level."
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "Timestamp in epoch milliseconds when the event was generated."
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique identifier for an event. This identifier can be used to verify if the event is already processed by the receiver."
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "Internal trace identifier for Fynd Commerce services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type of the event. e.g. create, update, delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event"
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "required": [
69        "product-size"
70      ],
71      "properties": {
72        "product-size": {
73          "description": "Product size event",
74          "type": "array",
75          "items": {
76            "type": "object",
77            "required": [
78              "seller_identifier",
79              "item_code",
80              "price",
81              "identifiers",
82              "size",
83              "company_id",
84              "currency",
85              "brand_uid"
86            ],
87            "properties": {
88              "seller_identifier": {
89                "type": "string",
90                "description": "Identifier of the seller for the product"
91              },
92              "brand_uid": {
93                "type": "integer",
94                "description": "Identifier of the brand the product belongs to"
95              },
96              "item_code": {
97                "type": "string",
98                "description": "Unique item code of the product",
99                "x-not-enum": true
100              },
101              "price": {
102                "type": "number",
103                "description": "Price of the item"
104              },
105              "price_transfer": {
106                "type": "number",
107                "description": "Transfer price of the item"
108              },
109              "identifiers": {
110                "type": "array",
111                "description": "List of identifiers for the product",
112                "items": {
113                  "type": "object",
114                  "properties": {
115                    "gtin_type": {
116                      "type": "string",
117                      "description": "GTIN type",
118                      "enum": [
119                        "sku_code",
120                        "ean",
121                        "upc",
122                        "alu",
123                        "isbn",
124                        "vendor_sku"
125                      ]
126                    },
127                    "gtin_value": {
128                      "type": "string",
129                      "description": "GTIN value"
130                    },
131                    "primary": {
132                      "type": "boolean",
133                      "description": "Whether the identifier is primary or not"
134                    }
135                  }
136                }
137              },
138              "is_set": {
139                "type": "boolean",
140                "description": "Whether the product is a set of multiple items or not"
141              },
142              "size": {
143                "type": "string",
144                "description": "Size of the item"
145              },
146              "track_inventory": {
147                "type": "boolean",
148                "description": "Whether to track inventory for the product or not"
149              },
150              "price_effective": {
151                "type": "number",
152                "description": "Effective price of the item"
153              },
154              "company_id": {
155                "type": "integer",
156                "description": "Unique identifier of the company the product belongs to"
157              },
158              "currency": {
159                "type": "string",
160                "description": "Currency used for pricing the product"
161              },
162              "return_config": {
163                "type": "object",
164                "required": [
165                  "returnable"
166                ],
167                "properties": {
168                  "returnable": {
169                    "type": "boolean",
170                    "description": "Indicates whether the product is returnable or not"
171                  },
172                  "time": {
173                    "type": "integer",
174                    "description": "Time duration for returns"
175                  },
176                  "unit": {
177                    "type": "string",
178                    "description": "Unit of time for return duration"
179                  },
180                  "allow_partial_return": {
181                    "type": "boolean",
182                    "description": "Flag indicating if partial return of bundle child product is allowed or not"
183                  }
184                },
185                "description": "Return configuration for the product"
186              },
187              "is_active": {
188                "type": "boolean",
189                "description": "Whether the product is currently active or not"
190              },
191              "trader": {
192                "type": "array",
193                "description": "Trader information",
194                "items": {
195                  "type": "object",
196                  "required": [
197                    "address",
198                    "type",
199                    "name"
200                  ],
201                  "properties": {
202                    "address": {
203                      "type": "array",
204                      "items": {
205                        "type": "string"
206                      },
207                      "description": "The address of the trader"
208                    },
209                    "type": {
210                      "type": "string",
211                      "description": "The type of trader"
212                    },
213                    "name": {
214                      "type": "string",
215                      "description": "The name of the trader"
216                    }
217                  }
218                }
219              },
220              "item_id": {
221                "type": "integer",
222                "description": "Unique identifier of the item"
223              },
224              "dimensions": {
225                "type": "object",
226                "description": "Dimensions of the item",
227                "properties": {
228                  "item_length": {
229                    "type": "number",
230                    "description": "Length of the item in centimeters"
231                  },
232                  "item_width": {
233                    "type": "number",
234                    "description": "Width of the item in centimeters"
235                  },
236                  "item_height": {
237                    "type": "number",
238                    "description": "Height of the item in centimeters"
239                  },
240                  "item_weight": {
241                    "type": "number",
242                    "description": "Weight of the item in grams"
243                  },
244                  "item_weight_unit_of_measure": {
245                    "type": "string",
246                    "description": "Unit of measure for the item's weight (e.g., \"gram\")"
247                  },
248                  "item_dimensions_unit_of_measure": {
249                    "type": "string",
250                    "description": "Unit of measure for the item's dimensions (e.g., \"cm\")"
251                  }
252                }
253              },
254              "tax_identifier": {
255                "type": "object",
256                "description": "Tax identifier for the product",
257                "properties": {
258                  "hsn_code_id": {
259                    "type": [
260                      "string",
261                      "null"
262                    ],
263                    "description": "Unique identifier of the HSN code associated with the tax"
264                  }
265                }
266              },
267              "_custom_json": {
268                "type": "object",
269                "description": "Custom JSON data for the product ( can contain any key value pair )"
270              },
271              "created_on": {
272                "type": "string",
273                "format": "date-time",
274                "description": "Date and time when the product size was created"
275              },
276              "modified_on": {
277                "type": "string",
278                "format": "date-time",
279                "description": "Date and time when the product size was last modified"
280              },
281              "modified_by": {
282                "type": "object",
283                "description": "Details of the user who last modified the product size",
284                "properties": {
285                  "user_id": {
286                    "type": "string",
287                    "description": "Unique identifier of the user who last modified the product size"
288                  },
289                  "super_user": {
290                    "type": "boolean",
291                    "description": "Indicates if the user is a super user"
292                  }
293                }
294              },
295              "size_priority": {
296                "type": "integer",
297                "description": "Priority of the size for display purposes"
298              },
299              "_id": {
300                "type": "string",
301                "description": "Unique identifier for the Company Product Size"
302              },
303              "use_individual_product_packaging": {
304                "type": "boolean",
305                "description": "Flag indicating if individual product packaging should be used instead of bundle packaging"
306              }
307            }
308          }
309        }
310      }
311    }
312  }
313}
Payload Example
1{
2  "company_id": 61,
3  "contains": [
4    "product-size"
5  ],
6  "event": {
7    "category": "company",
8    "created_timestamp": 1712154264754,
9    "id": "jacASbiBamNt03oJY8fhPR3jldli6MvEKUI4V7BuF0s=",
10    "name": "product-size",
11    "trace_id": [
12      "silverbolt.df04b82a-f1c5-11ee-9e4c-763a730613a4"
13    ],
14    "type": "update",
15    "version": "2"
16  },
17  "payload": {
18    "product-size": [
19      {
20        "_id": "632b032b75cc43f40b76dd09",
21        "brand_uid": 9,
22        "company_id": 61,
23        "currency": "INR",
24        "dimensions": {
25          "item_dimensions_unit_of_measure": "cm",
26          "item_height": 10,
27          "item_length": 25,
28          "item_weight": 999,
29          "item_weight_unit_of_measure": "gram",
30          "item_width": 15
31        },
32        "identifiers": [
33          {
34            "gtin_type": "upc",
35            "gtin_value": "4062449708363",
36            "primary": true
37          }
38        ],
39        "is_active": false,
40        "is_set": false,
41        "item_code": "59647801",
42        "item_id": 1166914,
43        "modified_by": {
44          "super_user": false,
45          "user_id": "2a47b6bea80fa72b90894a6f"
46        },
47        "price": 1999,
48        "price_effective": 999.5,
49        "price_transfer": 0,
50        "return_config": {
51          "returnable": true,
52          "time": 7,
53          "unit": "days"
54        },
55        "seller_identifier": "4062449708363",
56        "size": "S",
57        "tax_identifier": {
58          "hsn_code_id": "6277837c5e4c6fdbc8be3e93"
59        },
60        "track_inventory": true,
61        "trader": [
62          {
63            "address": [
64              "dummy data"
65            ],
66            "name": "PUMA Sports India Private Limited",
67            "type": "Manufacturer"
68          }
69        ]
70      },
71      {
72        "_id": "632b032b75cc43f40b76dd0a",
73        "brand_uid": 9,
74        "company_id": 61,
75        "currency": "INR",
76        "dimensions": {
77          "item_dimensions_unit_of_measure": "cm",
78          "item_height": 10,
79          "item_length": 25,
80          "item_weight": 999,
81          "item_weight_unit_of_measure": "gram",
82          "item_width": 15
83        },
84        "identifiers": [
85          {
86            "gtin_type": "upc",
87            "gtin_value": "4062449708370",
88            "primary": true
89          }
90        ],
91        "is_active": false,
92        "is_set": false,
93        "item_code": "59647801",
94        "item_id": 1166914,
95        "modified_by": {
96          "super_user": false,
97          "user_id": "2a47b6bea80fa72b90894a6f",
98          "username": "test_example_com_12345"
99        },
100        "price": 1999,
101        "price_effective": 999.5,
102        "price_transfer": 0,
103        "return_config": {
104          "returnable": true,
105          "time": 7,
106          "unit": "days"
107        },
108        "seller_identifier": "4062449708370",
109        "size": "M",
110        "tax_identifier": {
111          "hsn_code_id": "6277837c5e4c6fdbc8be3e93"
112        },
113        "track_inventory": true,
114        "trader": [
115          {
116            "address": [
117              "dummy data"
118            ],
119            "name": "PUMA Sports India Private Limited",
120            "type": "Manufacturer"
121          }
122        ]
123      },
124      {
125        "_id": "632b032b75cc43f40b76dd0b",
126        "brand_uid": 9,
127        "company_id": 61,
128        "currency": "INR",
129        "dimensions": {
130          "item_dimensions_unit_of_measure": "cm",
131          "item_height": 10,
132          "item_length": 25,
133          "item_weight": 999,
134          "item_weight_unit_of_measure": "gram",
135          "item_width": 15
136        },
137        "identifiers": [
138          {
139            "gtin_type": "upc",
140            "gtin_value": "4062449708332",
141            "primary": true
142          }
143        ],
144        "is_active": false,
145        "is_set": false,
146        "item_code": "59647801",
147        "item_id": 1166914,
148        "modified_by": {
149          "super_user": false,
150          "user_id": "2a47b6bea80fa72b90894a6f",
151          "username": "test_example_com_12345"
152        },
153        "price": 1999,
154        "price_effective": 999.5,
155        "price_transfer": 0,
156        "return_config": {
157          "returnable": true,
158          "time": 7,
159          "unit": "days"
160        },
161        "seller_identifier": "4062449708332",
162        "size": "L",
163        "tax_identifier": {
164          "hsn_code_id": "6277837c5e4c6fdbc8be3e93"
165        },
166        "track_inventory": true,
167        "trader": [
168          {
169            "address": [
170              "dummy data"
171            ],
172            "name": "PUMA Sports India Private Limited",
173            "type": "Manufacturer"
174          }
175        ]
176      },
177      {
178        "_id": "632b032b75cc43f40b76dd0c",
179        "brand_uid": 9,
180        "company_id": 61,
181        "currency": "INR",
182        "dimensions": {
183          "item_dimensions_unit_of_measure": "cm",
184          "item_height": 10,
185          "item_length": 25,
186          "item_weight": 999,
187          "item_weight_unit_of_measure": "gram",
188          "item_width": 15
189        },
190        "identifiers": [
191          {
192            "gtin_type": "upc",
193            "gtin_value": "4062449708349",
194            "primary": true
195          }
196        ],
197        "is_active": false,
198        "is_set": false,
199        "item_code": "59647801",
200        "item_id": 1166914,
201        "modified_by": {
202          "super_user": false,
203          "user_id": "2a47b6bea80fa72b90894a6f",
204          "username": "test_example_com_12345"
205        },
206        "price": 1999,
207        "price_effective": 999.5,
208        "price_transfer": 0,
209        "return_config": {
210          "returnable": true,
211          "time": 7,
212          "unit": "days"
213        },
214        "seller_identifier": "4062449708349",
215        "size": "XL",
216        "tax_identifier": {
217          "hsn_code_id": "6277837c5e4c6fdbc8be3e93"
218        },
219        "track_inventory": true,
220        "trader": [
221          {
222            "address": [
223              "dummy data"
224            ],
225            "name": "PUMA Sports India Private Limited",
226            "type": "Manufacturer"
227          }
228        ]
229      }
230    ]
231  }
232}

Previous
« product/create/v3
Next
support-ticket/create/v1 »