供应链开放平台
  1. API文档
供应链开放平台
  • API文档
    • 使用说明
    • 更新说明
    • 回调说明
    • 参考资料
    • 1 登录授权
      • 1.1 获取access_token
      • 1.2 刷新access_token
    • 2 商品
      • 2.1 商品分类
      • 2.2 商品列表
      • 2.3 商品详情
      • 2.4 商品变动事件
    • 3 订单
      • 3.1 运费计算
      • 3.2 订单确认
      • 3.3 订单创建
      • 3.4 取消订单
      • 3.5 订单收货
    • 4 售后订单
      • 4.1 创建售后订单
    • 5 用户信息
      • 5.1 商品价格变动
      • 5.2 基本信息
      • 5.3 设置回调地址
  1. API文档

使用说明

项目说明【对接前，请务必认真阅读此文档】#

此项目为我司对外接口输出开放平台，主要职责为API接口用户提供用户、商品基础信息查询，订单流程、售后等相关服务。

业务流程#

1、首先与我司商务对接，走完商务对接流程后，在API接口用户创建订单时，我司会自动扣除对应的储值金，并且系统会自动进行订单审核、商品拣货、配货、发货等操作，对应的物流单号信息会自动通知API接口用户。
2、订单创建时，会扣除对应订单金额的储值金，所以请务必保证账户有充足的储值金余额。
3、订单售后，我司有处理售后的客服团队，需要将售后的订单号告知我司客服，会根据实际情况执行售后，售后完结后，对应的金额会自动退还到储值金余额账户。

商品变动#

业务系统需同时接入以下两个接口进行商品数据变更。
1、常规商品价格、库存、上下架变动需用户主动调用我司商品变动事件接口进行业务系统数据更新。
2、API用户商品价格变动会主动回调通知，收到通知后根据回调说明进行业务系统后续流程处理。

订单主流程时序图#

订单时序图_17701913765898.png
1、首先通过API接口，获取商品基本信息，API接口用户在业务系统订单确认时，调用我司运费计算接口（1小时内未进行订单确认，会自动取消），
生成订单时，调用我司订单确认接口（5分钟内未进行订单创建，会自动取消，无法再进行订单后续流程，若业务系统同一订单包含多个供应商商品，需根据供应商做拆单处理后再调用API进行确认，供应商标识已在商品详情接口输出)，
待业务系统用户支付成功后，调用我司订单创建接口，返回成功后，数据进入我司内部订单系统，开始执行订单的审核、拣货、配货、发货等操作，发货时会有对应的订单回调通知，快递单号、快递名称、发货时间等都会回调通知给API用户。
2、用户运费计算、订单确认时，需传递我司省市区对应的code，我司code生成规则为行政区号+6个0共12位，在业务系统做好对应的映射。
3、运输方式为快递时，订单创建后会扣除对应的运费金额。
4、订单创建后且未发货需调用我司取消订单接口。
5、业务系统用户收货后需调用我司订单收货接口进行收货，若未调用，系统会在发货后10天自动执行收货。

专用术语#

储值金：用户在我司系统预充值金额，主要用于订单创建时，系统自动扣除。
预约服务：对订单进行咨询、售后等时，可在对应的企微API对接群进行交流，我司客服部门会进行跟踪和后续处理。
商品打包数：生成订单时，购买的商品数量如果不是采样量、起订量，则必须满足打包数的倍数，此属性在商品规格上面。
商品采样量：基于商品，单次可购买的商品数量。
快递起订量：基于商品规格，选择运输方式为快递时，则商品数量不得小于商品的快递起订量。
物流起订量：基于商品规格，选择运输方式为物流时，则商品数量不得小于商品的物流起订量。
市场价：即零售价、商品标签价格。
商品价格：通过API接口订单创建时，扣除储值金时商品单价。

沟通说明#

1.
API对接群，技术沟通时，请标明环境（测试、生产），请求时返回的traceId等。
2.
与客服沟通时，订单类请提供调用我司接口时返回的订单编号，商品类时请提供我司商品id，及对应的沟通内容。
3.
沟通响应时间：工作日：周一至周五 9：00~12：00 14：00~18：00 在15分钟内均可得到响应，非工作时间响应会有延迟，紧急问题可直接拨打我司电话进行沟通。
4.
测试服需我司配合联调测试时，请至少提前24小时告知，以便我司安排对应的资源。

接口对接说明#

1、企微API对接群方式获取appid、appsecret。
2、测服与正服环境，除了域名、appid、appsecret外，其余均一致，用户开发时，对接完测服后，正式上线时，只需更换一下域名、appid、appsecret即可正常切换环境。

调用环境地址#

测试环境：test.erp.yhbscm.com
正式环境：erp.yhbscm.com

请求方式#

通讯协议：https
Context-Type：application/json
请求方式：POST

接口限流#

根据appid+api对接口进行限流，在满足业务需求的情况下，应尽量减少非必要的接口调用。
接口说明限流频率
全局所有接口每分钟最多300次

公共请求参数#

公共请求参数，通过 header 传输，值、类型及对应释义：
参数名类型参数值描述
Authori-zationstringBearer xxxxxxxxxx是 获取access_token 接口获取的token，切记与前面的Bearer之间增加一个空格

公共响应参数#

参数名类型参数值描述
statusint200非200为请求失败，详见状态码描述
msgstringsuccess提示信息
dataarray/object响应详细内容
traceIdstring0b8dc7a342850b0966b58224361cb6bd返回请求唯一id，异常数据排查时，需提供此id

状态码描述#

状态码说明
200成功，非200为失败，具体参考返回信息
110006登录已过期，请重新登录
410141appid或者appsecret错误
400093商品已下架或不存在
修改于 2026-02-09 10:32:00
下一页
更新说明
Built with