发货单状态回调
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-Client | String | 是 | 客户端Id(来伊份提供) |
| X-Co-Sign | String | 是 | 签名 |
| X-Co-TimeStamp | String | 是 | 签名时间戳 |
5.3 入参 Body
| 参数名字 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| appKey | String | 是 | appKey(来伊份提供) |
| orderNo | String | 是 | 来伊份发货单号 |
| outOrderNo | String | 是 | 三方发货单号 |
| orderStatus | String | 是 | 发货单状态(10:已收单、20:开始配送、50:已送达、99:取消发货单) |
| deliveryName | String | 是 | 配送人名称 |
| deliveryPhone | String | 是 | 配送人手机号 |
| trackMsg | String | 是 | 订单轨迹数据 |
| timestamp | Long | 否 | 订单事件发生的实际时间戳 |
| cancelReason | String | 否 | 取消原因 |
5.4 入参示例
{
"orderNo": "OR86768782123",
"outOrderNo": "D1213421231",
"orderStatus": "20",
"deliveryName": "张三",
"deliveryPhone": "17654673544",
"deliveryTime": 1631894400000,
"reciveTime": "",
"cancelReason": ""
}
5.5 返回统一参数
| 参数名字 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| code | String | 是 | 返回请求业务代码 |
| msg | String | 是 | 返回信息描述 |
| data | Json | 是 | 返回参数 |
5.6 返回参数Data
5.7 返回示例
{
"code":"0",
"msg":"success"
}