发货单列表
1. 前言:
根据此接口查询合作方在来伊份的发货单列表,可根据时间和lastid分页查询,每页最大50条,最多支持查询3天内的发货单;批量查询仅供对账使用。
2. 交互时序图:
3. 请求场景:
合作方主动同步来伊份发货单
4. 接口要求:
使用来伊份openapi加密协议进行加密请求
5. 接口标准
5.1 基本信息
描述 | 值 |
---|---|
服务名称 | cstore-route-app-api |
URL | 生产环境:https://openapi.laiyifen.com/cstore-route-app-api/deliveryList 测试环境:https://openapi.test.laiyifen.com/cstore-route-app-api/deliveryList |
认证方式 | 令牌 |
请求方式 | HTTP(GET) |
功能描述(适用场景) | 合作方主动同步来伊份发货单 |
5.2 请求头公共参数 (Header)
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
X-Co-Client | String | 是 | 客户端Id(来伊份提供) |
X-Co-Sign | String | 是 | 签名 |
X-Co-TimeStamp | String | 是 | 签名时间戳 |
5.3 入参 Parameters
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
appKey | String | 是 | appKey(来伊份提供) |
createTime | Long | 否 | 请求开始时间戳,如传入则获取该时间往前的发货单,默认当前时间,最多拉取3天内发货单 |
size | Integer | 否 | 上限50,默认10 |
orderNo | String | 否 | 指定查询单个发货单信息,最多支持90天内 |
outOrderNo | String | 否 | 三方订单号 |
lastId | String | 否 | 如传入则查询该id往前的发货单,不传则以createTime为准 |
5.4 入参示例
?createTime=2021-09-17 00:00:00&size=10&orderNo=786756567&lastId=sy2us3fo0y
5.5 返回统一参数
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
code | String | 是 | 返回请求业务代码 |
msg | String | 是 | 返回信息描述 |
data | Json | 是 | 返回参数 |
5.6 返回参数Data
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
orderNo | String | 是 | 来伊份发货单 |
outOrderNo | Long | 是 | 三方订单号 |
orderStatus | Integer | 是 | 发货单状态(1:待发货、10:已收单、99:取消发货单) |
sendWay | String | 是 | 配送方式 |
warehouseCode | String | 否 | 仓库编号 |
warehouseName | String | 否 | 仓库名称 |
receiverName | String | 是 | 收货人名称 |
receiverAddress | String | 是 | 收货人地址 |
receiverPhone | String | 是 | 收货人手机号 |
receiverLat | String | 是 | 收货人纬度 |
receiverLng | String | 是 | 收货人经度 |
skuTotalWeight | String | 否 | 商品总重,单位kg,精确至小数点后两位 |
expectedDeliveryTime | String | 否 | 期望送到时间戳 |
createTime | String | 是 | 发货单创建时间戳 |
lastId | String | 是 | 最后id,批量拉取下标 |
skuList | List<skuInfo> | 是 | 商品列表 |
skuInfo
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
outSkuCode | String | 是 | 三方商品编码 |
skuCode | String | 是 | 来伊份商品编码 |
skuName | Json | 是 | 商品名称 |
skuCount | Json | 是 | 商品数量 |
skuUnit | Json | 是 | 商品单位 |
5.7 返回示例
{
"code":"0",
"msg":"success",
"data":{
"orderNo":"OR86768782123",
"orderStatus":"1",
"sendWay":"CRD",
"warehouseCode":"C001",
"warehouseName":"仓库1",
"receiverName":"张三",
"receiverAddress":"来伊份青年大厦",
"recivierPhone":"13456789876",
"receiverLat":"11.11",
"receiverLng":"11.11",
"skuTotalWeight":2.22,
"expectedDeliveryTime":1631894400000,
"createTime":1631894400000,
"lastId":"s12jj123",
"skuList":[
{
"outSkuCode":"A1212",
"skuCode":"L91721",
"skuName":"商品1",
"skuCount":"1",
"skuUnit":"PAK"
},
{
"outSkuCode":"A1213",
"skuCode":"L91761",
"skuName":"商品2",
"skuCount":"2",
"skuUnit":"PAK"
}
]
}
}