Skip to main content

Article

v1

Description

Product size can be available at one or more selling locations. An Article ID is tagged to the product depending on the seeling location. Get notified on the creation, updation, and deletion of any article.


Supported Type

  • Create
  • Update

Payload

{
"event":{
"id":"cLexaCxD1bSTOxdEH1Wa7mgvKfd8TOZnbjvkUnGYNEA=",
"name":"article",
"type":"update",
"version":"1",
"trace_id":[
"prism.cb369e92-f909-11eb-98b3-1e5e3dff6c00"
],
"created_timestamp":1628510602430
},
"payload":{
"articles":[
{
"id":"6025471f330967419daab339",
"uid":"11945_8907966494862",
"size":"XL",
"brand":{
"id":56
},
"price":{
"marked":2699,
"currency":"INR",
"transfer":0,
"effective":2699
},
"store":{
"id":11945
},
"is_set":false,
"weight":{
"unit":"gram",
"shipping":350
},
"company":{
"id":37
},
"item_id":7640448,
"date_meta":{
"modified_on":"2021-08-09 12:03:22.420565+00:00",
"inventory_updated_on":"2021-08-09 12:03:22.420565+00:00"
},
"dimension":{
"unit":"cm",
"width":25,
"height":10,
"length":30
},
"is_active":true,
"identifier":{
"ean":"8907966494862"
},
"quantities":{
"damaged":{
"count":0,
"updated_at":"2021-08-09 12:03:22.420565"
},
"sellable":{
"count":1,
"updated_at":"2021-08-09 12:03:22.420565"
},
"not_available":{
"count":0,
"updated_at":"2021-08-09 12:03:22.420565"
}
},
"_custom_json":{

},
"manufacturer":{
"name":"Spykar Lifestyles Private Limited",
"address":"Lotus Corporate Park, 19th Floor, F wing, Ram Mandir Lane, Jai Coach Junction, Off Western Express Highway, Goregaon (East), Mumbai-400063."
},
"return_config":{
"time":7,
"unit":"days",
"returnable":true
},
"fynd_item_code":"MSH01BA006OLIVEGREEN",
"tax_identifier":{
"hsn_code":"62052000"
},
"total_quantity":1,
"track_inventory":true,
"country_of_origin":"India",
"seller_identifier":"8907966494862"
}
]
},
"contains":[
"articles"
],
"company_id":37
}

Object Properties

KeyTypeDescription
idstringUnique ID, Auto Generated
uidstringUnique ID, Auto Generated
sizestringProduct Size
brandjsonIncludes brand uid
pricejsonIncludes marked (mrp), effective (selling price), currency, transfer price
storejsonIncludes store uid
is_setboolIs it a set of products or a single product
weightjsonIncludes weight and unit of measurement
companyjsonIncludes company uid
item_idintegerProduct uid
date_metajsonTimestamp details
dimensionjsonIncludes length x breadth x height and unit of measurement
is_activeboolIs the article active or inactive
identifierjsonProduct identifier, ean or alu or upc or sku
quantitiesjsonsellable (in-stock), damaged (if any), not_available (if any), order_commited (order processing)
manufacturerjsonProduct manufacturer details
return_configjsonProduct return policy details
fynd_item_codestringProduct code given by seller
tax_identifierjsonTax details (HSN)
total_quantityintegertotal_quantity = sellable + order_commited + damaged + not_available
track_inventoryboolIf false, we won't reduce inventory on each processed order
country_of_originstringWhere product is made
seller_identifierstringproduct x size unique code given by seller, (ean or sku or upc or alu)