Company
Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.
Events
company/product-size/create/v2
# this event is triggered when product-size is created
company/product-size/delete/v2
# this event is triggered when product-size is deleted
company/product-size/update/v2
# this event is triggered when product-size is updated
Payload
Properties
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
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
product-size
array of object
Required
Product size event.
Array of Properties
seller_identifier
string
Required
The identifier of the seller for the product
brand_uid
integer
Required
The ID of the brand the product belongs to
item_code
string
Required
The unique item code of the product
price
number
Required
Price of the item
price_transfer
number
Transfer price of the item
identifiers
array of object
Required
List of identifiers for this product
is_set
boolean
Whether the product is a set of multiple items or not
size
string
Required
Size of the item
track_inventory
boolean
Whether to track inventory for the product or not
price_effective
number
Effective price of the item
company_id
integer
Required
The ID of the company the product belongs to
currency
string
Required
The currency used for pricing the product
return_config
object
Return configuration for the product
Properties
returnable
boolean
Required
Indicates whether the product is returnable or not
time
integer
Time duration for returns
unit
string
Unit of time for return duration
allow_partial_return
boolean
Flag indicating if partial return of bundle child product is allowed or not.
is_active
boolean
Whether the product is currently active or not
trader
array of object
Trader information.
Array of Properties
address
array of string
Required
The address of the trader.
type
string
Required
The type of trader.
name
string
Required
item_id
integer
ID of the item
dimensions
object
Dimensions of the item.
Properties
item_length
number
Length of the item in centimeters.
item_width
number
Width of the item in centimeters.
item_height
number
Height of the item in centimeters.
item_weight
number
Weight of the item in grams.
item_weight_unit_of_measure
string
Unit of measure for the item's weight (e.g., "gram").
item_dimensions_unit_of_measure
string
Unit of measure for the item's dimensions (e.g., "cm").
tax_identifier
object
Tax identifier for the product.
Properties
hsn_code_id
string
The ID of the HSN code associated with the tax.
_custom_json
object
Custom JSON data for the product
created_on
string
| date-time
The date and time when the product size was created
modified_on
string
| date-time
The date and time when the product size was last modified
modified_by
object
Details of the user who last modified the product size.
size_priority
integer
The priority of the size for display purposes.
_id
string
Unique identifier for the Company Product Size.
use_individual_product_packaging
boolean
Flag indicating if individual product packaging should be used instead of bundle packaging.
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": "company ID 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": "category of the event. If it is at sales channel level or company level"36 },37 "created_timestamp": {38 "type": "integer",39 "description": "event generation timestamp in epoch milliseconds"40 },41 "id": {42 "type": "string",43 "description": "Unique ID for an event. This id can be used to verifiy if 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_id for Fynd Platform services",52 "items": {53 "type": "string"54 }55 },56 "type": {57 "type": "string",58 "description": "Type/Action 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": "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": true100 },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 "items": {112 "type": "object"113 },114 "description": "List of identifiers for this product",115 "properties": {116 "gtin_type": {117 "type": "string",118 "description": "GTIN type",119 "enum": [120 "sku_code",121 "ean",122 "upc",123 "alu",124 "isbn",125 "vendor_sku"126 ]127 },128 "gtin_value": {129 "type": "string",130 "description": "GTIN value"131 },132 "primary": {133 "type": "boolean",134 "description": "Whether the identifier is primary or not"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": "The ID of the company the product belongs to"157 },158 "currency": {159 "type": "string",160 "description": "The 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 }216 },217 "description": "Trader information"218 }219 },220 "item_id": {221 "type": "integer",222 "description": "ID 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": "string",260 "description": "The ID of the HSN code associated with the tax."261 }262 }263 },264 "_custom_json": {265 "type": "object",266 "description": "Custom JSON data for the product"267 },268 "created_on": {269 "type": "string",270 "format": "date-time",271 "description": "The date and time when the product size was created"272 },273 "modified_on": {274 "type": "string",275 "format": "date-time",276 "description": "The date and time when the product size was last modified"277 },278 "modified_by": {279 "type": "object",280 "description": "Details of the user who last modified the product size.",281 "user_id": {282 "type": "string",283 "description": "The ID of the user who last modified the product size"284 }285 },286 "size_priority": {287 "type": "integer",288 "description": "The priority of the size for display purposes."289 },290 "_id": {291 "type": "string",292 "description": "Unique identifier for the Company Product Size."293 },294 "use_individual_product_packaging": {295 "type": "boolean",296 "description": "Flag indicating if individual product packaging should be used instead of bundle packaging."297 }298 }299 }300 }301 },302 "examples": [303 {304 "company_id": 1202,305 "contains": [306 "product-size"307 ],308 "event": {309 "category": "company",310 "created_timestamp": 1712153363458,311 "id": "LwLNywt40aw0FZSrK9CdnSo35J/3EWZnxnFT93dNyI8=",312 "name": "product-size",313 "trace_id": [314 "silverbolt.c5cde860-f1c3-11ee-8e32-1670e4e67cd9"315 ],316 "type": "create",317 "version": "2"318 },319 "payload": {320 "product-size": [321 {322 "_custom_json": {},323 "_id": "660d63135ae21da9bedc046f",324 "brand_uid": 6828,325 "company_id": 1202,326 "created_on": "2024-04-03T14:09:23.026532",327 "currency": "INR",328 "dimensions": {329 "item_dimensions_unit_of_measure": "cm",330 "item_height": 10,331 "item_length": 10,332 "item_weight": 200,333 "item_weight_unit_of_measure": "gram",334 "item_width": 10335 },336 "identifiers": [337 {338 "gtin_type": "sku_code",339 "gtin_value": "ABCROHINI",340 "primary": true341 }342 ],343 "is_active": true,344 "is_set": false,345 "item_code": "ITEM123",346 "item_id": 10242321,347 "modified_by": {348 "super_user": false,349 "user_id": "c068a675de437e48d5db3537",350 "username": "test_example_com_12345"351 },352 "modified_on": "2024-04-03T14:09:23.026537",353 "price": 1,354 "price_effective": 1,355 "price_transfer": 0,356 "return_config": {357 "returnable": false,358 "time": 0,359 "unit": "days"360 },361 "seller_identifier": "ABCROHINI",362 "size": "L",363 "tax_identifier": {364 "hsn_code_id": "65fd783dc528d7515782df49"365 },366 "track_inventory": true,367 "trader": [368 {369 "address": [370 "ABc"371 ],372 "name": "ABC",373 "type": "Manufacturer"374 }375 ]376 }377 ]378 }379 }380 ]381 }382 }383}
Payload Example
1
Payload
Properties
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
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
product-size
array of object
Required
Product size event.
Array of Properties
seller_identifier
string
Required
The identifier of the seller for the product
brand_uid
integer
Required
The ID of the brand the product belongs to
item_code
string
Required
The unique item code of the product
price
number
Required
Price of the item
price_transfer
number
Transfer price of the item
identifiers
array of object
Required
List of identifiers for this product
is_set
boolean
Whether the product is a set of multiple items or not
size
string
Required
Size of the item
track_inventory
boolean
Whether to track inventory for the product or not
price_effective
number
Effective price of the item
company_id
integer
Required
The ID of the company the product belongs to
currency
string
Required
The currency used for pricing the product
dimensions
object
Dimensions of the item.
Properties
item_length
number
Length of the item in centimeters.
item_width
number
Width of the item in centimeters.
item_height
number
Height of the item in centimeters.
item_weight
number
Weight of the item in grams.
item_weight_unit_of_measure
string
Unit of measure for the item's weight (e.g., "gram").
item_dimensions_unit_of_measure
string
Unit of measure for the item's dimensions (e.g., "cm").
_custom_json
object
Custom JSON data for the product ( can contain any key value pair )
size_priority
integer
The priority of the size for display purposes.
item_id
integer
Unique ID of the item
created_on
string
| date-time
The date and time when the product size was created
modified_on
string
| date-time
The date and time when the product size was last modified
modified_by
object
Details of the user who last modified the product size.
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": "company ID 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": "category of the event. If it is at sales channel level or company level"36 },37 "created_timestamp": {38 "type": "integer",39 "description": "event generation timestamp in epoch milliseconds"40 },41 "id": {42 "type": "string",43 "description": "Unique ID for an event. This id can be used to verifiy if 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_id for Fynd Platform services",52 "items": {53 "type": "string"54 }55 },56 "type": {57 "type": "string",58 "description": "Type/Action 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": "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 },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 "items": {111 "type": "object"112 },113 "description": "List of identifiers for this product",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 "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": "The ID of the company the product belongs to"156 },157 "currency": {158 "type": "string",159 "description": "The 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": "The priority of the size for display purposes."198 },199 "item_id": {200 "type": "integer",201 "description": "Unique ID 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 "user_id": {217 "type": "string",218 "description": "The ID of the user who last modified the product size"219 }220 }221 }222 }223 }224 }225 }226 }227}
Payload Example
1{2 "company_id": 1202,3 "contains": [4 "product-size"5 ],6 "event": {7 "category": "company",8 "created_timestamp": 1712153387199,9 "id": "OmEm07QXl8nfqOvqB5KLTpmVjBQ7CzoT8q3FULcyqhU=",10 "name": "product-size",11 "trace_id": [12 "silverbolt.d3f47256-f1c3-11ee-b8a2-2aedd5776368"13 ],14 "type": "delete",15 "version": "2"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": 1033 },34 "identifiers": [35 {36 "gtin_type": "sku_code",37 "gtin_value": "ABCROHINI",38 "primary": true39 }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": true50 }51 ]52 }53}
Payload
Properties
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
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
product-size
array of object
Required
Product size event.
Array of Properties
seller_identifier
string
Required
The identifier of the seller for the product
brand_uid
integer
Required
The ID of the brand the product belongs to
item_code
string
Required
The unique item code of the product
price
number
Required
Price of the item
price_transfer
number
Transfer price of the item
identifiers
array of object
Required
List of identifiers for this product
is_set
boolean
Whether the product is a set of multiple items or not
size
string
Required
Size of the item
track_inventory
boolean
Whether to track inventory for the product or not
price_effective
number
Effective price of the item
company_id
integer
Required
The ID of the company the product belongs to
currency
string
Required
The currency used for pricing the product
return_config
object
Return configuration for the product
Properties
returnable
boolean
Required
Indicates whether the product is returnable or not
time
integer
Time duration for returns
unit
string
Unit of time for return duration
allow_partial_return
boolean
Flag indicating if partial return of bundle child product is allowed or not.
is_active
boolean
Whether the product is currently active or not
trader
array of object
Trader information.
Array of Properties
address
array of string
Required
The address of the trader.
type
string
Required
The type of trader.
name
string
Required
The name of the trader.
item_id
integer
ID of the item
dimensions
object
Dimensions of the item.
Properties
item_length
number
Length of the item in centimeters.
item_width
number
Width of the item in centimeters.
item_height
number
Height of the item in centimeters.
item_weight
number
Weight of the item in grams.
item_weight_unit_of_measure
string
Unit of measure for the item's weight (e.g., "gram").
item_dimensions_unit_of_measure
string
Unit of measure for the item's dimensions (e.g., "cm").
tax_identifier
object
Tax identifier for the product.
Properties
hsn_code_id
string|null
The ID of the HSN code associated with the tax.
_custom_json
object
Custom JSON data for the product ( can contain any key value pair )
created_on
string
| date-time
The date and time when the product size was created
modified_on
string
| date-time
The date and time when the product size was last modified
modified_by
object
Details of the user who last modified the product size.
size_priority
integer
The priority of the size for display purposes.
_id
string
Unique identifier for the Company Product Size.
use_individual_product_packaging
boolean
Flag indicating if individual product packaging should be used instead of bundle packaging.
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": "company ID 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": "category of the event. If it is at sales channel level or company level"36 },37 "created_timestamp": {38 "type": "integer",39 "description": "event generation timestamp in epoch milliseconds"40 },41 "id": {42 "type": "string",43 "description": "Unique ID for an event. This id can be used to verifiy if 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_id for Fynd Platform services",52 "items": {53 "type": "string"54 }55 },56 "type": {57 "type": "string",58 "description": "Type/Action 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": "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": true100 },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 "items": {112 "type": "object"113 },114 "description": "List of identifiers for this product",115 "properties": {116 "gtin_type": {117 "type": "string",118 "description": "GTIN type",119 "enum": [120 "sku_code",121 "ean",122 "upc",123 "alu",124 "isbn",125 "vendor_sku"126 ]127 },128 "gtin_value": {129 "type": "string",130 "description": "GTIN value"131 },132 "primary": {133 "type": "boolean",134 "description": "Whether the identifier is primary or not"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": "The ID of the company the product belongs to"157 },158 "currency": {159 "type": "string",160 "description": "The 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": "ID 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": "The ID 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": "The date and time when the product size was created"275 },276 "modified_on": {277 "type": "string",278 "format": "date-time",279 "description": "The 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 "user_id": {285 "type": "string",286 "description": "The ID of the user who last modified the product size"287 }288 },289 "size_priority": {290 "type": "integer",291 "description": "The priority of the size for display purposes."292 },293 "_id": {294 "type": "string",295 "description": "Unique identifier for the Company Product Size."296 },297 "use_individual_product_packaging": {298 "type": "boolean",299 "description": "Flag indicating if individual product packaging should be used instead of bundle packaging."300 }301 }302 }303 }304 }305 }306 }307}
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": 1531 },32 "identifiers": [33 {34 "gtin_type": "upc",35 "gtin_value": "4062449708363",36 "primary": true37 }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 "username": "test_example_com_12345"47 },48 "price": 1999,49 "price_effective": 999.5,50 "price_transfer": 0,51 "return_config": {52 "returnable": true,53 "time": 7,54 "unit": "days"55 },56 "seller_identifier": "4062449708363",57 "size": "S",58 "tax_identifier": {59 "hsn_code_id": "6277837c5e4c6fdbc8be3e93"60 },61 "track_inventory": true,62 "trader": [63 {64 "address": [65 "dummy data"66 ],67 "name": "PUMA Sports India Private Limited",68 "type": "Manufacturer"69 }70 ]71 },72 {73 "_id": "632b032b75cc43f40b76dd0a",74 "brand_uid": 9,75 "company_id": 61,76 "currency": "INR",77 "dimensions": {78 "item_dimensions_unit_of_measure": "cm",79 "item_height": 10,80 "item_length": 25,81 "item_weight": 999,82 "item_weight_unit_of_measure": "gram",83 "item_width": 1584 },85 "identifiers": [86 {87 "gtin_type": "upc",88 "gtin_value": "4062449708370",89 "primary": true90 }91 ],92 "is_active": false,93 "is_set": false,94 "item_code": "59647801",95 "item_id": 1166914,96 "modified_by": {97 "super_user": false,98 "user_id": "2a47b6bea80fa72b90894a6f",99 "username": "test_example_com_12345"100 },101 "price": 1999,102 "price_effective": 999.5,103 "price_transfer": 0,104 "return_config": {105 "returnable": true,106 "time": 7,107 "unit": "days"108 },109 "seller_identifier": "4062449708370",110 "size": "M",111 "tax_identifier": {112 "hsn_code_id": "6277837c5e4c6fdbc8be3e93"113 },114 "track_inventory": true,115 "trader": [116 {117 "address": [118 "dummy data"119 ],120 "name": "PUMA Sports India Private Limited",121 "type": "Manufacturer"122 }123 ]124 },125 {126 "_id": "632b032b75cc43f40b76dd0b",127 "brand_uid": 9,128 "company_id": 61,129 "currency": "INR",130 "dimensions": {131 "item_dimensions_unit_of_measure": "cm",132 "item_height": 10,133 "item_length": 25,134 "item_weight": 999,135 "item_weight_unit_of_measure": "gram",136 "item_width": 15137 },138 "identifiers": [139 {140 "gtin_type": "upc",141 "gtin_value": "4062449708332",142 "primary": true143 }144 ],145 "is_active": false,146 "is_set": false,147 "item_code": "59647801",148 "item_id": 1166914,149 "modified_by": {150 "super_user": false,151 "user_id": "2a47b6bea80fa72b90894a6f",152 "username": "test_example_com_12345"153 },154 "price": 1999,155 "price_effective": 999.5,156 "price_transfer": 0,157 "return_config": {158 "returnable": true,159 "time": 7,160 "unit": "days"161 },162 "seller_identifier": "4062449708332",163 "size": "L",164 "tax_identifier": {165 "hsn_code_id": "6277837c5e4c6fdbc8be3e93"166 },167 "track_inventory": true,168 "trader": [169 {170 "address": [171 "dummy data"172 ],173 "name": "PUMA Sports India Private Limited",174 "type": "Manufacturer"175 }176 ]177 },178 {179 "_id": "632b032b75cc43f40b76dd0c",180 "brand_uid": 9,181 "company_id": 61,182 "currency": "INR",183 "dimensions": {184 "item_dimensions_unit_of_measure": "cm",185 "item_height": 10,186 "item_length": 25,187 "item_weight": 999,188 "item_weight_unit_of_measure": "gram",189 "item_width": 15190 },191 "identifiers": [192 {193 "gtin_type": "upc",194 "gtin_value": "4062449708349",195 "primary": true196 }197 ],198 "is_active": false,199 "is_set": false,200 "item_code": "59647801",201 "item_id": 1166914,202 "modified_by": {203 "super_user": false,204 "user_id": "2a47b6bea80fa72b90894a6f",205 "username": "test_example_com_12345"206 },207 "price": 1999,208 "price_effective": 999.5,209 "price_transfer": 0,210 "return_config": {211 "returnable": true,212 "time": 7,213 "unit": "days"214 },215 "seller_identifier": "4062449708349",216 "size": "XL",217 "tax_identifier": {218 "hsn_code_id": "6277837c5e4c6fdbc8be3e93"219 },220 "track_inventory": true,221 "trader": [222 {223 "address": [224 "dummy data"225 ],226 "name": "PUMA Sports India Private Limited",227 "type": "Manufacturer"228 }229 ]230 }231 ]232 }233}