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

Province

Developing
GET
/api/v1/addresses/province/list
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/addresses/province/list?country=VN' \
--header 'Authorization;'
Response Response Example
{
  "status_code": 200,
  "data": [
    {
      "id": 89,
      "country": "VN",
      "code": "AGG",
      "province_name": "An Giang"
    },
    {
      "id": 24,
      "country": "VN",
      "code": "BGG",
      "province_name": "Bắc Giang"
    },
    {
      "id": 6,
      "country": "VN",
      "code": "BKN",
      "province_name": "Bắc Kạn"
    },
    {
      "id": 95,
      "country": "VN",
      "code": "BLU",
      "province_name": "Bạc Liêu"
    },
    {
      "id": 27,
      "country": "VN",
      "code": "BNH",
      "province_name": "Bắc Ninh"
    },
    {
      "id": 77,
      "country": "VN",
      "code": "VTU",
      "province_name": "Bà Rịa - Vũng Tàu"
    },
    {
      "id": 83,
      "country": "VN",
      "code": "BTE",
      "province_name": "Bến Tre"
    },
    {
      "id": 52,
      "country": "VN",
      "code": "BDH",
      "province_name": "Bình Định"
    },
    {
      "id": 74,
      "country": "VN",
      "code": "BDG",
      "province_name": "Bình Dương"
    },
    {
      "id": 70,
      "country": "VN",
      "code": "BPC",
      "province_name": "Bình Phước"
    },
    {
      "id": 60,
      "country": "VN",
      "code": "BTN",
      "province_name": "Bình Thuận"
    },
    {
      "id": 96,
      "country": "VN",
      "code": "CMU",
      "province_name": "Cà Mau"
    },
    {
      "id": 92,
      "country": "VN",
      "code": "CTO",
      "province_name": "Cần Thơ"
    },
    {
      "id": 4,
      "country": "VN",
      "code": "CBG",
      "province_name": "Cao Bằng"
    },
    {
      "id": 66,
      "country": "VN",
      "code": "DLK",
      "province_name": "Đắk Lắk"
    },
    {
      "id": 67,
      "country": "VN",
      "code": "DKG",
      "province_name": "Đắk Nông"
    },
    {
      "id": 48,
      "country": "VN",
      "code": "DNG",
      "province_name": "Đà Nẵng"
    },
    {
      "id": 11,
      "country": "VN",
      "code": "DBN",
      "province_name": "Điện Biên"
    },
    {
      "id": 75,
      "country": "VN",
      "code": "DNI",
      "province_name": "Đồng Nai"
    },
    {
      "id": 87,
      "country": "VN",
      "code": "DTP",
      "province_name": "Đồng Tháp"
    },
    {
      "id": 64,
      "country": "VN",
      "code": "GLI",
      "province_name": "Gia Lai"
    },
    {
      "id": 2,
      "country": "VN",
      "code": "HGG",
      "province_name": "Hà Giang"
    },
    {
      "id": 30,
      "country": "VN",
      "code": "HDG",
      "province_name": "Hải Dương"
    },
    {
      "id": 31,
      "country": "VN",
      "code": "HPG",
      "province_name": "Hải Phòng"
    },
    {
      "id": 35,
      "country": "VN",
      "code": "HNM",
      "province_name": "Hà Nam"
    },
    {
      "id": 1,
      "country": "VN",
      "code": "HNI",
      "province_name": "Hà Nội"
    },
    {
      "id": 42,
      "country": "VN",
      "code": "HTH",
      "province_name": "Hà Tĩnh"
    },
    {
      "id": 93,
      "country": "VN",
      "code": "HUG",
      "province_name": "Hậu Giang"
    },
    {
      "id": 17,
      "country": "VN",
      "code": "HBH",
      "province_name": "Hòa Bình"
    },
    {
      "id": 33,
      "country": "VN",
      "code": "HYN",
      "province_name": "Hưng Yên"
    },
    {
      "id": 56,
      "country": "VN",
      "code": "KHA",
      "province_name": "Khánh Hòa"
    },
    {
      "id": 91,
      "country": "VN",
      "code": "KGG",
      "province_name": "Kiên Giang"
    },
    {
      "id": 62,
      "country": "VN",
      "code": "KTM",
      "province_name": "Kon Tum"
    },
    {
      "id": 12,
      "country": "VN",
      "code": "LCU",
      "province_name": "Lai Châu"
    },
    {
      "id": 68,
      "country": "VN",
      "code": "LDG",
      "province_name": "Lâm Đồng"
    },
    {
      "id": 20,
      "country": "VN",
      "code": "LSN",
      "province_name": "Lạng Sơn"
    },
    {
      "id": 10,
      "country": "VN",
      "code": "LCI",
      "province_name": "Lào Cai"
    },
    {
      "id": 80,
      "country": "VN",
      "code": "LAN",
      "province_name": "Long An"
    },
    {
      "id": 36,
      "country": "VN",
      "code": "NDH",
      "province_name": "Nam Định"
    },
    {
      "id": 40,
      "country": "VN",
      "code": "NAN",
      "province_name": "Nghệ An"
    },
    {
      "id": 37,
      "country": "VN",
      "code": "NBH",
      "province_name": "Ninh Bình"
    },
    {
      "id": 58,
      "country": "VN",
      "code": "NTN",
      "province_name": "Ninh Thuận"
    },
    {
      "id": 25,
      "country": "VN",
      "code": "PHO",
      "province_name": "Phú Thọ"
    },
    {
      "id": 54,
      "country": "VN",
      "code": "PYN",
      "province_name": "Phú Yên"
    },
    {
      "id": 44,
      "country": "VN",
      "code": "QBH",
      "province_name": "Quảng Bình"
    },
    {
      "id": 49,
      "country": "VN",
      "code": "QNM",
      "province_name": "Quảng Nam"
    },
    {
      "id": 51,
      "country": "VN",
      "code": "QNI",
      "province_name": "Quảng Ngãi"
    },
    {
      "id": 22,
      "country": "VN",
      "code": "QNH",
      "province_name": "Quảng Ninh"
    },
    {
      "id": 45,
      "country": "VN",
      "code": "QTI",
      "province_name": "Quảng Trị"
    },
    {
      "id": 94,
      "country": "VN",
      "code": "STG",
      "province_name": "Sóc Trăng"
    },
    {
      "id": 14,
      "country": "VN",
      "code": "SLA",
      "province_name": "Sơn La"
    },
    {
      "id": 72,
      "country": "VN",
      "code": "TNH",
      "province_name": "Tây Ninh"
    },
    {
      "id": 34,
      "country": "VN",
      "code": "TBH",
      "province_name": "Thái Bình"
    },
    {
      "id": 19,
      "country": "VN",
      "code": "TNN",
      "province_name": "Thái Nguyên"
    },
    {
      "id": 38,
      "country": "VN",
      "code": "THA",
      "province_name": "Thanh Hóa"
    },
    {
      "id": 46,
      "country": "VN",
      "code": "HUE",
      "province_name": "Thừa Thiên Huế"
    },
    {
      "id": 82,
      "country": "VN",
      "code": "TGG",
      "province_name": "Tiền Giang"
    },
    {
      "id": 79,
      "country": "VN",
      "code": "HCM",
      "province_name": "TP. Hồ Chí Minh"
    },
    {
      "id": 84,
      "country": "VN",
      "code": "TVH",
      "province_name": "Trà Vinh"
    },
    {
      "id": 8,
      "country": "VN",
      "code": "TQG",
      "province_name": "Tuyên Quang"
    },
    {
      "id": 86,
      "country": "VN",
      "code": "VLG",
      "province_name": "Vĩnh Long"
    },
    {
      "id": 26,
      "country": "VN",
      "code": "VPC",
      "province_name": "Vĩnh Phúc"
    },
    {
      "id": 15,
      "country": "VN",
      "code": "YBN",
      "province_name": "Yên Bái"
    }
  ],
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 63
}

Request

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

Responses

🟢200OK
application/json
Body
status_code
integer 
required
data
array [object {4}] 
required
id
integer 
required
country
string 
required
code
string 
required
province_name
string 
required
error
boolean 
required
error_code
null 
required
log_id
null 
required
messages
string 
required
total
integer 
required
Previous
List courier integrated
Next
District
Built with