Skip to main content

发货单状态回调

1. 前言:

合作方通过该接口同步发货单状态至来伊份,目前主要场景为创建发货单成功、已发货、已送达、发货单取消

2. 交互时序图:

3. 请求场景:

合作方请求来伊份接口回传发货单状态

4. 接口要求:

使用来伊份openapi加密协议进行加密请求

5. 接口标准

5.1 基本信息

描述
服务名称cstore-route-app-api
URL测试环境:https://openapi.laiyifen.com/cstore-route-app-api/call-back/delivery
生产环境:https://openapi.laiyifen.com/cstore-route-app-api/call-back/delivery
认证方式令牌
请求方式HTTP(POST)
功能描述(适用场景)合作方请求来伊份接口回传发货单状态

5.2 请求头公共参数 (Header)

参数名字参数类型是否必须说明
X-Co-ClientString客户端Id(来伊份提供)
X-Co-SignString签名
X-Co-TimeStampString签名时间戳

5.3 入参 Body

参数名字参数类型是否必须说明
appKeyStringappKey(来伊份提供)
orderNoString来伊份发货单号
outOrderNoString三方发货单号
orderStatusString发货单状态(10:已收单、20:开始配送、50:已送达、99:取消发货单)
deliveryNameString配送人名称
deliveryPhoneString配送人手机号
trackMsgString订单轨迹数据
timestampLong订单事件发生的实际时间戳
cancelReasonString取消原因

5.4 入参示例

{
"orderNo": "OR86768782123",
"outOrderNo": "D1213421231",
"orderStatus": "20",
"deliveryName": "张三",
"deliveryPhone": "17654673544",
"deliveryTime": 1631894400000,
"reciveTime": "",
"cancelReason": ""
}

5.5 返回统一参数

参数名字参数类型是否必须说明
codeString返回请求业务代码
msgString返回信息描述
dataJson返回参数

5.6 返回参数Data

5.7 返回示例

{
"code":"0",
"msg":"success"
}