Add Supplier / Warehouse in Increff Label Software

Inbound | POST | `/entity`

Summary

This API is used to create entities in the Increff Label Software system.

Description

This API will create external item codes which can be used to print on the label. This external code will be unique to every item. By default, the external item codes will be used on a FIFO basis. A knockoffKey can be passed with each externalCode to customize this behavior.

Request

[
  {
    "entityCode": "supplierNo1",
    "entityName": "First Supplier",
    "type": "SUPPLIER"
  },
  {
    "entityCode": "warehouseNo1",
    "entityName": "First Warehouse",
    "type": "WAREHOUSE"
  }
]

Parameter Name	Data Type	Description	Mandatory
`entityCode`	String	Unique code of the Entity	Yes
`entityName`	String	Descriptive name of the entity	Yes
`type`	ENUM (`SUPPLIER`, `WAREHOUSE`)	Type of the entity can only be “SUPPLIER” or “WAREHOUSE”	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

Empty Body

HttpStatus Code

200

<aside> ℹ️ Note