渠道对接严选OpenAPI接口文档说明-V2.2.2

接入指南

测试环境

  • http://openapi-test.you.163.com
  • (配置host:223.252.216.178 openapi-test.you.163.com)

线上环境

  • http://openapi.you.163.com
  • https://openapi.you.163.com

接口地址:/channel/api.json

请求方式:POST

输入参数说明

  • 参数默认采用x-www-form-urlencoded的形式编码。
  • 如果参数值是一个对象,则默认做json编码转成String。

示例如下:

key=value&key1=value1....

输出参数说明:采用json的编码格式

频率限制:单个接口一分钟的时间段内(开始时间任意)请求不能超过70次

sign(签名,签名的生成规则如下)

  • 输入参数值(除sign外)参照字母排序拼接,拼接成key=value的字符串形式
  • 首尾加上appSecret值
  • 最后对上述值取32位大写MD5值

其他说明

  • 渠道方需提供测试服务器IP,生产上线前提供生产服务器IP
  • 渠道方从严选获取测试环境appKey和appSecret,生产上线前获取生产环境的appKey和appSecret
  • 所有api接口均幂等

商品信息查询

1.商品ID查询接口(yanxuan.item.id.batch.get)

功能描述

获取渠道能售卖的所有商品(SPU)ID,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.item.id.batch.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result List<long> SPU ID

输出示例

{
  "code": 200,
  "msg": "",
  "result": [
    0
  ]
}

 

2.商品信息查询接口(yanxuan.item.batch.get)

功能描述

获取渠道能售卖商品的详细信息,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.item.batch.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
请求商品(SPU)ID列表 itemIds String 用英文逗号分隔,例如:1000884,1000885;一次最多请求30个商品

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result List<APIItemTO>的JSONArray

APIItemTO

商品信息

参数说明 参数名 类型 描述
商品(SPU)的标识 id long 10018002
商品名称 name String 草莓
严选主站默认展示的skuId primarySkuId long 已弃用,请使用skuList下的id
严选主站默认展示图片的URL primaryPicUrl String 已弃用,请使用skuList下的picUrl
列表页图片的URL listPicUrl String
商品描述 simpleDesc String 好吃不能停,买买买!
商品下的sku列表 skuList List<APISkuTO>的JSONArray
商品详情 itemDetail APIItemDetailTO
商品属性列表 attrList List<APIItemAttributeTO>的JSONArray
商品类目路径列表 categoryPathList List< List<APICategoryPathTO> >的JSONArray 类目路径指包含商品所在目录及其父目录的完整类目路径,多层List拼接就是一个完整的分类

APISkuTO

商品中Sku信息

参数说明 参数名 类型 描述
Sku的标识(skuId) id long 10019005
严选基准售价 yanxuanPrice BigDecimal 已弃用,请使用渠道售价
渠道售价 channelPrice BigDecimal 50.00
sku规格图片的URL picUrl String
sku规格文字信息 displayString String 大箱草莓
sku下的规格及规格值列表 itemSkuSpecValueList List<APIItemSkuSpecValueTO>的JSONArray
新品标记 newFlag Integer 0:不是;1:是
渠道选品对应分级信息 classification String
sku详情信息 skuDetailTO APISkuDetailTO

APIItemSkuSpecValueTO

Sku规格信息

参数说明 参数名 类型 描述
主键ID id long
规格名 skuSpec APISkuSpecTO
规格值 skuSpecValue APISkuSpecValueTO

APISkuSpecTO

Sku规格名

参数说明 参数名 类型 描述
规格ID id long
规格名字 name String
规格类型 type Integer 0-文字,1-图片
规格排序值 viewOrder Integer

APISkuSpecValueTO

Sku规格值

参数说明 参数名 类型 描述
规格值对应ID id long
所属规格对应ID skuSpecId long
规格值排序值 viewOrder Integer
规格值 value String 规格值描述
规格图片 picUrl String 规格图片URL

APISkuDetailTO

sku详情信息

参数说明 参数名 类型 描述
商品长度 length Double 商品长度cm,可能为null,表示没有该属性
商品宽度 width Double 商品宽度cm,可能为null,表示没有该属性
商品高度 height Double 商品高度cm,可能为null,表示没有该属性
商品毛重 weight Double 商品毛重kg,可能为null,表示没有该属性
商品净重 netWeight Double 商品净重kg,可能为null,表示没有该属性
保质期 shelfLife Integer 保质期天,可能为null,表示没有该属性

APIItemDetailTO

ItemDetail信息

参数说明 参数名 类型 描述
详情页html detailHtml String
商品大图1的URL picUrl1 String
商品大图2的URL picUrl2 String
商品大图3的URL picUrl3 String
商品大图4的URL picUrl4 String
原产国名称 originCountryName String
制造商列表 manuTagList List<APIItemTagTO>的JSONArray
商品配送区域配置 deliveryAreaList APIItemDeliveryAreaTO

APIItemTagTO

制造商列表

参数说明 参数名 类型 描述
标签名称 tagName String

APIItemDeliveryAreaTO

商品配送区域配置

参数说明 参数名 类型 描述
配送支持状态 supportStatus Integer 1-不支持配送,2-支持配送区域
配送地区列表 supportedDistricts List<APIItemDistrictSupportTO>的JSONArray 若全部支持则返回为null

APIItemDistrictSupportTO

配送地区列表

参数说明 参数名 类型 描述
地址类型 areaType Integer 0:国内,1:国外
国家ID countryId Long
国家名称 countryName String
省级名称 provinceName String
省级ID provinceId Long
市级名称 cityName String
市级ID cityId Long
区县名称 districtName String
区县ID districtId Long

APIItemAttributeTO

商品属性信息

参数说明 参数名 类型 描述
属性名 attrName String
属性值 attrValue String

APICategoryPathTO

Categroy信息

参数说明 参数名 类型 描述
类目ID id Long
类目名称 name String

输出示例

{
    "code":200,
    "result":[
        {   
            "id":0,
            "name":"",
            "primarySkuId":0,
            "primaryPicUrl":"",
            "listPicUrl":"",
            "simpleDesc":"",
            "itemDetail":{
                "detailHtml":"",
                "picUrl1":"",
                "picUrl2":"",
                "picUrl3":"",
                "picUrl4":"",
                "originCountryName":"",
                "manuTagList":[
                    {
                        "tagName":""
                    }
                ],
                "deliveryAreaList":{
                    "supportStatus":0,
                    "supportedDistricts":[
                        {
                            "areaType":,
                            "countryId":0,
                            "countryName":"",
                            "provinceName":"",
                            "provinceId":0,
                            "cityName":"",
                            "cityId":0,
                            "districtName":"",
                            "districtId":0
                        }
                    ]
                }
            },
            "skuList":[
                {
                    "id":0,
                    "yanxuanPrice":0,
                    "skuDetailTO":{
                        "length":0,
                        "width":0,
                        "height":0,
                        "weight":0,
                        "netWeight":0,
                        "shelfLife":0
                    },
                    "channelPrice":0,
                    "picUrl":"",
                    "displayString":"",
                    "itemSkuSpecValueList":[
                        {
                            "skuSpec":{
                                "name":""
                            },
                            "skuSpecValue":{
                                "value":"",
                                "picUrl":""
                            }
                        }
                    ],
                    "newFlag":0,
                    "classification":""
                }
            ],
            "attrList":[
                {
                    "attrName":"",
                    "attrValue":""
                }
            ],
            "categoryPathList":[
                [
                    {
                        "id":0,
                        "name":""
                    }
                ]
            ]
        }
    ]
}

 

3.商品类目信息接口(yanxuan.item.category.get)

功能描述

获取严选所有商品的类目信息,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.item.category.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result List<APICategoryTO>的JSONArray

APICategoryTO

商品类目信息

参数说明 参数名 类型 描述
类目ID id Long
类目名称 name String
下级类目信息 subCateList List<APICategoryTO>的JSONArray 为空时是最后一层

输出示例

{
  "code": 200,
  "result": [
    {
      "id": 0,
      "name": "",
      "subCateList": []
    }
}

 

4.查询特定类目下的SKUID列表接口(yanxuan.item.category.skuId.batch.get)

功能描述

获取渠道能售卖的指定类目下商品的SKUID,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.item.category.skuId.batch.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
类目ID categoryId String 根据传入的类目ID返回(可通过商品类目信息接口获取)

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result List 用英文逗号分隔,例如:1000884,1000885

输出示例

{
    "code":200,
    "result":[
        0,
    ]
}

 

5.查询SKU对应商品信息接口(yanxuan.item.sku.get)

功能描述

渠道通过skuId获取商品对应信息,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.item.sku.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
SKU ID skuId String 1146008

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result APIitemTO

APIitemTO

商品信息

参数说明 参数名 类型 描述
商品(SPU)的标识 id long 10018002
商品名称 name String 草莓
严选主站默认展示的skuId primarySkuId long 已弃用,请使用skuList下的id
严选主站默认展示图片的URL primaryPicUrl String 已弃用,请使用skuList下的picUrl
列表页图片的URL listPicUrl String
商品描述 simpleDesc String 好吃不能停,买买买!
商品下的sku列表 skuList List<APIskuTO>的JSONArray
商品详情 itemDetail APIitemDetailTO
商品属性列表 attrList List<APIitemAttributeTO>的JSONArray
商品类目路径列表 categoryPathList List< List<APIcategoryPathTO> >的JSONArray 类目路径指包含商品所在目录及其父目录的完整类目路径,多层List拼接就是一个完整的分类

APIskuTO

商品中Sku信息

参数说明 参数名 类型 描述
Sku的标识(skuId) id long 10019005
严选基准售价 yanxuanPrice BigDecimal 已弃用,请使用渠道售价
渠道售价 channelPrice BigDecimal 50.00
sku规格图片的URL picUrl String
sku规格文字信息 displayString String 大箱草莓
sku下的规格及规格值列表 itemSkuSpecValueList List<APIItemskuspecValueTO>的JSONArray
新品标记 newFlag Integer 0:不是;1:是
渠道选品对应分级信息 classification String
sku详情信息 skuDetailTO APIskuDetailTO

APIItemskuspecValueTO

Sku规格信息

参数说明 参数名 类型 描述
主键ID id long
规格名 skuSpec APIskuspecTO
规格值 skuSpecValue APIskuspecValueTO

APIskuspecTO

Sku规格名

参数说明 参数名 类型 描述
规格ID id long
规格名字 name String
规格类型 type Integer 0-文字,1-图片
规格排序值 viewOrder Integer

APIskuspecValueTO

Sku规格值

参数说明 参数名 类型 描述
规格值对应ID id long
所属规格对应ID skuSpecId long
规格值排序值 viewOrder Integer
规格值 value String 规格值描述
规格图片 picUrl String 规格图片URL

APIskuDetailTO

sku详情信息

参数说明 参数名 类型 描述
商品长度 length Double 商品长度cm,可能为null,表示没有该属性
商品宽度 width Double 商品宽度cm,可能为null,表示没有该属性
商品高度 height Double 商品高度cm,可能为null,表示没有该属性
商品毛重 weight Double 商品毛重kg,可能为null,表示没有该属性
商品净重 netWeight Double 商品净重kg,可能为null,表示没有该属性
保质期 shelfLife Integer 保质期天,可能为null,表示没有该属性

APIitemDetailTO

ItemDetail信息

参数说明 参数名 类型 描述
详情页html detailHtml String
商品大图1的URL picUrl1 String
商品大图2的URL picUrl2 String
商品大图3的URL picUrl3 String
商品大图4的URL picUrl4 String
原产国名称 originCountryName String
制造商列表 manuTagList List<APIitemTagTO>的JSONArray
商品配送区域配置 deliveryAreaList APIitemDeliveryAreaTO

APIitemTagTO

制造商列表

参数说明 参数名 类型 描述
标签名称 tagName String

APIitemDeliveryAreaTO

商品配送区域配置

参数说明 参数名 类型 描述
配送支持状态 supportStatus Integer 1-不支持配送,2-支持配送区域
配送地区列表 supportedDistricts List<APIitemDistrictSupportTO>的JSONArray 若全部支持则返回为null

APIitemDistrictSupportTO

配送地区列表

参数说明 参数名 类型 描述
地址类型 areaType Integer 0:国内,1:国外
国家ID countryId Long
国家名称 countryName String
省级名称 provinceName String
省级ID provinceId Long
市级名称 cityName String
市级ID cityId Long
区县名称 districtName String
区县ID districtId Long

APIitemAttributeTO

商品属性信息

参数说明 参数名 类型 描述
属性名 attrName String
属性值 attrValue String

APIcategoryPathTO

Categroy信息

参数说明 参数名 类型 描述
类目ID id Long
类目名称 name String

输出示例

{
    "code":200,
    "result":{
        "id":0,
        "name":"",
        "primarySkuId":0,
        "primaryPicUrl":"",
        "listPicUrl":"",
        "simpleDesc":"",
        "itemDetail":{
            "detailHtml":"",
            "picUrl1":"",
            "picUrl2":"",
            "picUrl3":"",
            "picUrl4":"",
            "originCountryName":"",
            "manuTagList":[
                {
                    "tagName":""
                }
            ],
            "deliveryAreaList":{
                "supportStatus":0,
                "supportedDistricts":[
                    {
                        "areaType":,
                        "countryId":0,
                        "countryName":"",
                        "provinceName":"",
                        "provinceId":0,
                        "cityName":"",
                        "cityId":0,
                        "districtName":"",
                        "districtId":0
                    }
                ]
            }
        },
        "skuList":[
            {
                "id":0,
                "yanxuanPrice":0,
                "skuDetailTO":{
                    "length":0,
                    "width":0,
                    "height":0,
                    "weight":0,
                    "netWeight":0,
                    "shelfLife":0
                },
                "channelPrice":0,
                "picUrl":"",
                "displayString":"",
                "itemSkuSpecValueList":[
                    {
                        "skuSpec":{
                            "name":""
                        },
                        "skuSpecValue":{
                            "value":"",
                            "picUrl":""
                        }
                    }
                ],
                "newFlag":0,
                "classification":""
            }
        ],
        "attrList":[
            {
                "attrName":"",
                "attrValue":""
            }
        ],
        "categoryPathList":[
            [
                {
                    "id":0,
                    "name":""
                }
            ]
        ]
    }
}

 

6.商品SKU库存查询接口(yanxuan.inventory.count.get)

功能描述

获取渠道能售卖的商品SKU的库存信息,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.inventory.count.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
要查询的skuId列表 skuIds String Json序列化的skuId列表。示例:"[\"10019005\",\"10038001\"]",一次最多请求100个

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result List<ChannelSkuInventoryOut>的JSONArray字符串

ChannelSkuInventoryOut

严选系统中SKU库存信息

参数说明 参数名 类型 是否必须 描述
SKU ID skuId long 1020003
库存数量 inventory long 实时的库存数量

输出示例

注意:result的Value为String

{
  "code": 200,
  "msg": "",
  "result": "[
    {
      "inventory": 0,
      "skuId": 0
    }
  ]"
}

商品交易

1.渠道下单接口(yanxuan.order.paid.create)

功能描述

用户付款后,渠道把订单信息推给严选,严选再发货给用户。相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.order.paid.create
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
订单 order JSON字符串

Order

订单

参数说明 参数名 类型 是否必须 描述 长度
订单号 orderId String 最长128位
用户下单时间 submitTime String 2016-05-23 09:00:00
用户支付时间 payTime String 2016-05-23 13:59:59
买家用户名 buyerAccount String XXX@126.com 最长255位
收件人姓名 receiverName String XXX 最大255位
收件人手机 receiverMobile String 13612345678 最大32位
收件人电话 receiverPhone String 13612345678 最大32位
收件人省名称 receiverProvinceName String 浙江省 最大32位
收件人市名称 receiverCityName String 杭州市 最大32位
收件人区名称 receiverDistrictName String 滨江区 最大32位
收件人详细地址 receiverAddressDetail String 网商路599号,网易大厦 最大512位
订单实付金额 realPrice BigDecimal 90.87 ,包含邮费,减去邮费需要大于0 最长十位 整数8位小数2位
邮费 expFee BigDecimal 10.00 最长十位 整数8位小数2位
支付方式 payMethod String 用户的支付方式 最大32位
备注 remark String 已弃用
订单SKU orderSkus List<OrderSku>的JSONArray 目前列表里最多为300个

OrderSku

订单中SKU数据

参数说明 参数名 类型 是否必须 描述 长度
SKU ID skuId String 1020003 32
商品名称 productName String 网易严选 轻透隐形包芯丝连裤袜 512
商品数量 saleCount int 1 10
商品单价 originPrice BigDecimal 9.90 整数8小数2
金额小计 subtotalAmount BigDecimal 1.90, 单价*数量-两个优惠等于小计 整数8小数2
优惠卷金额 couponTotalAmount BigDecimal 0.00 整数8小数2
活动优惠金额 activityTotalAmount BigDecimal 8.00 整数8小数2

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result OrderOut的JSON字符串

OrderOut

严选系统中订单信息

参数说明 参数名 类型 是否必须 描述
订单号 orderId String 最大128位
下单时间 submitTime String 2016-05-23 09:00:00
支付时间 payTime String 2016-05-23 13:59:59
买家用户名 buyerAccount String
收件人姓名 receiverName String XXX
收件人手机 receiverMobile String 13612345678
收件人电话 receiverPhone String 13612345678
收件人省名称 receiverProvinceName String 浙江省
收件人市名称 receiverCityName String 杭州市
收件人区名称 receiverDistrictName String 滨江区
收件人详细地址 receiverAddressDetail String 网商路599号,网易大厦
订单实付金额 realPrice BigDecimal 90.87
邮费 expFee BigDecimal 10.00
支付方式 payMethod String 用户的支付方式
订单状态 orderStatus String PAYED
订单包裹 orderPackages List<OrderPackage>的JSONArray

orderStatus

订单状态

订单状态 描述
PAYED 已付款
KF_CANCEL 客服取消
CANCELLING 取消待审核

OrderPackage

订单包裹

参数说明 参数名 类型 是否必须 描述
包裹号 packageId String 20160620123
物流公司名称 expressCompany String 绑单之后才有,多物流公司之间使用英文竖线|隔开,如顺丰|圆通,物流公司列表
运单号 expressNo String 绑单之后才有, 不同物流公司的运单号使用英文竖线|隔开,相同物流公司的运单号使用,隔开如 sf123,sf456|yt123,yt456
发货时间 expCreateTime String 绑单之后才有,2016-05-23 13:59:59
签收时间 confirmTime String 确认收货之后才有,2016-05-24 13:59:59
包裹状态 packageStatus String
订单SKU orderSkus List<OrderSku>的JSONArray
物流详细信息 expressDetailInfos List<ExpressDetailInfo>的JSONArray 绑单之后才有

packageStatus

包裹状态

包裹状态 描述
WAITING_DELIVERY 等待发货
START_DELIVERY 已发货(等待收货)
WAITING_COMMENT 已收货(等待评论)

OrderSku

订单中SKU数据

参数说明 参数名 类型 是否必须 描述 长度
SKU ID skuId String 1020003 32
商品名称 productName String 网易严选 轻透隐形包芯丝连裤袜 512
商品数量 saleCount int 1 10
商品单价 originPrice BigDecimal 9.90 整数8小数2
金额小计 subtotalAmount BigDecimal 1.90, 单价*数量-两个优惠等于小计 整数8小数2
优惠卷金额 couponTotalAmount BigDecimal 0.00 整数8小数2
活动优惠金额 activityTotalAmount BigDecimal 8.00 整数8小数2

ExpressDetailInfo

渠道订单回调的包裹详情信息

参数说明 参数名 类型 是否必须 描述
物流公司名称 expressCompany String 物流公司列表
物流单号 expressNo String
子物流单列表 subExpressNos List<String>
物流包裹包含SKU信息 skus List<Sku>的JSONArray

Sku

订单中SKU数据

参数说明 参数名 类型 是否必须 描述 长度
SKU ID skuId String 1020003 32
商品名称 productName String 网易严选 轻透隐形包芯丝连裤袜 512
商品数量 saleCount int 1 10
商品单价 originPrice BigDecimal 9.90 整数8小数2
金额小计 subtotalAmount BigDecimal 1.90, 单价*数量-两个优惠等于小计 整数8小数2
优惠卷金额 couponTotalAmount BigDecimal 0.00 整数8小数2
活动优惠金额 activityTotalAmount BigDecimal 8.00 整数8小数2

输出示例

注意:result的Value为String

{
  "code": 200,
  "msg": "",
  "result": "{
    "expFee": 0,
    "payTime": "",
    "orderId": "",
    "receiverName": "",
    "receiverMobile": "",
    "orderStatus": "",
    "invoiceAmount": 0,
    "orderPackages": [
      {
        "expCreateTime": "",
        "expressNo": "",
        "expressCompany": "",
        "packageId": "",
        "confirmTime": "",
        "orderSkus": [
          {
            "activityTotalAmount": 0,
            "saleCount": 0,
            "originPrice": 0,
            "couponTotalAmount": 0,
            "subtotalAmount": 0,
            "skuId": "",
            "productName": ""
          }
        ],
        "packageStatus": ""
      }
    ],
    "receiverAddressDetail": "",
    "submitTime": "",
    "receiverPhone": "",
    "buyerAccount": "",
    "receiverCityName": "",
    "payMethod": "",
    "receiverDistrictName": "",
    "invoiceTitle": "",
    "receiverProvinceName": "",
    "realPrice": 0
  }"
}

 

2.渠道取消订单接口(yanxuan.order.paid.cancel)

功能描述

用户(发货前)取消订单后,渠道把取消操作推给严选。相关接入说明参见here

可以取消渠道下单、渠道订单预下单和渠道订单预下单确认的未发货的订单。

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.order.paid.cancel
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
订单号 orderId String

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result OrderCancelResult的JSON字符串

OrderCancelResult

取消订单结果

参数说明 参数名 类型 是否必须 描述
取消状态 cancelStatus String 0:不允许取消,1:允许取消,2:待审核
拒绝取消原因 rejectReason String XXX

输出示例

注意:result的Value为String

{
  "code": 200,
  "msg": "",
  "result": "{
    "rejectReason": "",
    "cancelStatus": 0
  }"
}

 

3.渠道订单确认收货接口(yanxuan.order.received.confirm)

功能描述

用户确认收货后,渠道把确认收货信息推给严选。相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.order.received.confirm
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
订单号 orderId String
订单包裹号 packageId String
签收时间 confirmTime String 2016-05-23 16:32:48

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here

输出示例

{
  "code": 200,
  "msg": "",
  "result": null
}

订单信息查询

1.渠道订单信息查询接口(yanxuan.order.paid.get)

功能描述

获取严选系统中订单相关信息,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.order.paid.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
订单号 orderId String

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result OrderOut的JSON字符串

OrderOut

严选系统中订单信息

参数说明 参数名 类型 是否必须 描述
订单号 orderId String 最大128位
下单时间 submitTime String 2016-05-23 09:00:00
支付时间 payTime String 2016-05-23 13:59:59
买家用户名 buyerAccount String
收件人姓名 receiverName String XXX
收件人手机 receiverMobile String 13612345678
收件人电话 receiverPhone String 13612345678
收件人省名称 receiverProvinceName String 浙江省
收件人市名称 receiverCityName String 杭州市
收件人区名称 receiverDistrictName String 滨江区
收件人详细地址 receiverAddressDetail String 网商路599号,网易大厦
订单实付金额 realPrice BigDecimal 90.87
邮费 expFee BigDecimal 10.00
支付方式 payMethod String 用户的支付方式
订单状态 orderStatus String PAYED
订单包裹 orderPackages List<OrderPackage>的JSONArray

orderStatus

订单状态

订单状态 描述
PAYED 已付款
KF_CANCEL 客服取消
CANCELLING 取消待审核

OrderPackage

订单包裹

参数说明 参数名 类型 是否必须 描述
包裹号 packageId String 20160620123
物流公司名称 expressCompany String 绑单之后才有,多物流公司之间使用英文竖线|隔开,如顺丰|圆通,物流公司列表
运单号 expressNo String 绑单之后才有, 不同物流公司的运单号使用英文竖线|隔开,相同物流公司的运单号使用,隔开如 sf123,sf456|yt123,yt456
发货时间 expCreateTime String 绑单之后才有,2016-05-23 13:59:59
签收时间 confirmTime String 确认收货之后才有,2016-05-24 13:59:59
包裹状态 packageStatus String
订单SKU orderSkus List<OrderSku>的JSONArray
物流详细信息 expressDetailInfos List<ExpressDetailInfo>的JSONArray 绑单之后才有

packageStatus

包裹状态

包裹状态 描述
WAITING_DELIVERY 等待发货
START_DELIVERY 已发货(等待收货)
WAITING_COMMENT 已收货(等待评论)

OrderSku

订单中SKU数据

参数说明 参数名 类型 是否必须 描述 长度
SKU ID skuId String 1020003 32
商品名称 productName String 网易严选 轻透隐形包芯丝连裤袜 512
商品数量 saleCount int 1 10
商品单价 originPrice BigDecimal 9.90 整数8小数2
金额小计 subtotalAmount BigDecimal 1.90, 单价*数量-两个优惠等于小计 整数8小数2
优惠卷金额 couponTotalAmount BigDecimal 0.00 整数8小数2
活动优惠金额 activityTotalAmount BigDecimal 8.00 整数8小数2

ExpressDetailInfo

渠道订单回调的包裹详情信息

参数说明 参数名 类型 是否必须 描述
物流公司名称 expressCompany String 物流公司列表
物流单号 expressNo String
子物流单列表 subExpressNos List<String>
物流包裹包含SKU信息 skus List<Sku>的JSONArray

Sku

订单中SKU数据

参数说明 参数名 类型 是否必须 描述 长度
SKU ID skuId String 1020003 32
商品名称 productName String 网易严选 轻透隐形包芯丝连裤袜 512
商品数量 saleCount int 1 10
商品单价 originPrice BigDecimal 9.90 整数8小数2
金额小计 subtotalAmount BigDecimal 1.90, 单价*数量-两个优惠等于小计 整数8小数2
优惠卷金额 couponTotalAmount BigDecimal 0.00 整数8小数2
活动优惠金额 activityTotalAmount BigDecimal 8.00 整数8小数2

输出示例

注意:result的Value为String

{
  "code": 200,
  "msg": "",
  "result": "{
    "expFee": 0,
    "payTime": "",
    "orderId": "",
    "receiverName": "",
    "receiverMobile": "",
    "orderStatus": "",
    "invoiceAmount": 0,
    "orderPackages": [
      {
        "expCreateTime": "",
        "expressNo": "",
        "expressCompany": "",
        "packageId": "",
        "expressDetailInfos": [
          {
            "skus": [
              {
                "activityTotalAmount": 0,
                "saleCount": 0,
                "originPrice": 0,
                "couponTotalAmount": 0,
                "subtotalAmount": 0,
                "skuId": "",
                "productName": ""
              }
            ],
            "expressNo": "",
            "expressCompany": ""
          }
        ],
        "confirmTime": "",
        "orderSkus": [
          {
            "activityTotalAmount": 0,
            "saleCount": 0,
            "originPrice": 0,
            "couponTotalAmount": 0,
            "subtotalAmount": 0,
            "skuId": "",
            "productName": ""
          }
        ],
        "packageStatus": ""
      }
    ],
    "receiverAddressDetail": "",
    "submitTime": "",
    "receiverPhone": "",
    "buyerAccount": "",
    "receiverCityName": "",
    "payMethod": "",
    "receiverDistrictName": "",
    "invoiceTitle": "",
    "receiverProvinceName": "",
    "realPrice": 0
  }"
}

 

2.获取物流轨迹信息接口(yanxuan.order.express.get)

功能描述

渠道下单,严选发货后,可通过该接口获取物流轨迹信息,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.order.express.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
订单号 orderId String
包裹号 packageId String
物流单号 expressNo String
物流公司名称 expressCom String 物流公司列表

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result DeliveryInfo的JSON字符串 物流轨迹信息

DeliveryInfo

物流轨迹信息

参数说明 参数名 类型 描述
物流公司 company String
运单号 number String
轨迹信息 content List<DeliveryDetailInfo>的JSONArray

DeliveryDetailInfo

轨迹信息

参数说明 参数名 类型 描述
时间 time String
描述 desc String

输出示例

注意:result的Value为String

{
  "code": 200,
  "result": "{
    "content": [
      {
        "time": "",
        "desc": ""
      }
    ],
    "company": "",
    "number": ""
  }"
}

地址信息查询

1.国家信息查询(yanxuan.address.country.get)

功能描述

渠道通过该接口来获取国家信息,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.address.country.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result List<ACountryVO>的JSONArray code为200的结果

ACountryVO

国家信息

参数说明 参数名 类型 描述
标准国家代码 code String
标准国家电话前缀 telCode String
国家名 name String 中文名
英文名 englishName String

输出示例

{
  "code": 200,
  "result": "[{
     \"code\":\ "\",
         \"englishName\":\ "\",
         \"name\": \"\",
         \"telCode\": \"\"
       }]"
    }

 

2.省信息查询(yanxuan.address.province.get)

功能描述

渠道通过该接口来获取省信息,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.address.province.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
国家编码 countryCode String 即yanxuan.address.country.get获取到的标准国家代码

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result List<AProvinceVO>的JSONArray code为200的结果

AProvinceVO

省信息

参数说明 参数名 类型 描述
严选内部编码 code String
本地国标编码 nativeCode String
省名称 name String
国家编码 countryCode String
国家名称 countryName String

输出示例

{
  "code": 200,
  "result": "[{
    \"code\": \"\",
         \"countryCode\": \"\",
         \"countryName\": \"\",
         \"name\":\ "\",
         \"nativeCode\": \"\"
      }]"
    }

 

3.市信息查询(yanxuan.address.city.get)

功能描述

渠道通过该接口来获取市信息,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.address.city.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
省编码 provCode String 即yanxuan.address.province.get的严选内部编码

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result List<ACityVO>的JSONArray code为200的结果

ACityVO

市信息

参数说明 参数名 类型 描述
严选内部编码 code String
本地国标编码 nativeCode String
城市名 name String
国家编码 countryCode String
国家名称 countryName String
省份内部编码 provCode String
省份名称 provName String

输出示例

{
  "code": 200,
  "result": "[{
    \"code\": \"\",
         \"countryCode\":\ "\",
         \"countryName\": \"\",
         \"name\": \"\",
         \"nativeCode\": \"\",
         \"provCode\": \"\",
         \"provName\": \"\"
      }]"
    }

 

4.区县信息查询(yanxuan.address.district.get)

功能描述

渠道通过该接口来获取区县信息,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.address.district.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
市编码 cityCode String 即yanxuan.address.city.get的严选内部编码

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result List<ADistrictVO>的JSONArray code为200的结果

ADistrictVO

区县信息

参数说明 参数名 类型 描述
严选内部编码 code String
本地国标编码 nativeCode String
区县名 name String
国家编码 countryCode String
国家名称 countryName String
省份内部编码 provCode String
省份名称 provName String
城市内部编码 cityCode String
城市名称 cityName String

输出示例

{
  "code": 200,
  "result": "[{
    \"cityCode\": \"\",
       \"cityName\":\"\",
         \"code\":\"\",
         \"countryCode\":\ "\",
         \"countryName\": \"\",
         \"name\": \"\",
         \"nativeCode\": \"\",
         \"provCode\": \"\",
         \"provName\": \"\"
      }]"
    }

售后服务请求

1.渠道发起售后服务请求(yanxuan.order.refund.apply)

功能描述

发货后45天内,渠道确认收货后可发起售后服务请求,现只支持退货申请(同一sku在同一时刻只能有一个售后申请存在),相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.order.refund.apply
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
售后申请 applyInfo JSON字符串

applyInfo

售后申请请求信息

参数说明 参数名 类型 是否必须 描述
售后申请Id requestId String 最大128位
订单号 orderId String 最大128位
售后申请人 applyUser applyUser
申请售后的sku信息 applySku applySku

applyUser

售后申请人

参数说明 参数名 类型 是否必须 描述
退货联系人 name String 最大32位
退货联系人电话 mobile String 最大32位

applySku

申请售后的sku信息

参数说明 参数名 类型 是否必须 描述
sku发货时得到的包裹号 packageId String 最大64位
申请售后的skuId skuId String 最大32位
申请售后的sku数量 count int
退换货原因 applySkuReason applySkuReason
申请售后的图片信息 applyPicList List<ApplyPic>的JSONArray 单张图片最大5M,最多10张
sku单价 originalPrice BigDecimal
实付金额小计 subtotalPrice BigDecimal

applySkuReason

退换货原因

参数说明 参数名 类型 是否必须 描述
退换货原因 reason String 指定文案:无理由、质量问题,最大128位
退换货详细原因 reasonDesc String 最大512位

ApplyPic

申请售后的图片信息,严选会做转存处理,不支持链接内容的动态更新

参数说明 参数名 类型 是否必须 描述 长度
图片url url String 必须支持GET请求获取图片 最长255位
图片文件名 fileName String 必须带文件类型后缀

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result OrderRefundApplyResponse的JSON字符串 code为200的结果

OrderRefundApplyResponse

售后申请返回信息

参数说明 参数名 类型 描述
申请单Id applyId String
订单号 orderId String
申请售后的sku信息 applySkuList List<OrderRefundApplySkuResponse>的JSONArray
退货类型 returnType int 可选,不一定有该项
申请单状态 status int 可选,不一定有该项
退货物流信息 expressInfoList List<expressInfo>的JSONArray 可选,不一定有该项
客服审核不通过原因 denyReason String 可选,不一定有该项
创建时间 createTime long 单位毫秒,可选,不一定有该项
更新时间 updateTime long 单位毫秒,可选,不一定有该项

OrderRefundApplySkuResponse

申请售后的sku信息

参数说明 参数名 类型 描述
申请售后的skuId skuId String 最大32位
申请售后的sku数量 count int
退换货原因 applySkuReason applySkuReason
申请售后的图片信息 applyPicList List<ApplyPic>的JSONArray 可选,不一定有该项
sku单价 originalPrice BigDecimal
实付金额小计 subtotalPrice BigDecimal
此sku的售后信息 operateSkus List<OperateSku>的JSONArray 可选,不一定有该项
退货地址 returnStoreHouse OrderRefundApplySkuAddress 可选,不一定有该项

applySkuReason

退换货原因

参数说明 参数名 类型 是否必须 描述
退换货原因 reason String 指定文案:无理由、质量问题,最大128位
退换货详细原因 reasonDesc String 最大512位

ApplyPic

售后申请的图片信息

参数说明 参数名 类型 描述
图片url picUrl String 严选转存之后的图片url

OperateSku

此sku的售后信息

参数说明 参数名 类型 描述
skuId skuId String 最大32位
状态 status int
审核不通过原因 reason String
异常类型 exceptionType int
商品质检信息 qualityList List<OrderRefundApplySkuQuality>的JSONArray 组合装对应多个质检信息

OrderRefundApplySkuOperateStatus

sku的售后信息的状态

状态 描述
0 待审核
1 已取消
2 已拒绝
3 审核通过

OrderRefundApplySkuOperateExceptionType

sku的售后信息的异常类型

类型 描述
0 正常
1 未匹配售后单
2 匹配多个售后单
3 商品多退
4 商品少退
5 非严选商品

OrderRefundApplySkuQuality

商品质检信息

参数说明 参数名 类型 描述
skuId skuId String 最大32位
次品类型 defectiveType String
处理方式 treatmentMethod int
权责问题 responsibilityDesc String
图片 picList List<String> 可选,不一定有该项
规格 specDesc String

OrderRefundApplySkuQualityTreatmentMethod

处理方式

类型 描述
0 损毁
1 退回供应商
2 内部微瑕品销售
3 换包装
4 可直接二次销售

OrderRefundApplySkuAddress

退货地址详情信息

参数说明 参数名 类型 描述
省份名称 provinceName String
城市名称 cityName String
区域名称 districtName String
具体街道地址 address String
完整地址 fullAddress String
邮政编码 zipCode String
收件人姓名 name String
收件人手机 mobile String

returnType

退货类型

类型 描述
0 待定
1 无理由,需用户支付邮费
2 质量问题,严选支付邮费,发顺丰到付

OrderRefundApplyResponseStatus

售后申请单状态

状态 描述
1 待审核
2 待用户寄回
3 用户已寄送
4 退货成功
5 客服审核不通过
6 用户取消
7 系统取消
8 客服取消
9 待客服确认
11 客服拒绝

expressInfo

退货物流信息

参数说明 参数名 类型 描述
物流公司 trackingCompany String 最大32位,物流公司列表
物流单号 trackingNum String

输出示例

{
  "result": {
    "applySkuList": [
      {
        "applySkuReason": {
          "reason": "",
          "reasonDesc": ""
        },
        "originalPrice": 0,
        "applyPicList": [
          {
            "picUrl": ""
          }
        ],
        "count": 0,
        "returnStoreHouse": {
          "zipCode": "",
          "address": "",
          "cityName": "",
          "districtName": "",
          "fullAddress": "",
          "mobile": "",
          "name": "",
          "provinceName": ""
        },
        "operateSkus": [
          {
            "exceptionType": 0,
            "reason": "",
            "skuId": "",
            "status": 0,
            "qualityList": [
              {
                "defectiveType": "",
                "specDesc": "",
                "skuId": "",
                "treatmentMethod": 0,
                "responsibilityDesc": "",
                "picList": [
                  ""
                ]
              }
            ]
          }
        ],
        "subtotalPrice": 0,
        "skuId": ""
      }
    ],
    "applyId": "",
    "expressInfoList": [
      {}
    ],
    "createTime": 0,
    "orderId": "",
    "updateTime": 0,
    "denyReason": "",
    "returnType": 0,
    "status": 0
  },
  "code": 200
}

 

2.渠道取消售后服务请求(yanxuan.order.refund.cancel)

功能描述

取消售后服务请求,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.order.refund.cancel
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
售后申请id applyId String

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result String code为200的结果,true:取消成功,false:不允许取消

输出示例

{
  "code": 200,
  "result": "true"
}

 

3.渠道绑定售后寄回物流单号(yanxuan.order.refund.offer.express)

功能描述

渠道根据物流公司列表来绑定售后物流寄回退货商品(目前中通快运、能装能送、安得物流、百世快运、晟邦物流、京东物流和每实配送这七个物流公司接口上暂不支持售后寄回,物流公司可传“其他”),相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.order.refund.offer.express
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
售后申请id applyId String
物流信息 expressInfo List<ExpressInfo>的JSONArray

ExpressInfo

退货物流信息

参数说明 参数名 类型 描述
物流公司 trackingCompany String 最大32位,物流公司列表
物流单号 trackingNum String

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result String code为200的结果,true:更新成功,false:不允许更新

输出示例

{
  "code": 200,
  "result": "true"
}

 

4.渠道查询售后申请详情(yanxuan.order.refund.detail.get)

功能描述

查询售后申请详情,相关接入说明参见here

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.order.refund.detail.get
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
售后申请id applyId String

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result RefundApply的JSON字符串 code为200的结果

RefundApply

售后申请返回信息

参数说明 参数名 类型 描述
申请单Id applyId String
订单号 orderId String
申请售后的sku信息 applySkuList List<ApplySku>的JSONArray
退货类型 returnType int 可选,不一定有该项
申请单状态 status int 可选,不一定有该项
退货物流信息 expressInfoList List<ExpressInfo>的JSONArray 可选,不一定有该项
客服审核不通过原因 denyReason String 可选,不一定有该项
创建时间 createTime long 单位毫秒,可选,不一定有该项
更新时间 updateTime long 单位毫秒,可选,不一定有该项

ApplySku

申请售后的sku信息

参数说明 参数名 类型 描述
申请售后的skuId skuId String 最大32位
申请售后的sku数量 count int
退换货原因 applySkuReason ApplySkuReason
申请售后的图片信息 applyPicList List<ApplyPic>的JSONArray 可选,不一定有该项
sku单价 originalPrice BigDecimal
实付金额小计 subtotalPrice BigDecimal
此sku的售后信息 operateSkus List<OperateSku>的JSONArray 可选,不一定有该项
退货地址 returnStoreHouse ReturnStoreHouse 可选,不一定有该项

ApplySkuReason

退换货原因

参数说明 参数名 类型 是否必须 描述
退换货原因 reason String 指定文案:无理由、质量问题,最大128位
退换货详细原因 reasonDesc String 最大512位

ApplyPic

售后申请的图片信息

参数说明 参数名 类型 描述
图片url picUrl String 严选转存之后的图片url

OperateSku

此sku的售后信息

参数说明 参数名 类型 描述
skuId skuId String 最大32位
状态 status int
审核不通过原因 reason String
异常类型 exceptionType int
商品质检信息 qualityList List<Quality>的JSONArray 组合装对应多个质检信息

status

sku的售后信息的状态

状态 描述
0 待审核
1 已取消
2 已拒绝
3 审核通过

exceptionType

sku的售后信息的异常类型

类型 描述
0 正常
1 未匹配售后单
2 匹配多个售后单
3 商品多退
4 商品少退
5 非严选商品

Quality

商品质检信息

参数说明 参数名 类型 描述
skuId skuId String 最大32位
次品类型 defectiveType String
处理方式 treatmentMethod int
权责问题 responsibilityDesc String
图片 picList List<String> 可选,不一定有该项
规格 specDesc String

treatmentMethod

处理方式

类型 描述
0 损毁
1 退回供应商
2 内部微瑕品销售
3 换包装
4 可直接二次销售

ReturnStoreHouse

退货地址详情信息

参数说明 参数名 类型 描述
省份名称 provinceName String
城市名称 cityName String
区域名称 districtName String
具体街道地址 address String
完整地址 fullAddress String
邮政编码 zipCode String
收件人姓名 name String
收件人手机 mobile String

returnType

退货类型

类型 描述
0 待定
1 无理由,需用户支付邮费
2 质量问题,严选支付邮费,发顺丰到付

status

售后申请单状态

状态 描述
1 待审核
2 待用户寄回
3 用户已寄送
4 退货成功
5 客服审核不通过
6 用户取消
7 系统取消
8 客服取消
9 待客服确认
11 客服拒绝

ExpressInfo

退货物流信息

参数说明 参数名 类型 描述
物流公司 trackingCompany String 最大32位,物流公司列表
物流单号 trackingNum String

输出示例

{
  "result": {
    "applySkuList": [
      {
        "applySkuReason": {
          "reason": "",
          "reasonDesc": ""
        },
        "originalPrice": 0,
        "applyPicList": [
          {
            "picUrl": ""
          }
        ],
        "count": 0,
        "returnStoreHouse": {
          "zipCode": "",
          "address": "",
          "cityName": "",
          "districtName": "",
          "fullAddress": "",
          "mobile": "",
          "name": "",
          "provinceName": ""
        },
        "operateSkus": [
          {
            "exceptionType": 0,
            "reason": "",
            "skuId": "",
            "status": 0,
            "qualityList": [
              {
                "defectiveType": "",
                "specDesc": "",
                "skuId": "",
                "treatmentMethod": 0,
                "responsibilityDesc": "",
                "picList": [
                  ""
                ]
              }
            ]
          }
        ],
        "subtotalPrice": 0,
        "skuId": ""
      }
    ],
    "applyId": "",
    "expressInfoList": [
      {}
    ],
    "createTime": 0,
    "orderId": "",
    "updateTime": 0,
    "denyReason": "",
    "returnType": 0,
    "status": 0
  },
  "code": 200
}

渠道提供回调接口

回调地址:所有回调都用一个统一的回调url

请求方式:POST

输入参数说明

参数默认采用x-www-form-urlencoded的形式编码。如果参数值是一个对象,则默认做json编码转成String。

示例如下:

key=value&key1=value1....

输出参数说明

采用json的编码格式

其他说明

  • 所有回调会做必要的有限次数的重试(请求渠道非200错误重试10次,请求渠道异常重试5次,),然并不保证回调100%成功
  • 渠道返回非200错误回调间隔1分钟,返回异常回调间隔5分钟,根据重试次数累计增加时长
  • 回调接口都要保证幂等
  • 回调仅为通知渠道相应的消息,渠道成功接收到回调,应返回成功(json里的code为200)

渠道回调注册与获取

1.渠道自助注册回调(yanxuan.callback.method.register)

业务说明

渠道通过这个请求告知严选需要通知的回调方法

参数中的methods为覆盖原来所有方法

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.callback.method.register
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
需注册的回调方法名 methods String 多个方法名用英文逗号分隔,覆盖原来所有方法

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result String

输出示例

{
  "code": 200,
  "msg": "",
  "result": ""
}

 

2.获取渠道已注册的回调方法名(yanxuan.callback.method.list)

业务说明

获取渠道已注册的回调方法名,严选只会回调注册了的方法名

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.callback.method.list
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result List<String>的字符串 已注册回调的方法名数组

输出示例

{
  "code": 200,
  "msg": "",
  "result": "[
    ""
  ]"
}

 

3.渠道商品字段变更回调注册(yanxuan.callback.itemChange.register)

业务说明

渠道通过这个请求告知严选商品变动需要通知的字段,请求频率为一分钟一次
参数中的fields为覆盖原来所有code

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.callback.itemChange.register
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
商品字段 fields String 用英文逗号做分隔(item级别变更code参考item级别变更,sku级别变更code参考sku级别变更

item级别变更

item级别变更

itemChangeCode 查询接口对应的返回字段相应描述
item.categoryPathList.id 商品类目变更(List< List<APIcategorypathTO> >的JSONArray)
item.itemDetail.deliveryAreaList 商品配送限制变更(APIitemdeliveryareaTO
item.itemDetail.itemDetailPicList 商品图变更(List<[String]>(picUrl1-4任意值变更,返回四张图片组成的列表 ))
item.itemDetail.listPicUrl 商品列表图变更(String)
item.itemDetail.itemDetailHtml 商品详情图变更(String)
item.itemDetail.manuTagList 制造商信息变更(List<APIitemtagTO>的JSONArray)

APIcategorypathTO

Categroy信息

参数说明 参数名 类型 描述
类目ID id Long
类目名称 name String

APIitemdeliveryareaTO

商品配送区域配置

参数说明 参数名 类型 描述
配送支持状态 supportStatus Integer 1-不支持配送,2-支持配送区域
配送地区列表 supportedDistricts List<APIitemdistrictsupportTO>的JSONArray 若全部支持则返回为null

APIitemdistrictsupportTO

配送地区列表

参数说明 参数名 类型 描述
地址类型 areaType Integer 0:国内,1:国外
国家ID countryId Long
国家名称 countryName String
省级名称 provinceName String
省级ID provinceId Long
市级名称 cityName String
市级ID cityId Long
区县名称 districtName String
区县ID districtId Long

APIitemtagTO

制造商列表

参数说明 参数名 类型 描述
标签名称 tagName String

sku级别变更

sku级别变更

skuChangeCode 查询接口对应的返回字段 类型 描述
item.skuList.channelSkuDetail.status sku可售状态变更(status) Integer 0-代表不可售(需下架sku),1-代表可售
item.skuList.channelSkuDetail.classification sku分级变更(classification) String
item.skuList.channelSkuDetail.channelPrice 渠道价格变更(channelPrice) BigDecimal
item.skuList.skuDetail.length 商品长度变更(length) Double
item.skuList.skuDetail.width 商品宽度变更(width) Double
item.skuList.skuDetail.height 商品高度变更(height) Double
item.skuList.skuDetail.weight 商品毛重变更(weight) Double
item.skuList.skuDetail.netWeight 商品净重变更(netWeight) Double
item.skuList.skuDetail.shelfLife 商品保质期信息变更(shelfLife) Integer

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result String

输出示例

{
  "code": 200,
  "msg": "",
  "result": ""
}

 

4.获取渠道已经注册的商品变更字段信息(yanxuan.itemChange.field.list)

业务说明

获取渠道已注册的商品变更字段信息,严选只会回调注册了的商品字段信息

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.itemChange.field.list
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败,严选返回错误详细信息here
错误说明 msg String 错误说明,当code!=200时返回,严选返回错误详细信息here
子错误码 subErrCode String 子错误码,当code!=200时返回,严选返回错误详细信息here
子错误参数 subErrParam 键值对 可选,不一定有该项,子错误参数,当code!=200时返回,严选返回错误详细信息here
结果 result List<String>的字符串 已注册的商品变更字段信息

输出示例

{
  "code": 200,
  "msg": "",
  "result": "[
    ""
  ]"
}

订单回调

1.订单取消回调(yanxuan.callback.order.cancel)

业务说明

渠道方通过调用严选API(订单取消申请),将订单的取消申请告知严选。严选接收到取消请求后,会根据订单中的商品进行取消判断,有的商品可以直接返回取消结果,有的商品需要等待人工审核(审核时间一般为24小时内)。对于人工审核的订单取消申请,严选工作人员审核完成后,通过调用渠道方提供的回调接口告知取消结果。

默认通知渠道

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.callback.order.cancel
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
取消结果 orderCancelResult JSON字符串

orderCancelResult

取消订单结果

参数说明 参数名 类型 是否必须 描述
订单ID orderId String
取消状态 cancelStatus int 0:不允许取消,1:允许取消,2:待审核
拒绝取消原因 rejectReason String XXX

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

 

2.订单包裹物流绑单回调(yanxuan.notification.order.delivered)

业务说明

订单包裹出库成功,严选通过调用渠道方提供的回调接口告知订单包裹的物流绑单信息(如物流公司、物流单号等),一个包裹号只会回调一次,一次回调为可能为部分物流绑单信息。

默认通知渠道

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.notification.order.delivered
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
订单包裹信息 orderPackage JSON字符串

OrderPackage

订单包裹信息

参数说明 参数名 类型 是否必须 描述
订单号 orderId String 最大128位
包裹号 packageId long 20160620123
物流信息 expressInfos List<ExpressInfo>的JSONArray 已弃用,请使用expressDetailInfos
物流详细信息(带上sku) expressDetailInfos List<ExpressDetailInfo>的JSONArray
发货时间 expCreateTime long unix时间戳,单位毫秒

ExpressInfo

订单包裹物流信息

参数说明 参数名 类型 是否必须 描述
物流公司名称 expressCompany String 物流公司列表
运单号 expressNos List<String>

ExpressDetailInfo

渠道订单回调的包裹详情信息

参数说明 参数名 类型 是否必须 描述
物流公司名称 expressCompany String 物流公司列表
物流单号 expressNo String
子物流单列表 subExpressNos List<String>
物流包裹包含SKU信息 skus List<Sku>的JSONArray

Sku

订单中SKU数据

参数说明 参数名 类型 是否必须 描述 长度
SKU ID skuId String 1020003 32
商品名称 productName String 网易严选 轻透隐形包芯丝连裤袜 512
商品数量 saleCount int 1 10
商品单价 originPrice BigDecimal 9.90 整数8小数2
金额小计 subtotalAmount BigDecimal 1.90, 单价*数量-两个优惠等于小计 整数8小数2
优惠卷金额 couponTotalAmount BigDecimal 0.00 整数8小数2
活动优惠金额 activityTotalAmount BigDecimal 8.00 整数8小数2

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

 

3.订单异常回调(yanxuan.notification.order.exceptional)

业务说明

因为sku的库存信息或其他因素,导致订单会被严选主动取消。严选会把这个主动取消操作推送给渠道。渠道应取消订单。

严选很少会主动取消,可能的情况为:发货地址受限、渠道或用户告知客服取消

默认通知渠道

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.notification.order.exceptional
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
异常信息描述 exceptionInfo JSON字符串

exceptionInfo

订单异常信息

参数说明 参数名 类型 是否必须 描述
订单ID orderId String
异常说明 reason String
额外补充数据 extData String JSON字符串

reason

订单异常reason说明

reason 说明 描述
CANCEL 订单被严选主动取消 渠道应取消订单

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

库存回调

1.渠道SKU库存校准回调(yanxuan.notification.inventory.count.check)

业务说明

渠道需关心此回调

严选将最新库存值告诉渠道,渠道应修改库存为通知中给的库存

每隔15分钟,触发一次渠道SKU库存校准回调,并在15分钟内回调渠道所有的SKU库存

默认不通知渠道,需自助注册此回调

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.notification.inventory.count.check
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
库存校准信息 skuCheck JSON字符串

skuCheck

库存校准记录

参数说明 参数名 类型 描述
唯一标识符 id String
Sku校准记录 skuChecks List<SkuCheck>的JSONArray
操作时间 operateTime long

SkuCheck

Sku校准记录

参数说明 参数名 类型 描述
Sku Id skuId long
当前库存 count int

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

 

2.渠道SKU低库存预警通知(yanxuan.notification.sku.alarm.close)

业务说明

渠道需关心此回调

sku因为库存偏低触发的通知

建议渠道对接此通知,并在收到此通知后立即下架sku

默认不通知渠道,需自助注册此回调

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.notification.sku.alarm.close
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
停售报警信息 closeAlarmSkus List<SkuCloseAlarmVO>的JSONArray

SkuCloseAlarmVO

停售报警信息

参数说明 参数名 类型 描述
Sku Id skuId long
当前剩余库存 inventory int

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

 

3.渠道SKU再次开售通知(yanxuan.notification.sku.reopen)

业务说明

渠道需关心此回调

sku因为库存原因再次开售触发的通知,通知会告知当前库存inventory

建议渠道对接此通知,并在收到此通知后立即上架sku

默认不通知渠道,需自助注册此回调

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.notification.sku.reopen
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
再次开售信息 reopenSkus List<SkuReopenVO>的JSONArray

SkuReopenVO

再次开售信息

参数说明 参数名 类型 描述
Sku Id skuId long
当前剩余库存 inventory int

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

退货回调

1.退货地址回调(yanxuan.notification.order.refund.address)

业务说明

渠道方发起申请后,经严选审核(审核时间一般为24小时内)通过后,需要把退货物品快递给严选。同时邮费根据回调中的type来决定。type=1是无理由退货,需用户支付邮费;type=2是质量问题,由严选支付邮费,发顺丰到付。

建议渠道关注此回调,并把相关信息提示给用户。

默认不通知渠道,需注册

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.notification.order.refund.address
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
退货地址信息 refundAddress JSON字符串

refundAddress

退货地址信息

参数说明 参数名 类型 描述
申请单Id applyId String
订单Id orderId String
申请单类型 type int 1:无理由(普通退货),2:质量问题(顺丰到付)
退货地址 returnAddr ReturnAddr

ReturnAddr

退货地址详情信息

参数说明 参数名 类型 描述
省份名称 provinceName String
城市名称 cityName String
区域名称 districtName String
具体街道地址 address String
完整地址 fullAddress String
邮政编码 zipCode String
收件人姓名 name String
收件人手机 mobile String

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

 

2.严选拒绝退货回调(yanxuan.notification.order.refund.reject)

业务说明

渠道方发起申请后,经严选审核(审核时间一般为24小时内)通过后,严选拒绝退货。

建议渠道关注此回调,并把相关信息提示给用户。

默认不通知渠道,需注册

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.notification.order.refund.reject
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
拒绝信息 rejectInfo JSON字符串

rejectInfo

严选拒绝退货信息

参数说明 参数名 类型 描述
申请单Id applyId String
订单Id orderId String
拒绝原因 rejectReason String

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

 

3.退货包裹确认收货回调(yanxuan.notification.order.refund.express.confirm)

业务说明

严选在收到相关的退货包裹之后,将此包裹信息通知给渠道。

默认不通知渠道,需注册

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.notification.order.refund.express.confirm
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
退货包裹确认收货信息 expressConfirm JSON字符串

expressConfirm

退货包裹确认收货信息

参数说明 参数名 类型 描述
申请单Id applyId String 最大64位
物流公司 trackingCompany String
物流单号 trackingNum String
物流签收时间 trackingTime long 单位为毫秒

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

 

4.严选系统取消退货回调(yanxuan.notification.order.refund.system.cancel)

业务说明

严选发起退货地址回调之后,如果超过14天没有收到渠道方绑定售后寄回物流单号,会取消相关的退货申请。

建议渠道关注此回调,并同步更新退货申请单状态。

默认不通知渠道,需注册

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.notification.order.refund.system.cancel
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
严选系统取消退货信息 systemCancel JSON字符串

systemCancel

严选系统取消退货信息

参数说明 参数名 类型 描述
申请单Id applyId String 最大64位
订单Id orderId String
系统错误原因 errorMsg String

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

 

5.退款结果回调(yanxuan.notification.order.refund.result)

业务说明

严选会将最终的可退款结果通知渠道,会出现部分sku退款或者同一sku多个数量但只退其中一部分的情况。

建议渠道关注此回调,并同步给用户。

默认不通知渠道,需注册

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为yanxuan.notification.order.refund.result
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
退款结果信息 refundResult JSON字符串

refundResult

退款结果信息

参数说明 参数名 类型 描述
申请单Id applyId String 最大64位
订单Id orderId String
退款的商品信息 refundSkuList List<RefundSku>的JSONArray

RefundSku

申请售后的sku信息

参数说明 参数名 类型 描述
申请售后的skuId skuId String 最大32位
申请售后的sku数量 count int
退换货原因 applySkuReason ApplySkuReason
申请售后的图片信息 applyPicList List<ApplyPic>的JSONArray 可选,不一定有该项
sku单价 originalPrice BigDecimal
实付金额小计 subtotalPrice BigDecimal
此sku的售后信息 operateSkus List<OperateSku>的JSONArray
退货地址 returnStoreHouse RefundResultSkuAddress 可选,不一定有该项

ApplySkuReason

退换货原因

参数说明 参数名 类型 是否必须 描述
退换货原因 reason String 指定文案:无理由、质量问题,最大128位
退换货详细原因 reasonDesc String 最大512位

ApplyPic

售后申请的图片信息

参数说明 参数名 类型 描述
图片url picUrl String 严选转存之后的图片url

OperateSku

此sku的售后信息

参数说明 参数名 类型 描述
skuId skuId String 最大32位
状态 status int
审核不通过原因 reason String
异常类型 exceptionType int
商品质检信息 qualityList List<Quality>的JSONArray 组合装对应多个质检信息

status

sku的售后信息的状态

状态 描述
0 待审核
1 已取消
2 已拒绝
3 审核通过

exceptionType

sku的售后信息的异常类型

类型 描述
0 正常
1 未匹配售后单
2 匹配多个售后单
3 商品多退
4 商品少退
5 非严选商品

Quality

商品质检信息

参数说明 参数名 类型 描述
skuId skuId String 最大32位
次品类型 defectiveType String
处理方式 treatmentMethod int
权责问题 responsibilityDesc String
图片 picList List<String> 可选,不一定有该项
规格 specDesc String

treatmentMethod

处理方式

类型 描述
0 损毁
1 退回供应商
2 内部微瑕品销售
3 换包装
4 可直接二次销售

RefundResultSkuAddress

退货地址详情信息

参数说明 参数名 类型 描述
省份名称 provinceName String
城市名称 cityName String
区域名称 districtName String
具体街道地址 address String
完整地址 fullAddress String
邮政编码 zipCode String
收件人姓名 name String
收件人手机 mobile String

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

商品回调

1.商品信息变更回调(yanxuan.callback.item.change)

业务说明

严选会将商品部分关键字段信息的变更通知渠道,渠道根据需求选择注册

建议渠道关注此回调,并同步给用户

默认不通知渠道,需注册

输入

参数说明 参数名 类型 是否必须 描述
方法名 method String 值为 yanxuan.callback.item.change
渠道的AppKey appKey String 严选提供的渠道方标识
签名 sign String
请求时间戳 timestamp String 时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求
商品变更回调结果 itemChange JSON字符串

itemChange

商品变更回调结果

参数说明 参数名 类型 描述
变更标识 messageId String
变更时间戳 changeTime long 毫秒
变更内容 itemChangeDetailList List<APIItemChangeDetailTO>的JSONArray

APIItemChangeDetailTO

变更内容

参数说明 参数名 类型 描述
消息类型 type int 值为1为item变更,值为2为sku变更
变更类型 changeDetail String item变更参见APIItemChangeItemDetailTO,sku变更参见APIItemChangeSkuDetailTO

APIItemChangeItemDetailTO

ITEM变更

参数说明 参数名 类型 描述
细分类型 Itemchangecode String 参照ITEM级别变更说明
SPU ID itemId long
关联的skuId 列表 skuIdList List
数据结构 value String 参照ITEM级别变更说明

ITEM级别变更

ITEM级别变更(建议根据新值做数据更新)

itemChangeCode 查询接口对应的返回字段
item.categoryPathList.id 商品类目变更(List< List<APicategorypathTO> >的JSONArray)
item.itemDetail.deliveryAreaList 商品配送限制变更(APiitemdeliveryareaTO
item.itemDetail.itemDetailPicList 商品图变更(List<[String]>(对应商品查询返回值中的 picUrl1,picUrl2,picUrl3,picUrl4 任意值变更 返回四张图片组成的列表))
item.itemDetail.listPicUrl 商品列表图变更(String)
item.itemDetail.itemDetailHtml 商品详情图变更(String)
item.itemDetail.manuTagList 制造商信息变更(List<APiitemtagTO>的JSONArray)

APicategorypathTO

Categroy信息

参数说明 参数名 类型 描述
类目ID id Long
类目名称 name String

APiitemdeliveryareaTO

商品配送区域配置

参数说明 参数名 类型 描述
配送支持状态 supportStatus Integer 1-不支持配送,2-支持配送区域
配送地区列表 supportedDistricts List<APiitemdistrictsupportTO>的JSONArray 若全部支持则返回为null

APiitemdistrictsupportTO

配送地区列表

参数说明 参数名 类型 描述
地址类型 areaType Integer 0:国内,1:国外
国家ID countryId Long
国家名称 countryName String
省级名称 provinceName String
省级ID provinceId Long
市级名称 cityName String
市级ID cityId Long
区县名称 districtName String
区县ID districtId Long

APiitemtagTO

制造商列表

参数说明 参数名 类型 描述
标签名称 tagName String

APIItemChangeSkuDetailTO

SKU变更

参数说明 参数名 类型 描述
细分类型 SkuChangeCode String 参照skuChangeCode说明
SPU ID itemId long
对应的skuid skuId long
数据结构 value String 参照skuChangeCode说明

skuChangeCode

SKU级别变更(建议根据新值做数据更新)

skuChangeCode 查询接口对应的返回字段 类型 描述
item.skuList.channelSkuDetail.status sku可售状态变更(status) Integer 0-代表不可售(需下架sku),1-代表可售
item.skuList.channelSkuDetail.classification sku分级变更(classification) String
item.skuList.channelSkuDetail.channelPrice 渠道价格变更(channelPrice) BigDecimal
item.skuList.skuDetail.length 商品长度变更(length) Double
item.skuList.skuDetail.width 商品宽度变更(width) Double
item.skuList.skuDetail.height 商品高度变更(height) Double
item.skuList.skuDetail.weight 商品毛重变更(weight) Double
item.skuList.skuDetail.netWeight 商品净重变更(netWeight) Double
item.skuList.skuDetail.shelfLife 商品保质期信息变更(shelfLife) Integer

输出

参数说明 参数名 类型 描述
状态码 code int 状态码。200为成功,其余为失败
失败原因 msg String 错误说明

输出示例

{
  "code": 200,
  "msg": ""
}

其他说明

1.错误描述

严选返回错误详细信息,当返回失败时,返回内容里会有msg、subErrCode,可能会有subErrParam

示例

{
  "code": 10002,
  "msg": "非法的方法名:yanxuan.order.xxx",
  "subErrCode": "isv.invalid-method",
  "subErrParam": {
    "traceId": "2bb8-a8d3-451f-8b0d-067f",
    "method": "yanxuan.order.xxx"
  }
}
code subErrCode msg subErrParam下的key
10001 isv.missing-method 缺少方法名参数 traceId
10002 isv.invalid-method 非法的方法名:{method} method,traceId
10003 isv.invalid-path 非法路径:{path} path,traceId
10004 isv.forbidden-ip 无访问权限的ip:{ip} ip,traceId
10005 isv.missing-timestamp 缺少时间戳参数 traceId
10006 isv.invalid-timestamp 非法的时间戳:{timestamp} timestamp,traceId
10007 isv.missing-appKey 缺少appKey参数 traceId
10008 isv.invalid-appKey 非法的appKey:{appKey} appKey,traceId
10009 isv.cancelled-channel 渠道已停用 traceId
10010 isv.missing-sign 缺少签名参数 traceId
10011 isv.invalid-sign 非法的签名参数 traceId
10012 isv.unauthorized-method 无权调用方法:{method} method,traceId
10013 isv.extreme-high-request 方法:{method}请求过于频繁,{retryTime}秒后再试 method,retryTime,traceId
10014 isv.missing-channelId 缺少渠道id参数 traceId
10015 isv.invalid-channelId 无效的渠道id:{channelId} channelId,traceId
10016 isv.dependent-service-failed 方法:{method}的依赖服务错误,相关信息如下:{errString} method,errString,traceId
11001 isp.dependent-service-error 方法:{method}的依赖服务异常 method,traceId
11002 isp.forbidden-ip-no-config ip:{ip}不允许访问方法:{method} ip,method,traceId
11051 isp.undefined-method-config 内部服务异常 traceId
11052 isp.inner-filter-error 内部服务异常 traceId
11053 isp.missing-channel-info 内部服务异常 traceId
11054 isp.missing-api-info 内部服务异常 traceId
11055 isp.missing-service 内部服务异常 traceId
11056 isp.invalid-service 内部服务异常 traceId
11057 isp.missing-dependent-service 内部服务异常 traceId
19999 isp.system-error 系统错误 traceId
20001 isv.business-missing-param 缺少参数:{param} param,traceId
20002 isv.business-invalid-param 参数:{param}值非法 param,traceId
20003 isv.business-param-json-error 参数:{param}值执行json解析失败 param,traceId
20004 isv.business-invalid-param-detail 参数:{param}值非法 param,detail,traceId
20101 isv.order-advance-balance-insufficient 预付款余额不足,余额为:{balance}元,请及时充值 balance,traceId
20103 isv.order-sku-closed-for-sell sku:{skuId}停售 skuId,traceId
20104 isv.order-sku-unknown sku:{skuIds}未选品 skuId,traceId
20105 isv.order-param-too-long 参数:{param}值太长 param,traceId
20106 isv.order-param-time-not-make-sense 时间参数:{param}值不合理 param,traceId
20107 isv.order-param-real-price-error 订单小计金额错误 traceId
20108 isv.order-not-exist 订单:{orderId}不存在 orderId,traceId
20109 isv.delivery-address-forbidden 配送地址受限 traceId
20110 isv.package-status-incorrect 确认收货必须在包裹发货后 traceId
20114 isv.repeat-order-process 重复订单: {orderId}正在处理中 orderId,traceId
20150 isp.order-common-error 上游返回msg errCode,errSubCode,errSubCodeParam,traceId
20151 isp.order-sku-check-inventory-unknown-error 内部服务异常 traceId
20201 isv.inventory-sku-unknown sku:{skuId}未选品 skuId,traceId
20202 isv.inventory-sku-too-many sku最多{size}个 size,traceId
20203 isv.sku-insufficient-iron {skuId,skuId...}库存不足 size,traceId
20204 isv.order-sku-too-many 订单中sku最多{size}个 size,traceId
20301 isv.item-data-not-exist 查询结果为空 detail,traceId
20302 isv.item-not-exist item不存在 detail,traceId
20303 isv.item-sku-not-exist sku不存在 detail,traceId
20304 isv.item-saleCategory-not-exist 类目不存在 detail,traceId
20305 isv.item-more-than-max-query-count 超过每次最大查询个数 detail,traceId
20401 isv.order-refund-apply-pic-too-many 退货申请单图片最多{size}张 size,traceId
20402 isv.order-refund-apply-upload-failed 退货申请单图片:{url}获取失败 url,traceId
20403 isv.order-refund-order-not-exist 退货申请中的订单不存在 traceId
20404 isv.order-refund-package-not-exist 退货申请中的包裹不存在 traceId
20405 isv.order-refund-sku-not-exist 退货申请中的sku不存在 traceId
20406 isv.order-refund-sku-count-invalid 退货申请中的sku数量大于可退数量 traceId
20408 isv.order-refund-sku-applied 同一sku在同一时刻只能有一个售后申请存在 detail,traceId
20409 isv.order-refund-apply-time-expired 发货{expiredTime}天后不支持申请 traceId,expiredTime
20410 isv.order-processing 订单正在处理中,再次尝试 traceId
20451 isp.order-refund-apply-pic-restore-exception 退货申请单图片转存异常 traceId

 

2.物流公司列表

中文
EMS
顺丰
韵达
中通
百世汇通
圆通
申通
天天
全峰
宅急送
国通
德邦
速尔
能达
优速
快捷
新邦物流
晟邦物流
天地华宇
京东物流
京东快递
中通国际
中通快运
能装能送
安得物流
百世快运
每实配送
诺心物流
微特派
其他

Demo下载

严选开放平台的Demo提供了API的商品信息查询、订单查询等许多功能,使用Demo可以轻松完成API的对接。