5.1 获取省市区列表 - Open-Agent-Api

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Header 参数

channel

string

可选

默认值:

benlai

shopId

string

商城id

可选

默认值:

123

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://open-agent-branch.benlai.com/api/v2/area/get' \
--header 'channel: benlai' \
--header 'shopId: 123'

返回响应

🟢200成功

text/plain

Success

Body

addr_all

array[object (Benlai.Open.Models.Area.AreaModel) {4}]

省市区列表

可选

id

integer

编号

可选

name

string

名称

可选

parent_id

integer

父级编号

可选

sub_list

array[object (Benlai.Open.Models.Area.AreaModel) {4}]

此地区下属子级

可选

示例

成功示例异常示例

{
    "code": 0,
    "msg": "success",
    "value": {
        "addr_all": [
            {
                "id": 1,
                "name": "北京市",
                "parent_id": 0,
                "sub_list": [
                    {
                        "id": 2,
                        "name": "北京市",
                        "parent_id": 1,
                        "sub_list": [
                            {
                                "id": 3,
                                "name": "朝阳区",
                                "parent_id": 2,
                                "sub_list": []
                            },
                            {
                                "id": 4,
                                "name": "海淀区",
                                "parent_id": 2,
                                "sub_list": []
                            },
                            {
                                "id": 5,
                                "name": "东城区",
                                "parent_id": 2,
                                "sub_list": []
                            },
                            {
                                "id": 6,
                                "name": "西城区",
                                "parent_id": 2,
                                "sub_list": []
                            },
                            {
                                "id": 7,
                                "name": "石景山区",
                                "parent_id": 2,
                                "sub_list": []
                            }
                        ]
                    }
                ]
            }
        ]
    }
}