This API is used to create SKU masters in Omni.
This API will create SKU masters in Omni.
<aside> ℹ️
Note : Single payload can contains upto 5000 SKU
</aside>
{
"articleMasters": [
{
"clientSkuId": "clientSkuId",
"channelSkuCode": "erpArticleCode1",
"channelSerialNo": "serial1",
"barcode": "barcode",
"category": "category",
"brand": "BrandFactory",
"bulkBreakThreshold": 0,
"isUom": true,
"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,
"isSerialCodeRequired": true,
"isBundled":false,
"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": {
"virtualParentBarcode": "barcode-1",
"childSkus": [
{
"channelSkuCode": "erpArticleCode-5",
"qty": 2,
"barcode": "barcode-12"
},
{
"channelSkuCode": "erpArticleCode-4",
"qty": 1,
"barcode": "barcode-14"
}
],
"virtualParentChannelSkuId": "erpArticleCode-6"
}
},
{
"channelSkuCode": "erpArticleCode2",
"barcode": "sku2",
"category": "category",
"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,
"isSerialCodeRequired": false,
"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": "barcode-2",
"childSkus": [
{
"channelSkuCode": "erpArticleCode-3",
"qty": 2,
"barcode": "barcode-23"
},
{
"channelSkuCode": "erpArticleCode-1",
"qty": 1,
"barcode": "barcode-24"
}
],
"virtualParentChannelSkuId": "erpArticleCode-2"
}
}
]
}
| Parameter Name | Data Type | Description | Mandatory |
|---|---|---|---|
channelSkuCode |
String | Code used by channel to identify an SKU. Should be Unique. | |
| All Inventory updates, orders happen on this code. | Yes | ||
clientSkuId |
String | SKU unique identifier to be created at Increff OMS. | Yes |
channelSerialNo |
String | Second Unique code generated at channel for that sku | Yes |
barcode |
String | Scannable code present on physical product that identifies an SKU uniquely | Yes |
category |
String | Represents the broad category this product belongs to | No |
brand |
String | Brand of the sku | Yes |
isUom |
boolean | Identifier for marking a SKU as UOM | No |
bulkBreakThreshold |
Int | Minimum Threshold value for inventory of a product after which bulk break action will be triggered | No |
styleCode |
String | styleCode of the product | Yes |
mrp |
Double | Maximum Retail Price of the product | Yes |
hsn |
String | HSN code of the product | Yes |
imageUrl |
String | Public image url of the product. This is used in warehouse at multiple stages to gain efficiency and accuracy | No |
name |
String | Name of the product | Yes |
taxRule |
String | Rule used to compute tax as per Increff Omni Tax Rule Table | Yes |
size |
String | Size of the product | No |
color |
String | Color of the product | No |
isPerishable |
boolean | Is the item perishable or not | |
| If product has expiration date then its considered as perishable. | |||
Default value = false |
No | ||
channelToleranceDays |
Int | Valid for perishable products only. | |
| No of Days before getting expired upto which item can be used to fulfil orders created by ERP | No | ||
grnToleranceDays |
Int | Valid for perishable products only. | |
| System will provide validation at the time of GRN if products is getting expired in less the grn tolerance days | No | ||
returnToleranceDays |
Int | Valid for perishable products only. | |
System will provide validation at the time of B2C return if products is getting expired in less the returnToleranceDays days |
No | ||
skuAttributes |
Object [ ] | SKU Attributes of the product | No |
isVirtual |
boolean | set isVirtual = true to mark this SKU as a Virtual Combo SKU. | |
Default value = false |
No | ||
isBundled |
boolean | set isBundeld = true to mark this SKU as a Bundled SKU. | |
Default value = false |
No | ||
virtualSkuDefinition |
Object | Virtual combo SKU definition object which tell system what is the constituents SKUs for a given virtual SKU. | |
| • Can be sent if isVirtual is set as true | |||
| • Can also be sent via a different API | |||
| • Not required if isVirtual=false | |||
| • Child SKUs should already be created | |||
| • Child SKU can not be virtual combos | No | ||
virtualSkuDefinition.virtualParentChannelSkuId |
String | Channel SKU code of parent SKu | No |
virtualSkuDefinition.virtualParentBarcode |
String | Barcode of parent SKU | No |
virtualSkuDefinition.childSkus |
Object[] | List of child SKU objects | |
| • Mandatory if virtualSkuDefinition is sent | No | ||
childSkus.channelSkuCode |
String | Channel SKU code of child SKU | |
| • Mandatory if childSkus is sent | No | ||
childSkus.quantity |
Integer | Number of child SKU constituted in given virtual SKU | |
| • Mandatory if childSkus is sent | No | ||
childSkus.barcode |
String | Barcode of child SKU | no |
skuDimension |
Object | Dimensions of SKU | No |
skuDimension.length |
Double | Length of SKU in CMs | No |
skuDimension.breadth |
Double | Breadth of SKU in CMs | No |
skuDimension.height |
Double | Height of SKU in CMs | No |
skuDimension.weight |
Double | Weight of SKU in grams | No |
isSerialCodeRequired |
Boolean | Flag to specify wether the SKU can have a serial code or not | |
Default value = false |
No |
<aside> 👉🏻
Values of channelToleranceDays, grnToleranceDays, returnToleranceDays are expected for the Products which are perishable.
For non-perishable products, the value of these attributes can be null or these attributes should not be passed in the request body
</aside>
https://increff.atlassian.net/wiki/spaces/IO/pages/355533325
EmptyBody
HttpStatus : 200