Search SKU Masters API

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)

<aside> 🗒️ Note : Single payload can contain upto 5000 SKUs.

</aside>

Request

{
  "channelSkuCodes": [
    "100565437",
    "100565435"
  ]
}

Parameter Name	Data Type	Description	Mandatory
`channelSkuCodes`	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
`articleMasters`	Object[ ]	List of SKU masters corresponding to the channelSkuCodes
`channelSkuCode`	String	Code used by channel to identify an SKU
`channelSerialNo`	String	Unique code generated at channel side for that order item.
`clientSkuId`	String	Client SKU identifier in product masters
`barcode`	String	Scannable code present on physical product that identifies an SKU uniquely
`category`	String	Represents the broad category this product belongs to
`brand`	String	Brand of the sku
`styleCode`	String	styleCode of the product
`mrp`	Double	Maximum Retail Price of the product
`hsn`	String	HSN code of the product
`imageUrl`	String	Public image url of the product. This is used in warehouse at multiple stages to gain efficiency and accuracy
`name`	String	Name of the product
`channelDimension`	Object	Dimension of the SKU(if added, then l,b,h,w are mandatory)
`channelDimension.length`	Double	Length of SKU in cms
`channelDimension.breadth`	Double	Width of SKU in cms
`channelDimension.height`	Double	Height of SKU in cms
`channelDimension.weight`	Double	Weight of SKU in grams
`taxRule`	String	Rule used to compute tax as per Increff Omni Tax Rule Table
`size`	String	Size of the product
`color`	String	Color of the product
`isPerishable`	boolean	Is the item perishable or not
`channelToleranceDays`	Int	Days before getting expired upto which item can be used to fulfill orders created by ERP
`bulkBreakThreshold`	Int	Threshold value at which the bulk break process will happen automatically in WMS
`grnToleranceDays`	Int	System will provide validation at the time of GRN if products is getting expired in less the grn tolerance days
`returnToleranceDays`	Int	System will provide validation at the time of B2C return if products is getting expired in less the `returnToleranceDays` days
`isBundled`	Boolean	Possible values:
`true` → in case product has bundle SKU definition listed in the system
`false` → in case product does not has a bundle sku definition in the system
`isUom`	Boolean	Possible values:
`true` → in case product has Unit of measure definition listed in the system
`false` → in case product does not has Unit of measure definition in the system
`skuAttributes`	Object [ ]	SKU Attributes of the product
`isVirtual`	boolean	Is there a virtual sku definition
`virtualSkuDefinition`	Object	A combination of multiple SKUs together to form a virtual-bundle SKU
`virtualSkuDefinition.virtualParentBarcode`	String	Barcode of the parent SKU
`virtualSkuDefinition.childSkus`	Object[]	List of child skus
`childSkus.channelSkuCode`	String	Channel SKU code of child SKU
`childSkus.qty`	Integer	Quantity of child SKU the parent SKU comprises of
`childSkus.barcode`	String	Barcode of child SKU
`toleranceDays`	Integer	Tolerance day of the SKU
`isSerialCodeRequired`	Boolean	Flag to specify wether the SKU can have a serial code or not

HttpStatus : 200