City API

City API dùng để lấy danh sách tỉnh/thành phố trên hệ thống Goship API. Các thông tin này bao gồm:

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

Lấy tất cả tỉnh/thành phố

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

Response data:

{
  "code": 200,
  "status": "success",
  "data": [
    {
      "id": "100000",
      "name": "Hà Nội"
    },
    {
      "id": "700000",
      "name": "Hồ Chí Minh"
    }
  ]
}

Ghi chú: API lấy thông tin tỉnh/thành phố không có phân trang.

Lấy danh sách quận/huyện theo mã tỉnh/thành phố

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

Trong đó, code là mã tỉnh/thành phố.

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"
    },
    {
      "id": "102200",
      "name": "Huyện Đan Phượng",
      "city_id": "100000"
    }
  ]
}