Skip to end of banner
Go to start of banner

Create SKU Masters API

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

Inbound | POST | /master/articles

Summary

This API is used to create SKU masters in Omni.

Description

This API will create SKU masters in Omni.

Note : Single payload can contains upto 5000 SKU

Request

{
  "articleMasters": [
    {
      "clientSkuId": "clientSkuId",
      "channelSkuCode": "erpArticleCode1",
      "channelSerialNo": "serial1",
      "barcode": "barcode",
      "category": "category",
      "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, 
      "isSerialCodeRequired": 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": "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": "bar1"
        "childSkus": [
          {
            "channelSkuCode": "erpArticleCode3",
            "qty": 2,
            "barcode": "bar23"
          },
          {
            "channelSkuCode": "erpArticleCode1",
            "qty": 1,
            "barcode": "bar24"
          }
        ],
        "virtualParentChannelSkuId": "erpArticleCode2"
      }
    }
  ]
}

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

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

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

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

Read more about virtual combo SKUs here Virtual Combo SKUs in Increff OMS



Response

EmptyBody

HttpStatus : 200

  • No labels