API接口说明

API接口说明

VERSION: 1.0.2844.Api.Ali.20240221.Beta

业务消息相关接口

业务消息相关接口

一、消息的获取以及受理说明

2844供应链平台向接入商推送实时的业务变更消息,保持数据同步的一致性,满足接入商业务的需求,推送的数据消息由接入商将以http get的方式从消息接口获取,获取消息并处理完逻辑之后,需自行删除该消息表示确认接收到该消息,已经处理的消息下回将不再显示。

二、商品类消息

graph LR subgraph 商品类消息推送逻辑 B("发生商品信息变更业务") B-->| | BC{是否已订阅} BC-->|已订阅| C(向该接入商推送订阅商品消息) BC-->|未订阅不推送消息| B end

2.1、消息接口名称 : 添加删除商品池( http method:get)

获得消息地址:http://supply.2844go.com:2844/scm/msg/get/100

删除消息地址:http://supply.2844go.com:2844/scm/msg/del/100/{消息ID}

用户操作商品池。

推送数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
msgstring返回简要消息。
sizenumber1:表示成功;其它均为失败。
rowsList<Map<string,Object>>返回数据
├─ idnumber消息ID,需要根据该ID将消息删除,否则下次调用依然出现。(参考:删除消息地址)
├─ jsonstring消息内容(json格式的字符串,需将字符串转换json后解析)
├─├─ idnumber商品池ID
├─├─ typenumber操作类型:0,删除商品池;1,新增商品池
├─├─ timestring时间

消息数据示例
2.2、消息接口名称 : 商品池内添加删除商品(商品订阅)( http method:get)

获得消息地址:http://supply.2844go.com:2844/scm/msg/get/101

删除消息地址:http://supply.2844go.com:2844/scm/msg/del/101/{消息ID}

订阅商品/取消订阅。

推送数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
msgstring返回简要消息。
sizenumber1:表示成功;其它均为失败。
rowsList<Map<string,Object>>返回数据
├─ idnumber消息ID,需要根据该ID将消息删除,否则下次调用依然出现。(参考:删除消息地址)
├─ jsonstring消息内容(json格式的字符串,需将字符串转换json后解析)
├─├─ group_idnumber商品池(商品组合)ID
├─├─ spu_idnumber商品SPU_ID
├─├─ typenumber1:订阅;0:取消订阅;
├─├─ timestring时间

消息数据示例
2.3、消息接口名称 : 订阅商品信息变更( http method:get)

获得消息地址:http://supply.2844go.com:2844/scm/msg/get/102

删除消息地址:http://supply.2844go.com:2844/scm/msg/del/102/{消息ID}

已订阅商品信息变更通知。

推送数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
msgstring返回简要消息。
sizenumber1:表示成功;其它均为失败。
rowsList<Map<string,Object>>返回数据
├─ idnumber消息ID,需要根据该ID将消息删除,否则下次调用依然出现。(参考:删除消息地址)
├─ jsonstring消息内容(json格式的字符串,需将字符串转换json后解析)
├─├─ spu_idnumber商品SPU ID参考商品详情接口
├─├─ timestring时间

消息数据示例
2.4、消息接口名称 : 订阅商品价格变更( http method:get)

获得消息地址:http://supply.2844go.com:2844/scm/msg/get/103

删除消息地址:http://supply.2844go.com:2844/scm/msg/del/103/{消息ID}

已订阅商品价格变更。

推送数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
msgstring返回简要消息。
sizenumber1:表示成功;其它均为失败。
rowsList<Map<string,Object>>返回数据
├─ idnumber消息ID,需要根据该ID将消息删除,否则下次调用依然出现。(参考:删除消息地址)
├─ jsonstring消息内容(json格式的字符串,需将字符串转换json后解析)
├─├─ spu_idnumber商品SPU ID参考商品详情接口
├─├─ timestring时间

消息数据示例
2.5、消息接口名称 : 订阅商品上下架状态变更( http method:get)

获得消息地址:http://supply.2844go.com:2844/scm/msg/get/104

删除消息地址:http://supply.2844go.com:2844/scm/msg/del/104/{消息ID}

商品上下架状态变更。

推送数据
key类型必须备注
codenumber1:表示成功;其它均为失败。
msgstring返回简要消息。
sizenumber1:表示成功;其它均为失败。
rowsList<Map<string,Object>>返回数据
├─ idnumber消息ID,需要根据该ID将消息删除,否则下次调用依然出现。(参考:删除消息地址)
├─ jsonstring消息内容(json格式的字符串,需将字符串转换json后解析)
├─├─ spu_idnumber商品SPU ID参考商品详情接口
├─├─ timestring时间

消息数据示例
三、订单类消息
3.1、消息接口名称 : 新订单消息( http method:get)

获得消息地址:http://supply.2844go.com:2844/scm/msg/get/201

删除消息地址:http://supply.2844go.com:2844/scm/msg/del/201/{消息ID}

下单后反馈下单成功。

推送数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
msgstring返回简要消息。
sizenumber1:表示成功;其它均为失败。
rowsList<Map<string,Object>>返回数据
├─ idnumber消息ID,需要根据该ID将消息删除,否则下次调用依然出现。(参考:删除消息地址)
├─ jsonstring消息内容(json格式的字符串,需将字符串转换json后解析)
├─├─ orderIdnumber订单ID
├─├─ timestring时间

消息数据示例
3.2、消息接口名称 : 订单等待确认收货( http method:get)

获得消息地址:http://supply.2844go.com:2844/scm/msg/get/206

删除消息地址:http://supply.2844go.com:2844/scm/msg/del/206/{消息ID}

等待顾客收货。

推送数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
msgstring返回简要消息。
sizenumber1:表示成功;其它均为失败。
rowsList<Map<string,Object>>返回数据
├─ idnumber消息ID,需要根据该ID将消息删除,否则下次调用依然出现。(参考:删除消息地址)
├─ jsonstring消息内容(json格式的字符串,需将字符串转换json后解析)
├─├─ orderIdnumber订单ID
├─├─ timestring时间

消息数据示例
3.3、消息接口名称 : 订单取消( http method:get)

获得消息地址:http://supply.2844go.com:2844/scm/msg/get/203

删除消息地址:http://supply.2844go.com:2844/scm/msg/del/203/{消息ID}

取消成功。

推送数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
msgstring返回简要消息。
sizenumber1:表示成功;其它均为失败。
rowsList<Map<string,Object>>返回数据
├─ idnumber消息ID,需要根据该ID将消息删除,否则下次调用依然出现。(参考:删除消息地址)
├─ jsonstring消息内容(json格式的字符串,需将字符串转换json后解析)
├─├─ orderIdnumber订单ID
├─├─ timestring时间

消息数据示例
3.4、消息接口名称 : 订单完成( http method:get)

获得消息地址:http://supply.2844go.com:2844/scm/msg/get/200

删除消息地址:http://supply.2844go.com:2844/scm/msg/del/200/{消息ID}

已确认收货。

推送数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
msgstring返回简要消息。
sizenumber1:表示成功;其它均为失败。
rowsList<Map<string,Object>>返回数据
├─ idnumber消息ID,需要根据该ID将消息删除,否则下次调用依然出现。(参考:删除消息地址)
├─ jsonstring消息内容(json格式的字符串,需将字符串转换json后解析)
├─├─ orderIdnumber订单ID
├─├─ timestring时间

消息数据示例
四、配送消息
4.1、消息接口名称 : 配送单生成成功( http method:get)

获得消息地址:http://supply.2844go.com:2844/scm/msg/get/400

删除消息地址:http://supply.2844go.com:2844/scm/msg/del/400/{消息ID}

开始配送。

推送数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
msgstring返回简要消息。
sizenumber1:表示成功;其它均为失败。
rowsList<Map<string,Object>>返回数据
├─ idnumber消息ID,需要根据该ID将消息删除,否则下次调用依然出现。(参考:删除消息地址)
├─ jsonstring消息内容(json格式的字符串,需将字符串转换json后解析)
├─├─ orderIdnumber订单ID
├─├─ timestring时间

消息数据示例
五、售后类消息
5.1、消息接口名称 : 退款成功( http method:get)

获得消息地址:http://supply.2844go.com:2844/scm/msg/get/300

删除消息地址:http://supply.2844go.com:2844/scm/msg/del/300/{消息ID}

申请退款后反馈退款成功。

推送数据
key类型必须备注
codenumber1:表示成功;0:表示无数据;其它均为失败,失败原因参考msg描述。
msgstring返回简要消息。
sizenumber1:表示成功;其它均为失败。
rowsList<Map<string,Object>>返回数据
├─ idnumber消息ID,需要根据该ID将消息删除,否则下次调用依然出现。(参考:删除消息地址)
├─ jsonstring消息内容(json格式的字符串,需将字符串转换json后解析)
├─├─ orderIdnumber订单ID
├─├─ timestring时间

消息数据示例

立即接入