We announce the release of a new API version aimed at providing convenience for our partners using the service.
- Overview
- Getting Started
- Authentication
- Q&A
- Common Errors
- API Call Flow
- Instant Order Flow
- Boxme's RTO and RPO
- Changelog
- API References
- Location
- Pickup
- Product
- Shipment (ASN)
- Customer
- Orders
- Order API Overview
- Error Codes
- Get Shipping Option (Fulfillment)
- Get Shipping Option (Dropship)
- Create B2C Order
- Create Delivery Order
- Create B2B Order
- Update Document
- Request Cancel Delivery Order
- Cancel Order
- Get Order Detail
- Get Order List
- Get Courier List
- Get Courier Service
- Get Packed Items
- Order Pack
- Get B2B Pickup TimeSlot
- Returns
- Finance
- Location
- Webhooks
- Guidelines
Sub-district
GET
https://s.boxme.asia/api/v2/sellers/locations/{country_code}/provinces/{province_id}/districts/{district_id}/sub-districts
Last modified:2024-01-02 05:25:14
Request
Path Params
country_code
string
required
Example:
VN
province_id
string
required
Example:
1
district_id
string
required
Example:
1
Header Params
Authorization
string
required
Example:
Token {{API_TOKEN}}
Content-Type
string
optional
Example:
application/json
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://s.boxme.asia/api/v2/sellers/locations/VN/provinces/1/districts/1/sub-districts' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json'Responses
🟢200OK
application/json
Body
data
object
required
total_count
integer
required
subdistricts
array [object {6}]
required
error
boolean
required
error_code
string
required
messages
string
required
request_id
string
required
Example
{
"data": {
"total_count": 10729,
"subdistricts": [
{
"id": 592,
"province_id": 1,
"district_id": 19,
"country_code": "VN",
"sub_district_name": "Phường Cầu Diễn",
"sub_district_local": "Phường Cầu Diễn"
},
{
"id": 595,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Thượng Cát",
"sub_district_local": "Phường Thượng Cát"
},
{
"id": 598,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Liên Mạc",
"sub_district_local": "Phường Liên Mạc"
},
{
"id": 601,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Đông Ngạc",
"sub_district_local": "Phường Đông Ngạc"
},
{
"id": 602,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Đức Thắng",
"sub_district_local": "Phường Đức Thắng"
},
{
"id": 604,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Thụy Phương",
"sub_district_local": "Phường Thụy Phương"
},
{
"id": 607,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Tây Tựu",
"sub_district_local": "Phường Tây Tựu"
},
{
"id": 610,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Xuân Đỉnh",
"sub_district_local": "Phường Xuân Đỉnh"
},
{
"id": 611,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Xuân Tảo",
"sub_district_local": "Phường Xuân Tảo"
},
{
"id": 613,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Minh Khai",
"sub_district_local": "Phường Minh Khai"
},
{
"id": 616,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Cổ Nhuế 1",
"sub_district_local": "Phường Cổ Nhuế 1"
},
{
"id": 617,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Cổ Nhuế 2",
"sub_district_local": "Phường Cổ Nhuế 2"
},
{
"id": 619,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Phú Diễn",
"sub_district_local": "Phường Phú Diễn"
},
{
"id": 620,
"province_id": 1,
"district_id": 21,
"country_code": "VN",
"sub_district_name": "Phường Phúc Diễn",
"sub_district_local": "Phường Phúc Diễn"
},
{
"id": 622,
"province_id": 1,
"district_id": 19,
"country_code": "VN",
"sub_district_name": "Phường Xuân Phương",
"sub_district_local": "Phường Xuân Phương"
},
{
"id": 623,
"province_id": 1,
"district_id": 19,
"country_code": "VN",
"sub_district_name": "Phường Phương Canh",
"sub_district_local": "Phường Phương Canh"
},
{
"id": 625,
"province_id": 1,
"district_id": 19,
"country_code": "VN",
"sub_district_name": "Phường Mỹ Đình 1",
"sub_district_local": "Phường Mỹ Đình 1"
},
{
"id": 626,
"province_id": 1,
"district_id": 19,
"country_code": "VN",
"sub_district_name": "Phường Mỹ Đình 2",
"sub_district_local": "Phường Mỹ Đình 2"
},
{
"id": 628,
"province_id": 1,
"district_id": 19,
"country_code": "VN",
"sub_district_name": "Phường Tây Mỗ",
"sub_district_local": "Phường Tây Mỗ"
},
{
"id": 631,
"province_id": 1,
"district_id": 19,
"country_code": "VN",
"sub_district_name": "Phường Mễ Trì",
"sub_district_local": "Phường Mễ Trì"
}
]
},
"error": false,
"error_code": "",
"messages": "",
"request_id": 1703234545
}Modified at 2024-01-02 05:25:14