District

District API được dùng để lấy danh sách quận/huyện trên hệ thống Goship API. 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ố

Lấy danh sách quận/huyện

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

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 https://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

Tham khảo tài liệu mô tả về Phân trang

GET https://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 https://sandbox.goship.io/api/v2/districts/{code}/wards

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

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"
    }
  ]
}