配送开放接口¶
配送状态机¶

接口定义¶
1.下发配送订单流程¶
由特定合作方提供给二维火,用于二维火推送配送订单给特定合作方
传输方式:post
method="dfire.delivery.send"
传递参数为:
字段名 | 类型 | 可空(Y/N) | 字段说明 |
---|---|---|---|
entityId | String | N | 第三方配送平台商家编号 |
deliveryType | String | Y | 取货类型:1 配送员到商家门店取货配送 |
expectProcesserNo | String | Y | 期望配送员电话 |
expectReceiveTime | String | N | 期望送达时间,格式yyyy-MM-dd HH:mm:ss |
orderMemo | String | Y | 配送订单备注 |
order | Order | N | 订单信息 |
itemDetails | List<ItemDetail> | N | 商品信息 |
send | Send | N | 取货信息 |
[Order] | 订单: |
字段名 | 类型 | 可空(Y/N) | 字段说明 |
---|---|---|---|
orderNo | String | N | 商家订单号 |
serialOrderNo | String | N | 商家订单流水号 |
resendNo | Integer | N | 重配送次数 |
orderAmount | Integer | N | 订单金额,单位分 |
payStatus | boolean | N | 是否需要代收款: T----需要 F----不需要 |
agencyFund | Integer | N | 代收款金额,单位分 |
rewardFee | Integer | Y | 奖励金额,单位分 ,默认为0 |
currency | String | N | 币种,如CNY |
totalWeight | Long | Y | 总重量,单位千克,默认值0 |
totalQty | Integer | N | 总件数 |
[ItemDetail] | 商品信息: |
字段名 | 类型 | 可空(Y/N) | 字段说明 |
---|---|---|---|
itemName | String | N | 商品名称 |
itemQty | Integer | N | 商品数量 |
itemPrice | Integer | Y | 价格,单位分 |
currency | String | N | 币种,默认为CNY |
itemWeight | double | Y | 商品重量,单位克,默认值0 |
itemModel | String | Y | 规格,默认值为空 |
itemMemo | String | Y | 商品备注,默认值为空 |
[Send] | 取货信息: |
字段名 | 类型 | 可空(Y/N) | 字段说明 |
---|---|---|---|
storeName | String | N | 取货店铺名称 |
storeCode | String | N | 取货店铺编码 |
addressProvince | String | Y | 取货地址所在省(如:广东省) |
addressCity | String | N | 取货地址所在市(如:杭州市) |
addressDistrict | String | Y | 取货地址所在区(县)(如:拱墅区) |
address | String | N | 取货地址 |
lon | Integer | Y | 取货高德 经度,默认值为空 ,高德经度乘以100万 |
lat | Integer | Y | 取货高德 纬度,默认值为空 ,高德纬度乘以100万 |
mobile | String | N | 取货电话 |
第三方配送平台返回数据格式:
字段名 | 类型 | 可空(Y/N) | 字段说明 |
---|---|---|---|
success | boolean | Y | 是否成功 |
resultCode | String | N | 异常状态码。“000”代表成功 |
message | String | Y | 如果下单失败,则会放失败原因描述 |
model | String | N | 第三方配送系统配送运单号 |

2.接收第三方配送平台推送过来的配送订单状态¶
由二维火提供给特定合作方,用于特定合作商推送配送状态和配送异常状态给二维火
传输方式:post
method="dfire.delivery.status.push"
字段名 | 类型 | 可空(Y/N) | 字段说明 |
---|---|---|---|
orderNo | String | N | 商家订单号 |
resendNo | Integer | Y | 订单重发序号,默认0 |
entityId | String | N | 第三方配送系统的商家编号 |
tOrderNo | String | Y | 第三方配送系统配送运单号 |
tOrderState | Integer | N |
|
tOrderStateDesc | String | N | 第三方配送系统状态码描述 |
deliveryEmpName | String | N | 操作人姓名 |
deliveryPhone | String | N | 操作人电话 |
operateTime | String | N | 操作时间,格式yyyy-MM-dd HH:mm:ss |
exceptionReason | String | Y | 异常原因说明 |
lon | int | Y | 高德经度乘以100万 |
lat | int | Y | 高德纬度乘以100万 |
开放平台返回数据格式:
字段名 | 类型 | 可空(Y/N) | 字段说明 |
---|---|---|---|
success | boolean | N | 是否成功 |
resultCode | String | N | 异常状态码,正常为"000" |
message | String | Y | 异常状态码 |
model | String | Y |
流程图

3.商家取消本店外卖配送订单¶
由特定合作方提供给二维火,用于商家取消本店外卖配送订单的时候二维火通知特定合作方。 已经发出配送订单,同时没有取货时,可以取消配送订单:
传输方式:post
method="dfire.delivery.cancel"
字段名 | 类型 | 可空(Y/N) | 字段说明 |
---|---|---|---|
tDeliveryNo | String | Y | 第三方配送订单号。 |
orderNo | String | N | 商家订单号 |
resendNo | int | N | 订单重发序号,默认0 |
serialOrderNo | String | Y | 商家订单流水号。 |
entityId | String | N | 第三方配送平台商家编号 |
三方外卖平台返回数据格式:
字段名 | 类型 | 可空(Y/N) | 字段说明 |
---|---|---|---|
success | boolean | N | 是否成功 |
resultCode | String | N | 异常状态码,正常为"000" |
message | String | Y | 异常状态码 |
model | String | Y |
流程图
