Create a new supplier

Request

Query Parameters

Name	Type	Location	Required	Description
userId	string	path	Yes	QIMA client user login ID.

Request Body

Content-Type: application/json

Field	Type	Required	Description
id	string	No	QIMA supplier id
entityName	string	Yes	Supplier name
chineseName	string	No	Supplier name in local language
continent	string	No	Supplier continent id, get it from /parameter/v2/continents
country	string	Yes	Supplier country id, get it from /parameter/v2/searchCountries, /parameter/v2/countries or /parameter/v2/continent/{continentId}/countries
province	string	No	Supplier province id, get it from /parameter/v2/country/{countryId}/provinces
city	string	Yes	Supplier city id, get it from /parameter/v2/country/{countryId}/searchCities, /parameter/v2/province/{provinceId}/searchCities or /parameter/v2/country/{countryId}/cities
district	string	No	Supplier district id, if applicable. `null` when not provided.
districtName	string	No	Supplier district name, if applicable. `null` when not provided.
address	string	Yes	Supplier's address
postcode	string	No
nearestOffice	string	No	Nearest QIMA office name
website	string	No
salesTurnover	string	No
noOfEmployees	string	No	Supplier's employee count
userId	string	No
type	string	No
businessLicenseNo	string	No
title	string	No
addressCn	string	No	Supplier's address in local language
identificationCode	string	No	Supplier's identifier code in client's system, can be used to link suppliers between QIMA's system and QIMA client's system
cityName	string	No	Supplier's city name
countryName	string	No	Supplier's country name
mainProductLines	array	Yes	Supplier's product lines, get product line from /parameter/v2/product-families API
contactInfo	object	Yes
contactInfo.main	object	Yes
contactInfo.main.name	string	Yes	Contact's first name plus given name
contactInfo.main.department	string	No
contactInfo.main.title	string	No	Contact's working position name
contactInfo.main.phone	string	Yes	Contact's phone number
contactInfo.main.mobile	string	No	Contact's mobile phone number
contactInfo.main.email	string	Yes	Contact's email(s), separate by semi-colon when multiple
contactInfo.alternate	object	No
accessMaps	array	No
accessMaps[].id	string	No
accessMaps[].docType	string	No
accessMaps[].fileName	string	No
accessMaps[].fileSize	integer	No
accessMaps[].url	string	No
qualityDocs	array	No
createBy	string	No
updateBy	string	No

Responses

200

New suppliers created successful

Content-Type: application/json

message

string

Field	Type	Description
message	string

content

object

Field	Type	Description
id	string	QIMA supplier id
entityName	string	Supplier name
chineseName	string	Supplier name in local language
continent	string	Supplier continent id, get it from /parameter/v2/continents
country	string	Supplier country id, get it from /parameter/v2/searchCountries, /parameter/v2/countries or /parameter/v2/continent/{continentId}/countries
province	string	Supplier province id, get it from /parameter/v2/country/{countryId}/provinces
city	string	Supplier city id, get it from /parameter/v2/country/{countryId}/searchCities, /parameter/v2/province/{provinceId}/searchCities or /parameter/v2/country/{countryId}/cities
district	string	Supplier district id, if applicable. `null` when not provided.
districtName	string	Supplier district name, if applicable. `null` when not provided.
address	string	Supplier's address
postcode	string
nearestOffice	string	Nearest QIMA office name
website	string
salesTurnover	string
noOfEmployees	string	Supplier's employee count
userId	string
type	string
businessLicenseNo	string
title	string
addressCn	string	Supplier's address in local language
identificationCode	string	Supplier's identifier code in client's system, can be used to link suppliers between QIMA's system and QIMA client's system
cityName	string	Supplier's city name
countryName	string	Supplier's country name
mainProductLines	array	Supplier's product lines, get product line from /parameter/v2/product-families API
contactInfo	object
contactInfo.main	object
contactInfo.main.name	string	Contact's first name plus given name
contactInfo.main.department	string
contactInfo.main.title	string	Contact's working position name
contactInfo.main.phone	string	Contact's phone number
contactInfo.main.mobile	string	Contact's mobile phone number
contactInfo.main.email	string	Contact's email(s), separate by semi-colon when multiple
contactInfo.alternate	object
accessMaps	array
accessMaps[].id	string
accessMaps[].docType	string
accessMaps[].fileName	string
accessMaps[].fileSize	integer
accessMaps[].url	string
qualityDocs	array
createBy	string
updateBy	string

{
  "message": null,
  "content": {
    "id": "A7B918B5222D4B0F98061168865EAF17",
    "entityName": "Sample Supplier Co.",
    "continent": "24865671",
    "country": "23424781",
    "province": "12578016",
    "city": "12687656",
    "district": null,
    "address": "NO.1, A ROAD, B STREET, C DISTRICT",
    "userId": "4C6E94072DFC4918B60752F701DE544A",
    "type": "SUPPLIER",
    "identificationCode": "CLIENT-SUP-002",
    "cityName": "Shenzhen",
    "countryName": "China",
    "mainProductLines": [
      "bigCat1_s2",
      "bigCat1_s3"
    ],
    "contactInfo": {
      "main": {
        "name": "Jane Doe",
        "phone": "+86 0755 81112222",
        "email": "main.contact@example.com;alternate.contact@example.com"
      }
    },
    "accessMaps": [],
    "qualityDocs": []
  }
}

412

Supplier name or identification already exist for a customer

Content-Type: application/json

{
  "message": "The supplier with the same name or identification code already exists",
  "content": null
}

500

Failed to create new supplier

Content-Type: application/json

POST

/user/v2/{userId}/supplier

Request samples

application/json

{ "id": "B8B447FD4CD948BEAC1960DF7253BD90", "entityName": "Supplier ABC", "chineseName": "富士康", "continent": "24865671", "country": "23424781", "province": "12578016", "city": "12687254", "district": "string", "districtName": "string", "address": "NO.1, A ROAD, B STREET, C DISTRICT", "postcode": "string", "nearestOffice": "Shenzhen office", "website": "string", "salesTurnover": "string", "noOfEmployees": "10", "userId": "string", "type": "string", "businessLicenseNo": "string", "title": "string", "addressCn": "string", "identificationCode": "string", "cityName": "Shenzhen", "countryName": "China", "mainProductLines": [ "bigCat1_s2", "bigCat1_s3" ], "contactInfo": { "main": { "name": "Jane Doe", "department": "string", "title": "Quality Manager", "phone": "+86 0755 81112222", "mobile": "+86 13811112222", "email": "main.contact@example.com;alternate.contact@example.com" }, "alternate": {} }, "accessMaps": [ { "id": "string", "docType": "string", "fileName": "string", "fileSize": 1, "url": "string" } ], "qualityDocs": [ {} ], "createBy": "string", "updateBy": "string" }

Response samples

application/json

{ "message": null, "content": { "id": "A7B918B5222D4B0F98061168865EAF17", "entityName": "Sample Supplier Co.", "continent": "24865671", "country": "23424781", "province": "12578016", "city": "12687656", "district": null, "address": "NO.1, A ROAD, B STREET, C DISTRICT", "userId": "4C6E94072DFC4918B60752F701DE544A", "type": "SUPPLIER", "identificationCode": "CLIENT-SUP-002", "cityName": "Shenzhen", "countryName": "China", "mainProductLines": [ "bigCat1_s2", "bigCat1_s3" ], "contactInfo": { "main": { "name": "Jane Doe", "phone": "+86 0755 81112222", "email": "main.contact@example.com;alternate.contact@example.com" } }, "accessMaps": [], "qualityDocs": [] } }

Quick Actions

Create a new supplier

Request

Query Parameters

Request Body

Responses

New suppliers created successful

message

content

Supplier name or identification already exist for a customer

Failed to create new supplier

Request samples

Response samples