Parameter Search Cities by Country Guide

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

Use this API to search for cities within a specific country by partial or full name — useful for autocomplete fields.

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

Endpoint

GET https://ppapi.qima.com/parameter/v2/country/{countryId}/searchCities

Prerequisites

• A countryId obtained from Get All Countries or Search Countries

Path Parameters

Parameter	Required	Description
countryId	Yes	Country ID, from Get All Countries or Search Countries.

Query Parameters

Parameter	Required	Description
name	No	Partial or full city name to search for.
rows	No	Maximum number of results to return.

Request Example

curl --location --request GET 'https://ppapi.qima.com/parameter/v2/country/23424781/searchCities?name=ShenZhen' \
  --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

{
    "message": null,
    "content": [
        { "label": "Shenzhen, Guangdong", "value": "12687656" }
    ]
}

Response Field Notes

Field	Notes
content[].label	City display name — note it may include the province name, e.g. "Shenzhen, Guangdong".
content[].value	The city ID. Use this as supplierCityID/factoryCityID.

Common Errors

See common authentication errors for 401 and 403 responses.

Next Steps

• Use a matched city's value as supplierCityID/factoryCityID when booking an Inspection, Audit, or Lab Testing order, or managing a Supplier.