Create Vendor Master API (Beta)

Inbound | POST | /master/vendors

Summary

This API creates vendor masters in Increff system.

Description

ERP systems recognise their vendors/suppliers with a code which is commonly referred to as vendor code. This API can be used to create vendors corresponding to the ERP vendors in Increff Omni.

Request body

{
  "vendorCode": "VENDOR123",
  "address": {
    "city": "Metropolis",
    "country": "India",
    "email": "xyz@gmail.com",
    "line1": "Address line 1",
    "line2": "Address line 2",
    "line3": "Address line 3",
    "name": "John Doe",
    "phone": "999999999",
    "state": "Karnataka",
    "zip": "560102"    
  },
  "name": "Vendor Name",
  "isExcessGrnAllowed": true,
  "isAsnExpected": false,
  "isCDSampleQCAllowed" : true,
  "priority": 1,
  "isStorageSampleQcAllowed": true,
  "minStorageSampleInspectPercent": 5,
  "minStoragePassPercent": 5,
  "minCdSampleInspectPercent": 5,
  "minCdPassPercent": 5
}

Parameter Name	Data Type	Description	Mandatory

Parameter Name	Data Type	Description	Mandatory
`vendorCode`	String	Code used by ERP to identify vendors	Yes
`name`	String	Name of vendor	Yes
`isExcessGrnAllowed`	boolean	isExcessGrnAllowed for the supplier	No
`isAsnExpected`	boolean	`isAsnExpected` for the supplier	Yes
`address`	Object	Address of vendor	Yes
`address.name`	String	Name of vendor	Yes
`address.line1`	String	1st line of vendor’s address	Yes
`address.line2`	String	2nd line of vendor’s address	No
`address.line3`	String	3rd line of vendor’s address	No
`address.city`	String	City of vendor	Yes
`address.state`	String	State of vendor	Yes
`address.zip`	String	ZIP/Pin code of vendor	Yes
`address.country`	String	Country of vendor	Yes
`address.email`	String	Email of vendor	Yes
`address.phone`	String	Phone Number of vendor	No
`priority`	Integer	The priority of the vendor during picking of orders Highest priority -1 and lowest - 5 null value will be considered as priority 3 in OMS	No
`isStorageSampleQcAllowed`	Boolean	Whether storage sample QC is allowed for the vendor Possible values → true/false	No
`isCDSampleQCAllowed`	Boolean	Whether sample QC allowed for Crossdock boxes Possible values → true/false	No
`minStorageSampleInspectPercent`	Integer	Minimum percentage of storage samples to be inspected	No
`minStoragePassPercent`	Integer	Minimum percentage of storage samples that must pass QC	No
`minCdSampleInspectPercent`	Integer	Minimum percentage of CD (cross-dock) samples to be inspected	No
`minCdPassPercent`	Integer	Minimum percentage of CD samples that must pass QC	No

Response Body

EmptyBody

HttpStatus : 200