Supplier Search Guide

Latest Update Time: 2026-07-02 00:00:00

Use this API to retrieve the list of suppliers associated with your client account.

See the Supplier Introduction for base URL, authentication, and required headers.

Endpoint

GET https://ppapi.qima.com/user/v2/{userId}/suppliers

Prerequisites

In addition to the required headers and authentication setup:

Permission to view suppliers for the target client

Path Parameters

Parameter	Required	Description
`userId`	Yes	QIMA client user login ID.

Query Parameters

Parameter	Required	Description
`type`	No	Filter suppliers by type (e.g. `FACTORY`, `AGENT`). Returns all types if omitted.

Request Example

curl --location --request GET 'https://ppapi.qima.com/user/v2/<qima-user-id>/suppliers' \
  --header 'Ai-Api-Access-Token: {your api access token}' \
  --header 'Ai-User-Id: {your user ID}' \
  --header 'Authorization: Bearer {your token}' \
  --header 'Referer: https://preprodmy.qima.com/'

Successful Response

content is an array of supplier summaries (a lighter-weight shape than Get Supplier Details's full record). No pagination wrapper — all matching suppliers are returned in one call.

{
    "message": null,
    "content": [
        {
            "id": "402FA958F78743B68428A62BF4D6F71B",
            "name": "JiXieChang-Supplier1111",
            "city": "12687656",
            "province": null,
            "country": "23424781",
            "cityName": "Shenzhen",
            "provinceName": null,
            "countryName": "China",
            "contact": "Bill Gates",
            "telephone": "+86 0755 81112222",
            "email": "aaa@bbb.com;ccc@ddd.com",
            "address": "NO.1, A ROAD, B STREET, C DISTRICT",
            "createdDate": "2026-07-02 16:47:28",
            "identificationCode": "CLIENT-SUP-007",
            "createdDateUnixTimestamp": 1782982048000,
            "updateDate": "2026-07-02 16:47:28",
            "updateDateUnixTimestamp": 1782982048000,
            "mobile": "13811112222"
        }
    ]
}

Response Field Notes

Field	Notes
`content[].id`	Supplier ID. Pass to Get Supplier Details, Update, or Delete.
`content[].name`	Supplier's `entityName`.
`content[].contact` / `telephone` / `email` / `mobile`	Taken from the supplier's `contactInfo.main`.
`content[].createdDateUnixTimestamp` / `updateDateUnixTimestamp`	Unix timestamp in milliseconds.

Common Errors

See common authentication errors for 401 and 403 responses.

Status	Meaning	Recommended Action
`404 Not Found`	No suppliers found, or an error occurred.	Confirm `userId` is correct.

Next Steps

Use a result's id with Get Supplier Details for the full record.

Documents