Khu Vực
Các API về khu vực cho phép bạn xem danh sách các Tỉnh/Thành phố, Quận/Huyện, Phường/Xã mà SuperShip đang hỗ trợ lấy, giao và trả hàng.
Lấy Thông Tin Tỉnh/Thành Phố
API này cho phép bạn lấy thông tin Tỉnh/Thành Phố mà SuperShip đang hỗ trợ.
Endpoint
get/v1/partner/areas/province
Request
Ví Dụ
curl --request GET \
--url https://api.mysupership.vn/v1/partner/areas/province
Response
Tham Số Trả Về
| Thuộc_Tính | Kiểu_DL | Mô_Tả_Chi_Tiết |
|---|---|---|
| code | String | Mã Tỉnh/Thành Phố. Ví dụ: 79. |
| name | String | Tên Tỉnh/Thành Phố mà SuperShip đang hỗ trợ lấy, giao và trả hàng. Ví dụ: Thành phố Hồ Chí Minh. |
Ví Dụ
{
"status": "Success",
"results": [
{
"code": "01",
"name": "Thành phố Hà Nội"
},
{
"code": "79",
"name": "Thành phố Hồ Chí Minh"
}
]
}
Lấy Thông Tin Quận/Huyện
API này cho phép bạn lấy thông tin Quận/Huyện mà SuperShip đang hỗ trợ.
Endpoint
get/v1/partner/areas/district
Request
Các Tham Số
| Thuộc_Tính | Bắt_Buộc | Kiểu_DL | Mô_Tả_Chi_Tiết |
|---|---|---|---|
| province | Có | String | Mã Tỉnh/Thành Phố mà SuperShip đang hỗ trợ lấy, giao và trả hàng. Ví dụ: 79. |
Ví Dụ
curl --request GET \
--url 'https://api.mysupership.vn/v1/partner/areas/district?province=79'
Response
Tham Số Trả Về
| Thuộc_Tính | Kiểu_DL | Mô_Tả_Chi_Tiết |
|---|---|---|
| code | String | Mã Quận/Huyện. Ví dụ: 785. |
| name | String | Tên Quận/Huyện. Ví dụ: Huyện Bình Chánh. |
| province | String | Tên Tỉnh/Thành Phố mà SuperShip đang hỗ trợ lấy, giao và trả hàng. Ví dụ: Thành phố Hồ Chí Minh. |
Ví Dụ
{
"status": "Success",
"results": [
{
"code": "785",
"name": "Huyện Bình Chánh",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "783",
"name": "Huyện Củ Chi",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "784",
"name": "Huyện Hóc Môn",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "786",
"name": "Huyện Nhà Bè",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "760",
"name": "Quận 1",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "771",
"name": "Quận 10",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "772",
"name": "Quận 11",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "761",
"name": "Quận 12",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "769",
"name": "Quận 2",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "770",
"name": "Quận 3",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "773",
"name": "Quận 4",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "774",
"name": "Quận 5",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "775",
"name": "Quận 6",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "778",
"name": "Quận 7",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "776",
"name": "Quận 8",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "763",
"name": "Quận 9",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "777",
"name": "Quận Bình Tân",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "765",
"name": "Quận Bình Thạnh",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "764",
"name": "Quận Gò Vấp",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "768",
"name": "Quận Phú Nhuận",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "766",
"name": "Quận Tân Bình",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "767",
"name": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "762",
"name": "Quận Thủ Đức",
"province": "Thành phố Hồ Chí Minh"
}
]
}
Lấy Thông Tin Phường/Xã
API này cho phép bạn lấy thông tin Phường/Xã mà SuperShip đang hỗ trợ.
Endpoint
get/v1/partner/areas/commune
Request
Các Tham Số
| Thuộc_Tính | Bắt_Buộc | Kiểu_DL | Mô_Tả_Chi_Tiết |
|---|---|---|---|
| district | Có | String | Mã Quận/Huyện Phố mà SuperShip đang hỗ trợ lấy, giao và trả hàng. Ví dụ: 767. |
Ví Dụ
curl --request GET \
--url 'https://api.mysupership.vn/v1/partner/areas/commune?district=767'
Response
Tham Số Trả Về
| Thuộc_Tính | Kiểu_DL | Mô_Tả_Chi_Tiết |
|---|---|---|
| code | String | Mã Phường/Xã. Ví dụ: 27037. |
| name | String | Tên Phường/Xã. Ví dụ: Phường Hiệp Tân. |
| district | String | Tên Quận/Huyện. Ví dụ: Quận Tân Phú. |
| province | String | Tên Tỉnh/Thành Phố mà SuperShip đang hỗ trợ lấy, giao và trả hàng. Ví dụ: Thành phố Hồ Chí Minh. |
Ví Dụ
{
"status": "Success",
"results": [
{
"code": "27037",
"name": "Phường Hiệp Tân",
"district": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "27034",
"name": "Phường Hòa Thạnh",
"district": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "27028",
"name": "Phường Phú Thạnh",
"district": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "27025",
"name": "Phường Phú Thọ Hòa",
"district": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "27031",
"name": "Phường Phú Trung",
"district": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "27016",
"name": "Phường Sơn Kỳ",
"district": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "27019",
"name": "Phường Tân Quý",
"district": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "27010",
"name": "Phường Tân Sơn Nhì",
"district": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "27022",
"name": "Phường Tân Thành",
"district": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "27040",
"name": "Phường Tân Thới Hòa",
"district": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
},
{
"code": "27013",
"name": "Phường Tây Thạnh",
"district": "Quận Tân Phú",
"province": "Thành phố Hồ Chí Minh"
}
]
}