数字化供应链 接口文档
    数字化供应链 接口文档
    • 公共消息
    • 消息说明
    • 商品
      • 获取商品详情v2
        GET
      • 批量获取详情v2
        POST
      • 获取全量分类v2
        GET
      • 获取逐级类目v2
        GET
      • 批量更新商品v2
        POST
    • 选品
      • 选品分组列表v2
        GET
      • 在线选品v2(新版)
        POST
      • 选品分组商品列表v2
        POST
      • 选品库增加商品v2
        GET
      • 选品库商品列表v2
        GET
      • 选品库移除商品v2
        GET
    • 订单
      • 可售检测V2
        GET
      • 前置校验V2
        POST
      • 提交下单V2
        POST
      • 全平台订单列表V2
        GET
      • 各平台订单列表V2
        GET
    • 物流
      • 确认收货
        POST
      • 物流查询v2
        GET
      • 获取物流公司列表V2
        GET
    • 售后
      • 售后前置校验V2
        POST
      • 上传售后凭证(图片)V2
        POST
      • 申请售后V2
        POST
      • 售后列表V2
        GET
      • 售后详情V2
        GET
      • 退货商家邮寄信息
        PATCH
    • 消息
      • 店铺订单取消
      • 商品下架
      • 交易成功
      • 售后同意
      • 商品上架
      • 商品已收货
      • 售后拒绝
      • 商品修改
      • 商家已发货
      • 售后退款到账
      • 商品价格变更
      • 商品库添加
      • 移除商品库商品

    公共消息

    下载.jpg

    消息#

    商品上下架、商品信息变更、订单发货等消息请查看消息文档,只有调取加入我的选品库商品的接口才会发送消息通知
    商品上下架、商品信息变更、订单发货等消息请查看消息文档,只有调取加入我的选品库商品的接口才会发送消息通知

    常见注意问题#

    1、只有调取加入我的选品库商品的接口才会发送消息通知
    2、可售检测场景现在是在进入详情页的时候可以判断该商品哪些规格下架、不可售、区域无库存。
    3、前置校验是在客户商城下单前调去来做下单前的最后校验用
    4、提交下单就是客户在你们商城成交订单后调去我们的下单的接口
    5、京东图片尺寸、水印规则、京东多规格图片描述展示问题在获取商品详情接口有说明

    新版签名规则(目前新版签名规则仅支持V2版本的接口)#

    1.http请求时header发送如下参数#

    Api-App-Key:          123456
    Api-Nonce:            d1bb70baa31f1df69628c00632b65eab
    Api-Sign:             DEFC5D64939480F466FC195ADC57513E
    Api-Time-Stamp:       1573035686519

    说明#

    Api-App-Key:应用唯一key
    Api-Nonce:每次请求的唯一编号
    Api-Time-Stamp:发送请求时的毫秒时间戳
    Api-Sign:计算出来的签名,每次计算出来的签名有效期为1分钟

    2.签名计算规则#

    1.将Query参数(url参数,如果没有则省略)、上述规定必须的Header参数(除了Api-Sign),按照key-value形式组合在一起
    例:
    {
        Api-App-Key:             123456
        Api-Time-Stamp:          1573035686519
        Api-Nonce:               d1bb70baa31f1df69628c00632b65eab
    }
    2.以key做升序排序
    例:
    {
        Api-App-Key:            123456
        Api-Nonce:              d1bb70baa31f1df69628c00632b65eab
        Api-Time-Stamp:         1573035686519
    }
    3.将key和value按照顺序直接拼接到一起
    例:
    Api-App-Key123456Api-Nonced1bb70baa31f1df69628c00632b65eabApi-Time-Stamp1573035686519
    如有query参数
    例:
    Api-App-Key123456Api-Nonced1bb70baa31f1df69628c00632b65eabApi-Time-Stamp1573035686519limit10page1search_words牙线source2
    4.在上一步的结果后直接拼secretKey
    例:
    Api-App-Key123456Api-Nonced1bb70baa31f1df69628c00632b65eabApi-Time-Stamp1573035686519WywhCb6iYyshGBO0caWn3GLSeKloOnsn
    5.在上一步结果后直接拼接,经过去除空白字符(\s)的HTTP Body原始字符串
    例:
    Api-App-Key123456Api-Nonced1bb70baa31f1df69628c00632b65eabApi-Time-Stamp1573035686519WywhCb6iYyshGBO0caWn3GLSeKloOnsn{"orderSn":"2019sdfsdfsdfsdfs","spu":[{"sku":1485,"number":2},{"sku":1529,"number":3},{"sku":124221,"number":4}],"address":{"consignee":"谢订","phone":"18914449343","province":"北京市","city":"北京市","area":"丰台区","street":"卢沟桥街道","description":"马官营家园1号楼1单元"}}
    6.对上一步结果进行sha1加密,得到16进制字符串
    例:
    20e3ae128424d0cf8825ef6e4e2bdb62c6b66992
    7.对上一步结果进行md5加密,得到16进制字符串
    例:
    0337d2b8752231b729927a36f98c6849
    8.将上一步结果转为大写
    例:
    0337D2B8752231B729927A36F98C6849

    3.请求地址#

    请求地址:
    host + 接口路径
    例:访问商品列表接口
    http://api.xxx.com/v2/Goods/Lists?page=1&limit=10&source=0&search\_words=牙线




    4.订单接口使用场景#

    可售检测场景现在是在进入详情页的时候可以判断该商品哪些规格下架、不可售、区域无库存。
    前置校验是在客户商城下单前调去来做下单前的最后校验用



    提交下单就是客户在你们商城成交订单后调去我们的下单的接口
    失败补单是指可能商户账户余额不足或特殊原因导致未能在供应链下单,可以通过这个接口进行重新下单
    失败退单是指商户未在供应链下单成功,可以通过此接口进行退款

    返回值统一声明#

    返回结果为JSON格式,该文档主要对一些公共参数做简要说明,公共参数在具体的API文档中后续将不再进行复述,在每个接口的API文档中,将仅针对data字段做详细说明。

    字段说明#

    全部字段说明#

    字段必须类型说明
    id是stringrequestId,每次请求唯一,当需要技术支持时,务必提供该id,以便协助排查问题
    code是int接口请求状态码,具体参加下方,code字段说明
    msg是string接口请求状态文字描述
    data否array、object、null接口请求返回的数据

    code字段说明#

    code含义说明
    1成功接口请求成功
    0系统异常提示“访问异常,稍后再试”、“网络异常、稍后再试”等,并记录下日志,方便后续技术联合调试
    404接口不存在
    3000参数错误阅读api接口文档,检测参数
    3001余额不足充值
    3002当前应用未发布上线,仅支持下单测试!申请上线
    10000后端A组服务器异常同0
    10002常规错误可以直接展示给终端用户
    20000后端B组服务器异常同0
    99999签名错误阅读wiki签名算法

    例子#

    成功#

    {

    "id":"-Lx-DvaSJn9Xc-Zh2LSV",
    "code":1,
    "msg":"接口请求成功",
    "data": {
    "list": [
    {
    "id":10,
    "source":6,
    "orderSn":"ME20191126220022744654",
    "sku":433522,
    "num":100,
    "goodsFee":5990,
    "logisticFee":600,
    "serviceTypeCode":"refund",
    "pickTypeCode":"xxx",
    "reasonsTypeCode":"20006",
    "reasonsDescription":"不合适 ",
    "userInfo": {},
    "status":-1,
    "createdTime":1575885192
    },
    {
    "id":11,
    "source":6,
    "orderSn":"ME20191126220022744654",
    "sku":433522,
    "num":100,
    "goodsFee":3880,
    "logisticFee":600,
    "serviceTypeCode":"refund",
    "pickTypeCode":"xxx",
    "reasonsTypeCode":"20006",
    "reasonsDescription":"不合适 ",
    "userInfo": {},
    "status":-1,
    "createdTime":1575885248
    }
    ],
    "count":5
    }
    }



    失败#

    {

    "id":"-Lx-Gjs0X4VnniZiBIZr",
    "code":3000,
    "msg":"参数错误:订单不存在"
    }



    下一页
    消息说明
    Built with