供应链API
  1. 2 基础信息
供应链API
  • 使用说明
  • 帮助中心
  • 更新说明
  • V1
    • 1 账号信息
      • 1.1 获取 TOKEN
      • 1.2 重置 TOKEN
      • 1.3 账号基本信息
      • 1.4 设置回调地址
    • 2 基础信息
      • 2.1 省市区列表
        POST
      • 2.2 省市区详情
        POST
      • 2.3 商品分类
        POST
      • 2.4 商品品牌
        POST
      • 2.5 所有运输方式
        POST
    • 3 商品
      • 3.1 商品列表
      • 3.2 商品详情
      • 3.3 商品运输方式
      • 3.4 商品库存
      • 3.5 全部在售商品
    • 4 订单
      • 4.1 运费计算
      • 4.2 订单预览
      • 4.3 订单创建
      • 4.4 订单支付
      • 4.5 订单取消
      • 4.6 订单详情
      • 4.7 确认收货
      • 4.8 运输方式运费
    • 5 售后
      • 5.1 预约服务类型
      • 5.2 上传资源
      • 5.3 创建预约服务
      • 5.4 取消预约服务
      • 5.5 预约服务列表
      • 5.6 预约服务详情
      • 5.7 订单售后详情
    • 6 回调通知
      • 回调通知
  1. 2 基础信息

2.1 省市区列表

POST
/api/v1/region/list

功能说明#

获取省市区列表,支持按名称、id、国家行政区划代码进行搜索

应用场景#

在计算运费、订单预览、生成的时候,需要传入收货地址的信息

注意事项#

可通过基础物料下载,线下做好业务系统与我司地址信息的映射,在使用时,直接传递id即可

请求参数

Header 参数

Body 参数application/json

示例
{
    "name":"北京",
    "id": 132,
    "parentId":0,
    "level":1,
    "cityCode":110000,
    "pagination": {
        "page":1,
        "pageSize": 20
    }
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test-openapi.7dingdong.com/api/v1/region/list' \
--header 'appKey;' \
--header 'token;' \
--header 'nonce;' \
--header 'timestamp;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name":"北京",
    "id": 132,
    "parentId":0,
    "level":1,
    "cityCode":110000,
    "pagination": {
        "page":1,
        "pageSize": 20
    }
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "status": 200,
    "msg": "请求成功",
    "requestId": "2e480f32-3900-11ef-8d27-08002763b2f5",
    "content": {
        "total": 1,
        "currentPage": 1,
        "perPage": 20,
        "count": 1,
        "items": [
            {
                "id": 132,
                "parentId": 0,
                "name": "北京市",
                "level": 1,
                "cityCode": 110000
            }
        ]
    }
}
修改于 2024-07-03 12:32:34
上一页
1.4 设置回调地址
下一页
2.2 省市区详情
Built with