Thành phố, quận huyện
  • /api/shipping/location: Lấy danh sách thành phố, quận huyện từ Nhanh.vn.
  • Các API đồng bộ đơn hàng, tính phí vận chuyển sẽ cần sử dụng đến các dữ liệu này.
  • Chú ý: Dữ liệu thành phố, quận huyện rất ít khi bị thay đổi (chỉ xảy ra khi có thay đổi tên, chia tách hoặc gộp 1 vài thành phố, quận huyện), bạn có thể cache dữ liệu trên hệ thống của bạn để giảm tải việc phải gọi API liên tục, thời gian cache khuyến cáo là 24h.

Request

Param
Type
Description
type
string (optional)
CITY/DISTRICT/WARD (mặc định là CITY)
parentId
int (optional)
Nếu type = DISTRICT thì parentId = id của thành phố cần lấy ra danh sách quận huyện. Nếu type = WARD thì parentId = id của quận huyện cần lấy ra.

Response

  • JSON decode the response to get the structure:
Key
Type
Description
code
int
1 = success or 0 = failed
messages
[ ]
is an array of error messages if code = 0
data
[ ]
Mảng danh sách thành phố hoặc quận huyện
  • Nếu type = CITY
1
data = [
2
[
3
"id": 2, // int
4
"name": "Hà Nội" // string
5
],
6
[
7
"id": 3,
8
"name": "Hồ Chí Minh"
9
],
10
...
11
]
Copied!
  • Nếu type = DISTRICT
1
data = [
2
[
3
"id" => 2, // int
4
"parentId" => 2, // int
5
"name" => "Quận Hoàn Kiếm" // string
6
],
7
[
8
"id" => 6,
9
"cityLocationId" => 2,
10
"name" => "Quận Hai Bà Trưng"
11
],
12
...
13
]
Copied!
  • Nếu type = WARD
1
data = [
2
[
3
"id" => 2, // int
4
"parentId" => 3, // int
5
"name" => "Phường Bạch Đằng" // string
6
],
7
[
8
"id" => 6,
9
"parentId" => 3,
10
"name" => "Phường Bách Khoa"
11
],
12
...
13
]
Copied!
Copy link