Lấy danh sách mã Tỉnh - Thành

API Lấy Tỉnh Thành

 

Sử dụng API này để lấy mã Tỉnh/Thành để gọi API Quận/Huyện, Phường/Xã.

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

post/get 
https://online-gateway.ghn.vn/shiip/public-api/master-data/province
https://dev-online-gateway.ghn.vn/shiip/public-api/master-data/province
curl --location --request GET 'https://dev-online-gateway.ghn.vn/shiip/public-api/master-data/province'
--header 'Content-Type: application/json' 
--header 'Token: d6e3dccb-6289-11ea-8b85-c60e4edfe802

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.

  • Success 200

{
    "code": 200,
    "message": "Success",
    "data": 
    {
        "ProvinceID": 202,
        "ProvinceName": "Hồ Chí Minh",
        "CountryID": 1,
        "Code": 8,
        "NameExtension": 
        [
            "Hồ Chí Minh",
            "TP.Hồ Chí Minh",
            "TP. Hồ Chí Minh",
            "TP Hồ Chí Minh",
            "Thành phố Hồ Chí Minh",
            "HCM",
            "hochiminh",
            "saigon",
            "sg"
        ],
        "IsEnable": 1,
        "RegionID": 1,
        "UpdatedBy": 1718600,
        "CreatedAt": "2019-12-05 15:41:26.891217",
        "UpdatedAt": "2019-12-05 15:41:26.891217",
        "CanUpdateCOD": "false",
        "Status": 1
        ....
    }
}

Cấu trúc Response

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

Mã Tỉnh/Thành.
ProvinceName

Tên Tỉnh/Thành.
NameExtension

Tên mở rộng.
CreatedAt

Thời gian tạo.
UpdatedAt

Thời gian cập nhật.
CanUpdateCOD

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

true:Có

false:Không
Status

Trạng thái:

1:Mở tuyến

2:Khóa tuyến

 
{
    "code": 401,
    "message": "code=401, message=Token is not valid!",
    "data": null
}