We announce the release of a new API version aimed at providing convenience for our partners using the service.

Boxme API

District

GET

https://s.boxme.asia/api/v2/sellers/locations/{country_code}/provinces/{province_id}/districts

Last modified:2024-01-02 05:25:02

Request

Path Params

country_code

string

required

Example:

province_id

string

required

Example:

Header Params

Authorization

string

required

Example:

Token {{API_TOKEN}}

Content-Type

string

optional

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://s.boxme.asia/api/v2/sellers/locations/VN/provinces/1/districts' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json'

Responses

🟢200OK

application/json

Body

data

object

required

total_count

integer

required

districts

array [object {6}]

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
  "data": {
    "total_count": 707,
    "districts": [
      {
        "id": 19,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Quận Nam Từ Liêm",
        "district_name_local": "Quận Nam Từ Liêm"
      },
      {
        "id": 20,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Thanh Trì",
        "district_name_local": "Huyện Thanh Trì"
      },
      {
        "id": 21,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Quận Bắc Từ Liêm",
        "district_name_local": "Quận Bắc Từ Liêm"
      },
      {
        "id": 250,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Mê Linh",
        "district_name_local": "Huyện Mê Linh"
      },
      {
        "id": 268,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Quận Hà Đông",
        "district_name_local": "Quận Hà Đông"
      },
      {
        "id": 269,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Thị xã Sơn Tây",
        "district_name_local": "Thị xã Sơn Tây"
      },
      {
        "id": 271,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Ba Vì",
        "district_name_local": "Huyện Ba Vì"
      },
      {
        "id": 272,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Phúc Thọ",
        "district_name_local": "Huyện Phúc Thọ"
      },
      {
        "id": 273,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Đan Phượng",
        "district_name_local": "Huyện Đan Phượng"
      },
      {
        "id": 274,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Hoài Đức",
        "district_name_local": "Huyện Hoài Đức"
      },
      {
        "id": 275,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Quốc Oai",
        "district_name_local": "Huyện Quốc Oai"
      },
      {
        "id": 276,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Thạch Thất",
        "district_name_local": "Huyện Thạch Thất"
      },
      {
        "id": 277,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Chương Mỹ",
        "district_name_local": "Huyện Chương Mỹ"
      },
      {
        "id": 278,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Thanh Oai",
        "district_name_local": "Huyện Thanh Oai"
      },
      {
        "id": 279,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Thường Tín",
        "district_name_local": "Huyện Thường Tín"
      },
      {
        "id": 280,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Phú Xuyên",
        "district_name_local": "Huyện Phú Xuyên"
      },
      {
        "id": 281,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Ứng Hòa",
        "district_name_local": "Huyện Ứng Hòa"
      },
      {
        "id": 282,
        "code": "",
        "country_code": "VN",
        "province_id": 1,
        "district_name": "Huyện Mỹ Đức",
        "district_name_local": "Huyện Mỹ Đức"
      },
      {
        "id": 24,
        "code": "",
        "country_code": "VN",
        "province_id": 2,
        "district_name": "Thành phố Hà Giang",
        "district_name_local": "Thành phố Hà Giang"
      },
      {
        "id": 26,
        "code": "",
        "country_code": "VN",
        "province_id": 2,
        "district_name": "Huyện Đồng Văn",
        "district_name_local": "Huyện Đồng Văn"
      }
    ]
  },
  "error": false,
  "error_code": "",
  "messages": "",
  "request_id": 1703233584
}

Modified at 2024-01-02 05:25:02

Province

Sub-district