Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Inbound | POST | /master/articles/search

Summary

This API is used to search existing article SKU masters in Omni.

Description

This API will search article SKU masters in Omni. 

Note : Single payload can contain upto 5000 articlesSKUs.

This API does not return SKU Attributes, or virtual SKU definition if any.

Request

Code Block
languagejson
{
  "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

Code Block
languagejson
{
   "articleMasters":[
      {
         "channelSkuCode":"erpArticleCode1",
         "channelSerialNo":"serial1",
         "barcode":"barcode",
         "category":"category",
         "brand":"BrandFactory",
         "styleCode":"erp articleSKU style",
         "mrp":1299.00,
         "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,
   “channelDimension”:{
      “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 articleSKU style",
         "mrp":1299.00,
         "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,
    "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": {
               "childSkus": [
                   {
                       "channelSkuCode": "erpArticleCode3",
                       "qty": 2
                   },
                   {
                       "channelSkuCode": "erpArticleCode1",
                       "qty": 1
                   }
               ],
               "virtualParentChannelSkuId": "erpArticleCode2"
           }
      }
   ]
}

...

Parameter Name

Data Type

Description

articleMasters

Object[ ]

List of article 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.

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 articleSKU(if added, then l,b,h,w are mandatory)

channelDimension.length

Double

Length of article SKU in cms

channelDimension.breadth

Double

Width of article SKU in cms

channelDimension.height

Double

Height of article SKU in cms

channelDimension.weight

Double

Weight of article SKU in grams

taxRule

String

Rule used to compute tax as per Assure 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

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

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

...