配送开放平台接口文档

Delivery Open Platform API Documentation · 版本 v1.0

1. 请求协议说明

合作方调用配送开放平台 API，需按照以下步骤：

组装参数 → 生成签名 → 拼装 HTTP 请求 → 发起 HTTP 请求 → 得到 HTTP 响应 → 解析 JSON

2. 公共入参与签名算法

公共入参

签名生成步骤

1. 将所有公共参数按字典序排序，排除空值和 sign 字段
2. 拼接为 参数1值1参数2值2... 格式（UTF-8 编码）
3. 在拼接串前加上 AppSecret，得到待加密字符串
4. 对待加密字符串进行 MD5 散列（32位大写），赋值给 sign
5. 若存在 data 参数且不为空，其值以 JSON 字符串格式参与拼接（内部无需排序）

签名示例

// 原始参数（按字典序排列后拼接）
appId = xyh3fesgxb45hn
data = {"orderNo":"XY05612026858924221"}
sourceId = S5251541532
timestamp = 1685952266956

示例1:data 不为空
// 拼接串（AppSecret + 参数键值对）
String raw = "dfwsx8wf46wjym"      // AppSecret
           + "appIdxyh3fesgxb45hn"     // appId
           + "data{\"orderNo\":\"XY05612026858924221\"}" // data
           + "sourceIdS5251541532"     // sourceId
           + "timestamp1685952266956"; // timestamp
		   
示例2:data 为空
// 拼接串（AppSecret + 参数键值对）
String raw = "dfwsx8wf46wjym"      // AppSecret
           + "appIdxyh3fesgxb45hn"     // appId
           + "sourceIdS5251541532"     // sourceId
           + "timestamp1685952266956"; // timestamp
// 生成签名
String sign = MD5(raw).toUpperCase();
// 结果示例1: "ACD2BAB4E2E7BF49118922B0E853ED74" (32位大写)
// 结果示例2: "02840D6E2DF711A4D752D90DED074C64" (32位大写)

3. 返回值规则

4. 询价接口

用于获取各配送商的预估配送费和距离信息，配合「下单」接口使用。

data 业务参数

返回字段说明

成功响应

{
    "code": 200,
    "msg": "成功",
    "succeed": true,
    "data": { 
		"orderNo": "XY022705832278396038",
		"deliveryList": [
			{
				"deliveryCode": "1",
				"deliveryName": "顺丰同城",
				"price": 420,
				"distance": 1200
			},
			{
				"deliveryCode": "2",
				"deliveryName": "蜂鸟跑腿",
				"price": 610,
				"distance": 1200
			}
		]
	}
}

5. 下单接口

data 业务参数

6. 小费接口

data 业务参数

7. 取消接口

data 业务参数

返回字段说明

8. 配送详情接口

查询订单完整配送状态信息，包括骑手信息、时间节点、费用明细等。

data 业务参数

返回字段说明

9. 骑士位置接口

data 业务参数

返回字段说明

10. 余额查询接口

返回字段说明

11. 回调通知接口

回调 data 核心字段

1. 状态码

2 渠道枚举