Onerway
POST

City list

Use this endpoint to query cities or administrative divisions under a specified region.

Request

ApiKey
Issuing API key request header assigned by Onerway.
Example:
regionCode
Region or country code.
Example:
parentCode
Parent administrative division code for cascading queries.
Example:

Request example

curl -X POST 'https://sandbox-api.onerway.com/api/v1/merchant/common/cityList' \
  -H 'ApiKey: replace_with_issuing_api_key' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "parentCode": "GD",
  "regionCode": "CN"
}'

Response

respCode
Business response code. 20000 means success.
respMsg
Response message.
City or administrative division list.

Response example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": [
    {
      "regionCode": "CN",
      "parentCode": "GD",
      "cityCode": "SZ",
      "cityName": "Shenzhen"
    },
    {
      "regionCode": "CN",
      "parentCode": "GD",
      "cityCode": "GZ",
      "cityName": "Guangzhou"
    }
  ]
}
No error responses are documented for this endpoint.