Create Item Codes

Inbound | POST | /item/generate

Summary

This API is used to create and get item codes in Increff Label Software system.

Description

This API will create item codes which can be used to print on the label. This item codes will be unique to every item.

Note

Maximum number of SKUs in 1 API call is 100.
Maximum quantity for 1 SKU is 100
‘externalCode’ will contain value only if the the external code configuration is enabled , else ‘null’ value will be returned

Request

{
  "skuCodeList": [
    {
      "skuCode": "SKU123",
      "quantity": 3
    },
    {
      "skuCode": "SKU124",
      "quantity": 2
    },
    {
      "skuCode": "SKU111",
      "quantity": 32
    },
    {
      "skuCode": "SKU112",
      "quantity": 12
    },
    {
      "skuCode": "SKU113",
      "quantity": 7
    }
  ]
}

Parameter Name	Data Type	Description	Mandatory
`skuCodeList`	[ ] object	List of SKUs	Yes
`skuCodeList.skuCode`	String	Represents the SKU ID of the product	Yes
`skuCodeList.quantity`	Integer	Represents the number of item codes to be generated corresponding to the SKU CODE	Yes

Request Headers

Header Name	Description	Mandatory
`authDomainname`	Organisation ID for the client created in Increff Label Software	Yes
`authUsername`	Username for integration user created in Increff Label Software	Yes
`authPassword`	Password for integration user created in Increff Label Software	Yes

Response

{
  "successList": [
    {
      "skuCode": "SKU123",
      "quantity": 3,
      "itemCodes": [
        {
          "itemCode": "itemCode11",
          "externalCode": "externalCode11"
        },
        {
          "itemCode": "itemCode12",
          "externalCode": "externalCode12"
        },
        {
          "itemCode": "itemCode13",
          "externalCode": "externalCode13"
        }
      ]
    },
    {
      "skuCode": "SKU124",
      "quantity": 2,
      "itemCodes": [
        {
          "itemCode": "itemCode21",
          "externalCode": "externalCode21"
        },
        {
          "itemCode": "itemCode22",
          "externalCode": "externalCode22"
        }
      ]
    }
  ],
  "failureList": ["SKU111", "SKU112", "SKU113"]
}

HttpStatus Code

200