查询订单信息
1. 前言:
2. 交互时序图:
3. 请求场景:
按照特定条件查询订单摘要信息
4. 接口要求:
使用来伊份openapi加密协议进行加密请求
5. 接口标准
5.1 基本信息
| 描述 | 值 |
|---|---|
| 服务名称 | supplier-app-api |
| URL | 测试环境:https://openapi.test.laiyifen.com/supplier-app-api/v1/supplier/orders 生产环境:https://openapi.laiyifen.com/supplier-app-api/v1/supplier/orders |
| 认证方式 | 令牌 |
| 请求方式 | HTTP(GET) |
| 功能描述(适用场景) | 供应商根据lyfuid获取用户信息 |
5.2 请求头公共参数 (Header)
| 参数名字 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| X-Co-Client | String | 是 | 客户端Id(来伊份提供) |
| X-Co-Sign | String | 是 | 签名 |
| X-Co-TimeStamp | String | 是 | 签名时间戳 |
5.3 入参 Parameters
| 参数名字 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| lyfuid | String | 是 | 第三方应用用户授权id |
| businessCode | String | 是 | 业务编号(服务提供) |
| createTimeStart | Long | 是 | 查询开始时间戳(毫秒) |
| createTimeEnd | Long | 是 | 查询结束时间戳(毫秒) |
5.4 入参示例
?businessCode=100A&lyfuid=302179DCC2F12D929080F6CBD9610F5C&createTimeStart=1616210409000&createTimeEnd=1617074409242
5.5 返回统一参数
| 参数名字 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| code | String | 是 | 返回请求业务代码 |
| msg | String | 是 | 返回信息描述 |
| data | Boolean | 是 | 是否设置过 true:设置过 false:未设置过 |
5.6 返回参数Data
| 参数名字 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| orderNo | String | 是 | 订单编号 |
| createTime | String | 是 | 创建时间 |
| itemNum | Integer | 是 | 商品数量 |
| amount | number | 是 | 订单实际金额 |
| originAmount | number | 是 | 订单原始金额 |
5.7 返回示例
{
"code":"0",
"data":[
{
"amount":0,
"createTime":"",
"itemNum":0,
"orderNo":"",
"originAmount":0
}
],
"msg":"success"
}