API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Address Directory
  • Config
    • List Pickup Address
      GET
    • List Box Dimension
      GET
    • List vendor
      GET
    • List store
      GET
  • Online Product
    • Options
      • List category
      • List brand
    • Create Single Product
      POST
    • Create Product From Product Inventory
      POST
    • List product
      GET
    • Product detail
      GET
  • Product Inventory
    • Options
      • List Outbound Strategy
      • List Product Type
      • List Material
      • List Storage Method
    • List product inventory
      GET
    • Product inventory detail
      GET
    • Create single inventory product
      POST
  • Order
    • Shipping Service
      • Preview shipping prices
        • List shipping service
        • List available courier
      • List available courier from order
      • List shipping service of courier
    • Create order B2C
      POST
    • Create order B2B
      POST
    • List order
      GET
    • Order detail
      GET
    • Cancel order
      PATCH
  • Shipment
    • Create shipment auto
      POST
    • [Retail][Ship by self] Create shipment with item
      POST
    • Cancel shipment
      PATCH
    • List shipment
      GET
    • Shipment detail
      GET
    • List shipment of order
      GET
  • Shipment Inbound
    • Create shipment inbound
    • Cancel shipment inbound
    • List shipment inbound
    • Shipment inbound detail
    • Shipment inbound items
  • Order Return
    • List return order
    • Return order detail
    • Create return order
    • Cancel Return Order
  • Courier
    • List courier service integrated
    • List courier operate
    • List courier integrated
  • Address Directory
    • Province
      GET
    • District
      GET
    • Ward
      GET
  1. Address Directory

Ward

GET
/api/v1/addresses/ward/list
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/api/v1/addresses/ward/list?district_id={{district_id}}' \
--header 'Authorization;'
Response Response Example
{"status_code":200,"data":[{"id":11074,"province_id":30,"district_id":298,"country":"VN","ward_name":"Thị trấn Tứ Kỳ"},{"id":11125,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã An Thanh"},{"id":11092,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Bình Lăng"},{"id":11095,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Chí Minh"},{"id":11140,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Cộng Lạc"},{"id":11119,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Đại Hợp"},{"id":11083,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Đại Sơn"},{"id":11110,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Dân Chủ"},{"id":11149,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Hà Kỳ"},{"id":11152,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Hà Thanh"},{"id":11086,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Hưng Đạo"},{"id":11128,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Minh Đức"},{"id":11089,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Ngọc Kỳ"},{"id":11146,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Nguyên Giáp"},{"id":11137,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Phượng Kỳ"},{"id":11116,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Quang Khải"},{"id":11122,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Quảng Nghiệp"},{"id":11101,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Quang Phục"},{"id":11134,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Quang Trung"},{"id":11098,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Tái Sơn"},{"id":11113,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Tân Kỳ"},{"id":11143,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Tiên Động"},{"id":11131,"province_id":30,"district_id":298,"country":"VN","ward_name":"Xã Văn Tố"}],"error":false,"error_code":null,"log_id":null,"messages":"","total":23}

Request

Query Params
district_id
string 
optional
Example:
{{district_id}}
Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}

Responses

🟢200OK
application/json
Body
status_code
integer 
required
data
array [object {5}] 
required
id
integer 
required
province_id
integer 
required
district_id
integer 
required
country
string 
required
ward_name
string 
required
error
boolean 
required
error_code
null 
required
log_id
null 
required
messages
string 
required
total
integer 
required
Previous
District
Built with