Thông tin tỉnh/huyện

Api cung cấp ID tỉnh/thành phố, Quận/Huyện hỗ trợ cập nhật thông tin khách hàng và phân loại theo tỉnh thành

Trong trường hợp cần gán địa chỉ khách hàng và phân cấp Tỉnh/Huyện thì sử dụng các api dưới đây để đồng bộ danh bạ tỉnh/thành, quận/huyện về ứng dụng.

Dữ liệu tỉnh/thành phố, quận/huyện chỉ áp dụng cho các địa phương ở Việt Nam

Lấy danh sách tỉnh/thành phố

Mô phỏng dữ liệu tỉnh thành từ POSTMAN

Lấy danh sách tỉnh/thành phố

GET {{domain}}/api/v1/cities

Headers

Name	Type	Description
****	String	Thông tin xác thực chung

200: OK Thành công

Kết quả điển hình

{
    "code": "ok",
    "numFound": 63,
    "data": [
        {
            "id": "01",
            "name": "Thành phố Hà Nội",
            "type": "Thành phố Trung ương"
        },
        {
            "id": "02",
            "name": "Tỉnh Hà Giang",
            "type": "Tỉnh"
        },
        ...
        ]
 }

Cấu trúc thông tin

STT	Trường dữ liệu	Chú thích
1	code	Trạng thái yêu cầu
2	numFound	Số lượng bản ghi tìm thấy
3	data	Mảng dữ liệu chứa các đối tượng thông tin từng tỉnh thành có cấu trúc - id: ID tỉnh thành, tương ứng với city_id khi tạo mới/cập nhật khách hàng hoặc lấy chi tiết các huyện/quận của 1 tỉnh - name: Tên thành phố/Tỉnh - type: Phân loại cấp thành phố/tỉnh

400: Bad Request

Lấy danh sách quận/huyện

Chi tiết các quận/huyện theo city_id

Danh sách quận/huyện theo ID của tỉnh/thành phố

GET {{domain}}/api/v1/districts

Query Parameters

Name	Type	Description
city_id*	String	ID của tỉnh/thành phố dựa theo api Danh sách tỉnh

Headers

Name	Type	Description
***	String	Thông tin xác thực chung

200: OK Thành công

Kết quả điển hình

{
    "code": "ok",
    "numFound": 30,
    "data": [
        {
            "id": "001",
            "name": "Quận Ba Đình",
            "type": "Quận",
            "city_id": "01"
        },
        {
            "id": "002",
            "name": "Quận Hoàn Kiếm",
            "type": "Quận",
            "city_id": "01"
        },
        ....
        ]
}

Mô tả kết quả

STT	Trường thông tin	Chú thích
1	code	Trạng thái yêu cầu
2	numFound	Số lượng bản ghi tìm thấy
3	data	Mảng dữ liệu quận huyện có cấu trúc id: ID huyện/quận sẽ tương ứng với district_id khi tạo/cập nhật khách hàng và lấy thông tin khách hàng về name: Tên huyện/quận type: Kiểu quận hoặc huyện city_id: ID của thành phố

422: Unprocessable Entity Lỗi không cung cấp param city_id

{
    "code": "errors",
    "message": "Invalid city_id params"
}

Áp dụng từ 28/4/2023