District

API district được dùng để lấy toàn bộ hoặc 1 phần thông tin về quận/huyện trên hệ thống Goship. Các thông tin này bao gồm:

  • id: Mã quận/huyện, được dùng cho các tác vụ như tra cước phí, tạo vận đơn...
  • name: Tên quận/huyện
  • city_id: Mã tỉnh/thành phố

API district có duy nhất 1 url để lấy thông tin về quận/huyện

Lấy tất cả quận/huyện

GET http://sandbox.goship.io/api/v2/districts

Header

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG.....

Response data:

{
    "code": 200,
    "status": "success",
    "data": [
        {
            "id": "100300",
            "name": "Quận Hai Bà Trưng",
            "city_id": "100000"
        },
        {
            "id": "101500",
            "name": "Quận Hà Đông",
            "city_id": "100000"
        }
    ]
}

Phân trang:

Mặc định url này sẽ trả về 25 bản ghi, để lấy nhiều hơn hoặc ít hơn 25 bản ghi mặc định, chúng ta sử dụng tham số size trên query string, ví dụ:

GET http://sandbox.goship.io/api/v2/districts?size=30

Để di chuyển giữa các trang, chúng ta sử dụng tham số page trên query string

GET http://sandbox.goship.io/api/v2/districts?size=30&page=2

Lấy tất cả phường/xã theo mã quận/huyện

GET http://sandbox.goship.io/api/v2/districts/{code}/wards

Trong đó, code là mã quận huyện.

Header:

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG.....

Response data:

{
    "code": 200,
    "status": "success",
    "data": [
        {
        "id": 19,
        "name": "Phường  Quỳnh Lôi",
        "district_id": "100300"
    },
    {
        "id": 20,
        "name": "Phường Trương định",
        "district_id": "100300"
    },
    {
        "id": 21,
        "name": "Phường Thanh Trì",
        "district_id": "100300"
    },
    {
        "id": 22,
        "name": "Phường Kim Ngưu",
        "district_id": "100300"
    },
    {
        "id": 23,
        "name": "Phường Minh Khai",
        "district_id": "100300"
    }
    ]
}