Lấy danh sách bưu cục

API Lấy danh sách bưu cục

 

Sử dụng API này để lấy ra danh sách bưu cục để tạo đơn hàng khi mang hàng ra bưu cục gửi.

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

post/get 
https://online-gateway.ghn.vn/shiip/public-api/v2/station/get
https://dev-online-gateway.ghn.vn/shiip/public-api/v2/station/get
curl --location --request GET 'https://dev-online-gateway.ghn.vn/shiip/public-api/v2/station/get' \
            --header 'token: 637170d5-942b-11ea-9821-0281a26fb5d4' \
            --header 'Content-Type: application/json' \
            --data-raw'{"district_id":"1442",
                "ward_code":"20101",
                "offset":0,
                "limit":1000}'

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 Quận/Huyện.
ward_code String

Mã Phường/Xã được lấy từ API Lấy Phường/Xã.

Có thể : null
offset Int

Mặc định =0
limit Int

Số liệu trả về không quá 1000.

  • Success 200

{
                "code": 200,
                "message": "Success",
                "data":[
                {
                "address":"2Bis Nguyễn Thị Minh Khai, Phường Đa Kao, Quận 1, TP.HCM", 
                "locationCode":2443, 
                "locationId":2443,           
                "locationName":"Bưu Cục 2 Bis Nguyễn Thị Minh Khai-Q.1-HCM", 
                "parentLocation":
                [ 
                "REGION"/"E",
                "PROVINCE"/202,
                "DISTRICT"/1442,
                "WARD"/"20106",
                "SECTION"/"EXREG0081S",
                ],
                "email":"",
                "latitude":10.7900041,
                "longitude":106.7041314,
                "wardName":"Phường Đa Kao",
                "districtName":"Quận 1",
                "provinceName":"Hồ Chí Minh",
                "iframeMap":""
                },
                ...
                ]
            }

Cấu trúc Response

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

Địa chỉ bưu cục.
locationName

Tên bưu cục.
REGION/1

Khu vực.
PROVINCE/202

Tỉnh thành.
DISTRICT/1442

Quận/Huyện.
WARD/20101

Phường/Xã.
email

Email.
latitude

Vĩ độ.
longitude

Kinh độ.
wardName

Tên phường/xã.
districtName

Tên quận/huyện.
provinceName

Tên tỉnh thành.
iframeMap

Khung nội tuyến.

 
{
                "code": 400,
                "message": "code=400, message=Syntax error: offset=24, error=invalid character '\\n' in string literal, internal=invalid character '\\n' in string literal",
                "data": null
                "code_message":"USER_ERR_COMMON"
            }