Lấy danh sách mã Phường-Xã

API Lấy mã Phường/Xã

 

Sử dụng API này để lấy mã Phường/Xã để tạo đơn hàng.

Lưu ý : API này cần truyền token ở header.

post/get
https://online-gateway.ghn.vn/shiip/public-api/master-data/ward?district_id
https://dev-online-gateway.ghn.vn/shiip/public-api/master-data/ward?district_id
curl --location --request POST 'https://dev-online-gateway.ghn.vn/shiip/public-api/master-data/ward?district_id' \
                    --header 'token: 637170d5-942b-11ea-9821-0281a26fb5d4' \
                    --header 'Content-Type: application/json' \
                    --data-raw'{"district_id":1566}'
                    

Cấu trúc Request

Trường dữ liệu Kiểu dữ liệu Mô tả
token String

Dùng để xác định định danh của tài khoản và dùng cho các trường hợp gọi tới các API.

district_id Int

Mã Quận/Huyện được lấy từ API Lấy mã Quận/Huyện.

{
                        "code": 200,
                        "message": "Success",
                        "data": {
                            "WardCode":90768   
                            "DistrictID":3695
                            "WardName":"Phường An Khánh"     
                            "NameExtension": [
                                "P. An Khánh" 
                                "P. An Khanh" 
                                "ankhanh"
                            ],
                            "CanUpdateCOD":"true"
                            "SupportType":3   
                            "Status":1
                            "CreatedDate":"2020-12-25T08:37:00.733Z"
                            "UpdatedDate":"2021-09-02T17:00:03.375Z"
                            ....
                            }
        }

Cấu trúc Response

Trường dữ liệu Mô tả
WardCode

Mã Phường/Xã.

DistrictID

Mã Quận/Huyện.

WardName

Tên Phường/Xã.

NameExtension

Tên mở rộng.

CanUpdateCOD

Có thể cập nhật tiền thu hộ:

true:

false:Không

SupportType

Loại hỗ trợ:

0:Khóa tuyến

1:Lấy/Trả

2:Giao

3:Lấy/Giao/Trả

Status

Trạng thái:

1:Mở tuyến

2:Khóa tuyến

CreatedDate

Thời gian tạo.

UpdatedDate

Thời gian cập nhật.

{
                        "code": 404,
                        "message": "code=404, message=Not Found",
                        "data": null
        }