Search SKU Masters API
- Alaf Azam Khan
- Raghav Mehta
- Rahul Singh
Inbound | POST | /master/articles/search
Summary
This API is used to search existing SKU masters in Increff OMS system.
Description
This API can be used to search SKU masters listed in Increff OMS system by external systems.
This API does not return SKU Attributes. virtual SKU definition, UOM definition or Bundle definition (if any are present)
Note : Single payload can contain upto 5000 SKUs.
Request
{
"channelSkuCodes": [
"100565437",
"100565435"
]
}
Parameter Name | Data Type | Description | Mandatory |
| String [ ] | List of channelSkuCodes(Code used by channel to identify an SKU). Max Limit is 5000 | yes |
Response
{
"articleMasters": [
{
"channelSkuCode": "erpArticleCode-1",
"channelSerialNo": "serialNo-1",
"clientSkuId": "SKU-1",
"barcode": "barcode-1",
"category": "Apparel",
"brand": "BrandFactory",
"styleCode": "erp article style",
"mrp": 1299,
"hsn": "hsn1234",
"imageUrl": "HTTP://www.mybrand.com/styl123.jpg",
"name": "product name",
"taxRule": "GST_3",
"size": "xl",
"color": "blue",
"channelToleranceDays": 3,
"grnToleranceDays": 3,
"returnToleranceDays": 3,
"isPerishable": true,
"toleranceDays": null,
"isSerialCodeRequired": false,
"bulkBreakThreshold": 0,
"isBundled": true,
"isUom": true,
"skuDimension": {
"length": 20.2,
"breadth": 20.2,
"height": 20.2,
"weight": 20.2
},
"skuAttributes": {
"attribute1": "blue",
"attribute2": "red",
"attribute3": null,
"attribute4": "13188913",
"attribute5": "W857556A-19S",
"attribute6": "FB512BKBK",
"attribute7": "JMD11683",
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null
},
"isVirtual": false,
"virtualSkuDefinition": null
},
{
"channelSkuCode": "erpArticleCode-2",
"barcode": "barcode-2",
"clientSkuId": "SKU-2",
"category": "Footwear",
"brand": "brand1",
"styleCode": "erp article style",
"mrp": 1299,
"hsn": "hsn1234",
"imageUrl": "HTTP://www.mybrand.com/styl123.jpg",
"name": "product name",
"taxRule": "GST_APPAREL",
"size": "xl",
"color": "blue",
"channelToleranceDays": 3,
"grnToleranceDays": 3,
"returnToleranceDays": 3,
"isPerishable": true,
"toleranceDays": null,
"isSerialCodeRequired": true,
"bulkBreakThreshold": 0,
"isBundled": true,
"isUom": true,
"skuDimension": {
"length": 20.2,
"breadth": 20.2,
"height": 20.2,
"weight": 20.2
},
"skuAttributes": {
"attribute1": "white",
"attribute2": "pink",
"attribute3": null,
"attribute4": "13188914",
"attribute5": "W857557A-18S",
"attribute6": "FB613BKBK",
"attribute7": "JMD11684",
"attribute8": "1318",
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null
},
"isVirtual": true,
"virtualSkuDefinition": {
"virtualParentBarcode": "bar1",
"childSkus": [
{
"channelSkuCode": "erpArticleCode3",
"qty": 2,
"barcode": "bar23"
},
{
"channelSkuCode": "erpArticleCode1",
"qty": 1,
"barcode": "bar34"
}
],
"virtualParentChannelSkuId": "erpArticleCode2"
}
}
]
}
Parameter Name | Data Type | Description |
| Object[ ] | List of SKU masters corresponding to the channelSkuCodes |
| String | Code used by channel to identify an SKU |
| String | Unique code generated at channel side for that order item. |
| String | Client SKU identifier in product masters |
| String | Scannable code present on physical product that identifies an SKU uniquely |
| String | Represents the broad category this product belongs to |
| String | Brand of the sku |
| String | styleCode of the product |
| Double | Maximum Retail Price of the product |
| String | HSN code of the product |
| String | Public image url of the product. This is used in warehouse at multiple stages to gain efficiency and accuracy |
| String | Name of the product |
| Object | Dimension of the SKU(if added, then l,b,h,w are mandatory) |
| Double | Length of SKU in cms |
| Double | Width of SKU in cms |
| Double | Height of SKU in cms |
| Double | Weight of SKU in grams |
| String | Rule used to compute tax as per Increff Omni Tax Rule Table |
| String | Size of the product |
| String | Color of the product |
| boolean | Is the item perishable or not |
| Int | Days before getting expired upto which item can be used to fulfill orders created by ERP |
| Int | Threshold value at which the bulk break process will happen automatically in WMS |
| Int | System will provide validation at the time of GRN if products is getting expired in less the grn tolerance days |
| Int | System will provide validation at the time of B2C return if products is getting expired in less the |
| Boolean | Possible values:
|
| Boolean | Possible values:
|
| Object [ ] | SKU Attributes of the product |
| boolean | Is there a virtual sku definition |
| Object | A combination of multiple SKUs together to form a virtual-bundle SKU |
| String | Barcode of the parent SKU |
| Object[] | List of child skus |
| String | Channel SKU code of child SKU |
| Integer | Quantity of child SKU the parent SKU comprises of |
| String | Barcode of child SKU |
| Integer | Tolerance day of the SKU |
| Boolean | Flag to specify wether the SKU can have a serial code or not |
HttpStatus : 200