订单推送
1. 前言:
在许多场景中,可能会需要监听订单消息去做一些事情,因此提供了订单消息推送的功能,目前提供渠道code、渠道类型、订单类型、门店编号、订单金额维度的筛选条件(后期视情况新增)。
2. 交互时序图:
如果有供应商需要来伊份订单信息时,提供给来伊份需要订单满足的条件,来伊份为每一种条件的订单会设置一个编号,供应商根据协议编号匹配自己的规则。
供应商需要按照以下接口标准实现接口,否则不能推送。
返回格式请严格按照格式推送,成功时返回code=0,失败可以自定义code,后期酌情对非0返回补偿推送。
3. 请求场景:
根据各供应商的的需求推送满足条件的订单
4. 接口要求:
使用来伊份openapi加密协议进行加密请求
5. 接口标准
5.1 基本信息
描述 | 值 |
---|---|
服务名称 | supplier-app-api |
URL | |
认证方式 | 令牌 |
请求方式 | HTTP(GET) |
功能描述(适用场景) | 按照特定条件推送订单摘要信息 |
5.2 请求头公共参数 (Header)
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
X-Co-Client | String | 是 | 客户端Id(来伊份提供) |
X-Co-Sign | String | 是 | 签名 |
X-Co-TimeStamp | String | 是 | 签名时间戳 |
5.3 入参 Body
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
businessCode | String | 是 | 业务编号(服务提供) |
orderNo | String | 是 | 订单编号 |
amount | String | 是 | 订单实际金额 |
originAmount | String | 是 | 订单原始金额 |
createTime | String | 是 | 订单创建时间 |
itemNum | String | 是 | 订单商品数量 |
lyfuid | String | 是 | 第三方应用用户授权id |
5.4 入参示例
{
"amount": 123,
"businessCode": "00001",
"createTime": 1618311626824,
"itemNum": 2,
"lyfuid": "2BBFA5XXXXXXXXXXXXXXXXXX89E90",
"orderNo": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"originAmount": 126
}
5.5 返回统一参数
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
code | String | 是 | 返回请求业务代码 |
msg | String | 是 | 返回信息描述 |
data | Json | 是 | 返回参数 |
5.6 返回参数Data
5.7 返回示例
{
"code": "0",
"msg": "success"
}