有品开放接口 V2 升级指南
v1版本接口已不再维护,服务将于近期下线。请尽快切换
如果您的项目中使用了 openapi 的 v1.x 版本,在升级到 v2.x 时会需要对代码进行一些额外的修改。本指南列出了v2.x 在集成步骤上与v1.x的不同之处,以供参考。
如何确认ERP为V1
有品openapi接口 请求地址中用/openapi/shop 是v1,用 /mtop/aftersale/ 是v2
如果贵司使用的是自研ERP,请联系贵司技术进行开发。如果是三方ERP,请联系ERP供应商升级。
加密解密传参
对比v1版, 参数传递和加密方式有所变化,具体见 公共参数
加密前的data内容类型变更为
json
格式, 请求参数变更为[{}]
格式, 即json
对象外需额外封装为数组格式:[{ 'partnerId': 73, 'data': 't+wdKxUufMJszArkvYqVf2rdbiQOlKgNDcDWt+z2/Zm3R9xIXQcyx2HaNyUx5JtXdwF4XHFihJpGU6sdpQq76C0+BcrAbRs896ZYHtCcUgaaTY7i75Gu/ux04tXIsWsJg3K6fg81FfhUx3bAtPoS0Q==', 'timestamp': 1581590040, 'sign': 'fa99a2c39e804b83c0ca90fa41b61555' }]
返回值, v1 版中不统一, V2所有返回均为如下格式:
{ "code": 0, "message": "ok", "data": null }
其中 code =
0
为成功, message 成功时恒为ok
, 出错时 code 为非0
, 该错误码如果需要依赖, 需跟对接同学进行约定, message 会存储错误提示信息.存在错误时比如订单信息不存在:
{ "code": 400080001, "message": "order not found" }
请求 HTTP Header 统一为
Content-Type: application/json
部分代码示例已经支持v2,参见 附件下载
新增包裹发货模式
与 v1版本使用的商品(pid)为最小发货维度不同,包裹发货模式 是以 包裹(快递单号)为最小发货单位。要求商家在发货完成回传包裹信息时,必须加入包裹内物信息(即skuId、sku数量等信息)。接口会对发货包裹内物和量信息做严格的校验。包裹发货模式包含详细的内物信息,发货组合更加灵活 。同时v2不再对v1 使用的商品(pid)发货模式进行支持。
具体请见 单次发货 常见问题
订单推送切换
v1与v2不支持同时开通,请同步执行切换
跨境业务
v2已支持跨境业务涉及报关、清关等接口。请同步执行切换,流程见 跨境业务接入文档
其中v1版中的 "同步包裹运单号" 接口已经整合到 v2版的 单次发货 接口中。
密钥通用
有品openapi v1 密钥与 v2 通用,即v1密钥不需要重新申请,即可在v2接口中使用。具体见 公共参数
技术支持
邮件:
切换对接问题请邮件 youpin-openapi@xiaomi.com
邮件主题: 有品开放接口v2切换技术支持
邮件内容包含:
- 有品商家id,使用 商家主账号 登录 有品商家工作台 查看
- 商家公司名称
- 具体问题描述
微信群(二维码如失效,请邮件沟通):