• 开发者平台
  • >
  • 餐饮文档中心

商家自配送状态推送收费

(下行接口)第三方合作方调用此接口,推送配送状态给客如云

授权方式:门店授权

请求描述

HTTP请求方式:POST
HTTP请求头类型:Content-Type=application/json
URI:   /open/v1/delivery/status/push

请求参数

1.系统参数

详情可查看【公共说明】中的公共参数模块

2.业务参数

参数名 类型 是否必填 参数描述
bizType Long 配送业务类型:1餐饮配送,2电商配送,399其他
orderId Long 客如云配送订单ID(与外卖下单接口返回的tradeid一致)
tpOrderId String 第三方配送订单号
deliveryStatus Int 配送状态:1待处理,2已接单/待取餐,3配送中,4已送达,5已取消,100骑手已到店,仅在deliveryStatus 为1和未接单的配送取消可以不传递,其他场景必传
delivererId String 配送员Id,仅在deliveryStatus 为1和未接单的配送取消可以不传递,其他场景必传
deliverer String 配送员姓名,仅在deliveryStatus 为1和未接单的配送取消可以不传递,其他场景必传
delivererPhone String 配送员电话,仅在deliveryStatus 为1和未接单的配送取消可以不传递,其他场景必传
cancelCode String 取消原因编码,取消时须传
cancelReason String 取消原因,取消时须传
longitude String 骑手当前经度,提供高德地图数据,仅在deliveryStatus 为1和未接单的配送取消可以不传递,其他场景必传
latitude String 骑手当前维度, 提供高德地图数据,仅在deliveryStatus 为1和未接单的配送取消可以不传递,其他场景必传

取消原因

取消原因编码 取消原因
1 配送员取消
2 配送员接单超时(无人接单)
3 商户取消
4 客服取消
99 系统取消(未完成订单状态持续超过24小时)

请求示例代码

{
  "bizType": 1,
  "orderId":f14cfdb04119451998200d1a83f785da,
  "tpOrderId":"123433456345234567890456789067",
  "deliveryStatus":4

}

响应参数

参数名 类型 是否必填 参数描述
code Int 错误码;0:成功;其他详见错误码
message String 错误说明
messageUuid String 消息uuid

响应示例代码

{
    "code":0,
    "message":"成功[OK]",
    "messageUuid":"3337b6f6-9c95-4992-9fd7-dd7e1e1fc453"
}
目录