Province - Boxme API

Request

Path Params

country_code

string

required

Example:

VN

Header Params

Authorization

string

required

Example:

Token {{API_TOKEN}}

Content-Type

string

optional

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

Responses

🟢200OK

application/json

Body

data

object

required

total_count

integer

required

provinces

array [object {5}]

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
  "data": {
    "total_count": 63,
    "provinces": [
      {
        "id": 1,
        "code": "HNI",
        "country_code": "VN",
        "province_name": "Hà Nội",
        "province_name_local": "Hà Nội"
      },
      {
        "id": 2,
        "code": "HGG",
        "country_code": "VN",
        "province_name": "Hà Giang",
        "province_name_local": "Hà Giang"
      },
      {
        "id": 4,
        "code": "CBG",
        "country_code": "VN",
        "province_name": "Cao Bằng",
        "province_name_local": "Cao Bằng"
      },
      {
        "id": 6,
        "code": "BKN",
        "country_code": "VN",
        "province_name": "Bắc Kạn",
        "province_name_local": "Bắc Kạn"
      },
      {
        "id": 8,
        "code": "TQG",
        "country_code": "VN",
        "province_name": "Tuyên Quang",
        "province_name_local": "Tuyên Quang"
      },
      {
        "id": 10,
        "code": "LCI",
        "country_code": "VN",
        "province_name": "Lào Cai",
        "province_name_local": "Lào Cai"
      },
      {
        "id": 11,
        "code": "DBN",
        "country_code": "VN",
        "province_name": "Điện Biên",
        "province_name_local": "Điện Biên"
      },
      {
        "id": 12,
        "code": "LCU",
        "country_code": "VN",
        "province_name": "Lai Châu",
        "province_name_local": "Lai Châu"
      },
      {
        "id": 14,
        "code": "SLA",
        "country_code": "VN",
        "province_name": "Sơn La",
        "province_name_local": "Sơn La"
      },
      {
        "id": 15,
        "code": "YBN",
        "country_code": "VN",
        "province_name": "Yên Bái",
        "province_name_local": "Yên Bái"
      },
      {
        "id": 17,
        "code": "HBH",
        "country_code": "VN",
        "province_name": "Hòa Bình",
        "province_name_local": "Hòa Bình"
      },
      {
        "id": 19,
        "code": "TNN",
        "country_code": "VN",
        "province_name": "Thái Nguyên",
        "province_name_local": "Thái Nguyên"
      },
      {
        "id": 20,
        "code": "LSN",
        "country_code": "VN",
        "province_name": "Lạng Sơn",
        "province_name_local": "Lạng Sơn"
      },
      {
        "id": 22,
        "code": "QNH",
        "country_code": "VN",
        "province_name": "Quảng Ninh",
        "province_name_local": "Quảng Ninh"
      },
      {
        "id": 24,
        "code": "BGG",
        "country_code": "VN",
        "province_name": "Bắc Giang",
        "province_name_local": "Bắc Giang"
      },
      {
        "id": 25,
        "code": "PHO",
        "country_code": "VN",
        "province_name": "Phú Thọ",
        "province_name_local": "Phú Thọ"
      },
      {
        "id": 26,
        "code": "VPC",
        "country_code": "VN",
        "province_name": "Vĩnh Phúc",
        "province_name_local": "Vĩnh Phúc"
      },
      {
        "id": 27,
        "code": "BNH",
        "country_code": "VN",
        "province_name": "Bắc Ninh",
        "province_name_local": "Bắc Ninh"
      },
      {
        "id": 30,
        "code": "HDG",
        "country_code": "VN",
        "province_name": "Hải Dương",
        "province_name_local": "Hải Dương"
      },
      {
        "id": 31,
        "code": "HPG",
        "country_code": "VN",
        "province_name": "Hải Phòng",
        "province_name_local": "Hải Phòng"
      }
    ]
  },
  "error": false,
  "error_code": "",
  "messages": "",
  "request_id": 1703824318
}