1. api文档(20160711)

2. 创建售后服务(aftersales.apply)

2.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid int required numeric
oid int required numeric
reason string required
description string max:300
evidence_pic string
aftersales_type int

*返回内容示例



3. 获取单个售后详情(aftersales.get)

3.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
aftersales_bn int required numeric
shop_id int int
user_id int int
fields field_list required

*返回内容示例



4. 获取单个售后详情(根据子订单号)(aftersales.get.bn)

4.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
oid int required numeric 申请售后的订单号
fields field_list required 获取单条售后需要返回的字段

*返回内容示例



5. 获取售后列表(aftersales.list.get)

5.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id string 会员ID,user_id和shop_id必填一个
shop_id int int 店铺ID,user_id和shop_id必填一个
tid string 订单编号
title string 商品名称
created_time json_encode 申请时间范围
aftersales_bn int numeric 退换货编号
aftersales_type string 退换货类型
progress string 退换货处理进度
page_no int int 分页当前页数,默认为1
page_size int int 每页数据条数,默认10条
orderBy string 排序,默认modified_time desc
fields field_list required 获取单条售后需要返回的字段

*返回内容示例



6. 根据子订单编号,验证该子订单号是否可以申请售后服务(未验证订单状态)(aftersales.verify)

6.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
oid string required 需要验证的子订单号

*返回内容示例



7. 商家审核售后服务(aftersales.check)

7.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
aftersales_bn string required 申请售后的编号
shop_id string required 售后单所属店铺的店铺id
check_result string required 审核结果,同意或不同意,(true,false)
shop_explanation string max:300 商家审核处理说明
total_price money 退款金额
refunds_reason string max:300 退款申请原因 退款申请原因必须小于300字

*返回内容示例



8. 更新售后状态(aftersales.status.update)

8.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
aftersales_bn string required 申请售后的订单编号
shop_id string required 售后单所属店铺ID
status string required 售后状态
memo string 备注,如果售后为换货类型卖家重新发货信息必填在备注中

*返回内容示例



9. 消费者回寄退货物流信息(aftersales.send.back)

9.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
aftersales_bn string required 申请售后的订单编号
user_id string 售后单所属店用户id
corp_code int required 物流公司代码
logi_name string 物流公司名称
logi_no string required 物流单号
receiver_address string 换货发货地址
mobile string 手机号

*返回内容示例



10. 消费者申请换货,商家确认收到回寄商品,进行重新进行发货(aftersales.send.confirm)

10.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
aftersales_bn string required 申请售后的订单编号
shop_id string 售后单所有书店铺的店铺id
corp_code int 物流公司代码
logi_name string 物流公司名称
logi_no string 物流单号

*返回内容示例



11. 创建退款申请单(OMS发起)(aftersales.refundapply.shop.add)

11.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
refund_bn string required 退款申请单编号,如果未填写则自动生成
aftersales_bn string 售后申请单(退款关联的售后申请单编号)
shop_id string required 店铺ID
tid string required 订单号
reason json 申请退款理由
total_price string required 申请退款的金额,取消订单不需要填写退款金额

*返回内容示例



12. 创建退款申请单(aftersales.refundapply.create)

12.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id string required
aftersales_bn string
tid string required
oid string
refunds_type string required
reason json required
total_price string
status string required
refund_bn string
return_freight bool string

*返回内容示例



13. 获取退款申请单列表(aftersales.refundapply.list.get)

13.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
fields field_list required 获取退款申请单需要返回的字段
shop_id int 店铺ID
oid string 子订单号集合
tid string 主订单号集合
refunds_type int int 退款类型
status string 退款状态
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认50条
orderBy string 排序,默认modified_time desc
modified_time_start json_encode 最后修改时间开始,有开始时间必须要有结束时间
modified_time_end json_encode 最后修改时间结束

*返回内容示例



14. 根据退款申请单refunds_id,获取单个退款申请单详情(aftersales.refundapply.get)

14.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id string required 店铺ID
refunds_id string required 退款申请单ID

*返回内容示例



15. 更新退款申请单状态(aftersales.refundapply.shop.reply)

15.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id string required 店铺ID
status string required 退款申请单审核状态
refunds_id string 退款申请单ID,如果有退款申请单ID则通过该参数进行审核
aftersales_bn string 申请售后的编号,未填写退款申请单,则根据该售后单ID审核
tid string 订单ID,如果未填写退款申请单ID和售后申请单ID,那么则根据订单ID审核取消订单的退款单

*返回内容示例



16. 商家审核退款申请单(aftersales.refundapply.shop.check)

16.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id string required 店铺ID
refund_bn string required refund_bn退款申请单编码
status string required 审核状态 agree 通过,reject 拒绝
reason json 仅在审核不通过时填写该值,审核不通过原因

*返回内容示例



17. 平台对退款申请进行退款处理(aftersales.refunds.restore)

17.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
refunds_id string required 退款申请单编号
return_fee json required 退款金额

*返回内容示例



18. 根据售后单下载售后凭证(aftersales.download.evidencePic)

18.1. 售后相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
aftersales_bn int required numeric 申请售后编号

*返回内容示例



19. 获取单笔交易信息(trade.get)

19.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid int required 订单编号
oid int 子订单编号,返回指定子订单编号的orders数据结构
fields field_list required ,orders. 获取单个订单需要返回的字段

*返回内容示例


{ "error": null, "result": { "adjust_fee": "0.000", "anony": 0, "area_id": null, "buyer_area": "310100/310104", "buyer_message": null, "buyer_rate": 0, "cancel_reason": null, "consign_time": null, "consume_point_fee": 0, "created_time": 1.437969586e+09, "disabled": 0, "discount_fee": "0.000", "dlytmpl_id": 4, "end_time": null, "invoice_main": "", "invoice_name": "individual", "invoice_type": "normal", "ip": "192.168.51.222", "is_clearing": 0, "is_part_consign": 0, "itemnum": 1, "modified_time": 1.437969586e+09, "need_invoice": 0, "obtain_point_fee": 2699, "orders": [ { "adjust_fee": "0.000", "aftersales_status": null, "anony": 0, "bind_oid": null, "bn": "apple06", "buyer_rate": "1", "cat_service_rate": "0.050", "complaints_status": "NOT_COMPLAINTS", "consign_time": null, "discount_fee": "0.000", "divide_order_fee": "0.000", "end_time": null, "invoice_no": null, "is_oversold": 0, "item_id": 32, "logistics_company": null, "modified_time": 1.437969586e+09, "num": 1, "oid": 1.507271159060001e+15, "order_from": "pc", "outer_iid": null, "outer_sku_id": null, "part_mjz_discount": "0.000", "pay_time": null, "payment": "2699.000", "pic_path": "http://images.bbc.shopex123.com/images/b4/d1/e4/5cc4933975c136479d26c05650b9372113f85cc2.png", "price": "2699.000", "refund_fee": "0.000", "refund_id": null, "seller_rate": 0, "sendnum": 0, "shipping_type": null, "shop_id": 1, "sku_id": 31, "sku_properties_name": null, "spec_nature_info": null, "status": "WAIT_BUYER_PAY", "sub_stock": 0, "tid": 1.507271159050001e+15, "timeout_action_time": null, "title": "Apple iPad Air MD788CH 9.7英寸平板电脑 (16G WLAN 机型)银色", "total_fee": "2699.000", "user_id": 1 } ], "pay_time": null, "pay_type": "online", "payed_fee": "0.000", "payment": "2700.000", "post_fee": "1.000", "real_point_fee": null, "receiver_address": "桂林路396", "receiver_city": "徐汇区", "receiver_district": null, "receiver_mobile": "13612344321", "receiver_name": "卢女士", "receiver_phone": null, "receiver_state": "上海市", "receiver_zip": "200233", "seller_rate": 0, "send_time": null, "shipping_type": null, "shop_flag": null, "shop_id": 1, "shop_memo": null, "status": "WAIT_BUYER_PAY", "step_paid_fee": null, "step_trade_status": null, "tid": 1.507271159050001e+15, "timeout_action_time": null, "title": "订单明细介绍", "total_fee": "2699.000", "trade_from": "pc", "trade_memo": "", "user_id": 1 } }

20. (商家)获取单笔交易信息(trade.shop.get)

20.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 18 店铺ID
tid int required 订单编号
oid int 子订单编号,返回指定子订单编号的orders数据结构
fields field_list required ,orders.,buyerInfo.* 获取单个订单需要返回的字段

*返回内容示例



21. 获取单笔子订单交易信息(trade.order.get)

21.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
oid int required 子订单编号
fields field_list required 获取单个子订单需要返回的字段

*返回内容示例



22. 获取子订单交易列表信息(trade.order.list.get)

22.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
oids string 子订单编号,如果子订单用逗号隔开
item_id int 商品id(和oids至少有一个必填)
status string 子订单状态,如果多个状态用逗号隔开
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认100条
fields field_list required 获取单个子订单需要返回的字段

*返回内容示例



23. 商家取消订单(trade.cancel)

23.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid string required 订单id
cancel_reason string required max:50 订单取消原因
shop_id int required 订单所属店铺id
refund_bn string 退款申请单编号
return_freight bool string 是否返还运费("true":退运费;"false":不退运费)

*返回内容示例



24. 用户申请取消订单/平台强制取消订单(trade.cancel.create)

24.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid string required 订单id
cancel_reason string required max:50 订单取消原因
user_id int 订单所属用户id

*返回内容示例



25. 获取取消订单列表(trade.cancel.list.get)

25.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
fields field_list required 获取取消订单列表需要返回的字段
user_id int 会员ID
shop_id int 店铺ID
tid string 订单编号
refunds_status string 退款状态
process string 处理进度
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认50条
orderBy string 排序,默认modified_time desc
created_time_start json_encode 创建时间开始,有开始时间必须要有结束时间
created_time_end json_encode 创建时间结束
modified_time_start json_encode 最后修改时间开始,有开始时间必须要有结束时间
modified_time_end json_encode 最后修改时间结束

*返回内容示例



26. 获取取消订单详情(trade.cancel.get)

26.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID
shop_id int 店铺ID
cancel_id string required 取消订单记录ID

*返回内容示例



27. 取消订单,退款成功后的操作(trade.cancel.succ)

27.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid string required 订单id
shop_id int required 订单所属店铺id

*返回内容示例



28. 商家审核取消订单(trade.cancel.shop.check)

28.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id string required 店铺ID
cancel_id string required 取消订单ID
status string required 审核状态 agree 通过,reject 拒绝
reason json 仅在审核不通过时填写该值,审核不通过原因

*返回内容示例



29. 获取指定订单的金额及总和(trade.money.get)

29.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid string required 支付单中订单号合集字符串

*返回内容示例



30. 获取某促销的使用次数(trade.promotion.applynum)

30.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
promotion_id string required 促销id

*返回内容示例



31. 选择的优惠券放入购物车优惠券表(trade.cart.cartCouponAdd)

31.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
coupon_code string required 优惠券编码
shop_id int required integer 店铺id
user_id int required integer 用户id

*返回内容示例



32. 取消优惠券(trade.cart.cartCouponCancel)

32.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
coupon_code string required 优惠券编码
shop_id int required 优惠券编码

*返回内容示例



33. 获取购物车信息(trade.cart.getCartInfo)

33.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
mode string fastbuy cart 购物车类型(立即购买,购物车)
needInvalid boolean true true 是否需要显示失效商品
platform string true pc 平台
user_id int required integer true 用户id

*返回内容示例



34. 获取基本购物车信息(trade.cart.getBasicCartInfo)

34.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
mode string fastbuy cart 购物车类型(立即购买,购物车)
checked boolean 1 可结算商品
platform string true pc 平台

*返回内容示例



35. 统计购物车商品数量(trade.cart.getCount)

35.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明

*返回内容示例



36. 订单售后状态处理(未完成订单退款成功时更新订单状态为关闭)(order.aftersales.status.update)

36.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid int required 主订单编号
oid int required 子订单编号
user_id int required 订单所属用户
aftersales_status int required 子订单售后状态
refund_fee string 实际退款金额
total_fee string 商家退款金额

*返回内容示例



37. 买家对不满意订单发起投诉(trade.order.complaints.create)

37.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
oid int required 1506181717250001 投诉子订单号
tel string required 13918987654 投诉人联系方式
image_url string 投诉图片凭证URL,最多5张图片,URL用逗号隔开
complaints_type string required 售后问题 投诉类型
content string required min:5 max:300 商家描述可以随时退款,现在说不能退 投诉问题的具体描述

*返回内容示例



38. 平台对订单投诉同步处理结果(trade.order.complaints.process)

38.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
complaints_id int required 1 投诉ID
memo string required min:5 max:200 该投诉是因为快递运送不及时,误会导致 处理备注
status string 投诉处理状态,WAIT_SYS_AGREE 等待处理,FINISHED 已完成, CLOSED 已关闭

*返回内容示例



39. 根据自订单号获取单个订单投诉详情(trade.order.complaints.info)

39.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
oid int 1507021608160001 子订单ID
complaints_id int 15 投诉自增id
fields field_list required 获取单个订单投诉的字段

*返回内容示例



40. 买家撤销订单投诉(trade.order.complaints.buyer.close)

40.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
complaints_id int required 1 订单投诉ID
buyer_close_reasons string required min:5 max:200 买家撤销订单投诉原因

*返回内容示例



41. 获取指定会员订单投诉列表(trade.order.complaints.list)

41.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 23 会员id
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认100条
fields field_list required 获取订单投诉的字段

*返回内容示例



42. 获取订单列表(trade.get.list)

42.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 订单所属用户id
shop_id int int 订单所属店铺id
status string 订单状态
buyer_rate string 订单评价状态
tid string 订单编号,多个用逗号隔开
create_time_start string 查询指定时间内的交易创建时间开始yyyy-MM-dd
create_time_end string 查询指定时间内的交易创建时间结束yyyy-MM-dd
receiver_mobile string 收货人手机
receiver_phone string 收货人电话
receiver_name string 收货人姓名
user_name string 会员用户名/手机号/邮箱
is_aftersale bool 是否显示售后状态
pay_type string 支付方式【offline、online】
shipping_type string 配送类型
page_no int int 1 分页当前页码,1<=no<=499
page_size int int 40 分页每页条数(1<=size<=200)
order_by int created_time desc 排序方式
fields field_list 获取的交易字段集

*返回内容示例



43. 获取订单列表(trade.get.shop.list)

43.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺id
user_id int 订单所属用户id
status string 订单状态
buyer_rate string 订单评价状态
tid string 订单编号,多个用逗号隔开
update_time_start string 查询指定时间内的交易创建时间开始yyyy-MM-dd
update_time_end string 查询指定时间内的交易创建时间结束yyyy-MM-dd
page_no int 1 分页当前页码,1<=no<=499
page_size int 40 分页每页条数(1<=size<=200)
order_by int created_time desc 排序方式
fields field_list required 获取的交易字段集

*返回内容示例



44. 交易完成(trade.confirm)

44.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid int required numeric 订单id
user_id int 订单所属用户id
shop_id int 订单所属店铺id

*返回内容示例



45. 交易改价(trade.update.price)

45.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid int required 订单id
post_fee int 调整后的运费
order json required 子订单被调整的信息,json格式

*返回内容示例



46. 对指定订单进行发货,交易发货(trade.delivery)

46.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid int required 订单号
corp_code int required 物流公司编号
logi_no int 运单号
ziti_memo int 自提备注
shop_id int required 店铺id
seller_id int required 商家操作员id
memo string 1 备注

*返回内容示例



47. 对指定订单进行发货,交易发货(OMS发货)(logistics.shop.trade.delivery)

47.1. 物流相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid int required 订单号
corp_code int required 物流公司编号
corp_no int 运单号
ziti_memo int 自提备注
shop_id int required 店铺id
seller_id int required 商家操作员id
memo string 1 备注

*返回内容示例



48. 自提订单短信发送提货码(trade.shop.delivery.vcode.send)

48.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid string required 订单id
shop_id int required 订单所属店铺id

*返回内容示例



49. 验证自提订单提货码(trade.shop.delivery.vcode.verify)

49.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid string required 订单id
shop_id int required 订单所属店铺id
vcode int required 自提订单提货码

*返回内容示例



50. 获取自提订单提货码(trade.shop.delivery.vcode.get)

50.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid string required 订单id
shop_id int required 订单所属店铺id

*返回内容示例



51. 订单支付状态改变(trade.pay.finish)

51.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid int required 订单id
payment int required 已支付金额

*返回内容示例



52. 删除购物车数据(trade.cart.delete)

52.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
cart_id string 33,44,12,3 购物车id,多个数据用逗号隔开
user_id string 用户id
mode string 是否是立即购买

*返回内容示例



53. 更新购物车数据(trade.cart.update)

53.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
cart_id int 购物车id,多个数据用逗号隔开
user_id int 用户id
totalQuantity int 数量
obj_type string 数据类型
selected_promotion string 购物车选中的促销id
mode string 是否立即购买
is_checked bool 是否被选中

*返回内容示例



54. 加入购物车(trade.cart.add)

54.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 3 会员id
quantity int 3 商品数量
sku_id int required_if:goodsType,item 3 货品id
package_sku_ids string required_if:goodsType,package 11,21,45 组合促销sku_id
package_id integer sometimes required integer 3 组合促销id
obj_type string item 对象类型
mode string required cart 购物车类型

*返回内容示例



55. 订单创建(trade.create)

55.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 会员id
user_name int required 会员用户名
addr_id int required 收货地址
payment_type string required online online 支付途径,暂时只支持线上支付
source_from int required pc pc 订单来源
shipping_type string 2:express;4:ziti;20:express 配送方式,规则为店铺id:配送类型;
ziti string 2:3;4:1;20:5 自提地址,规则为店铺id:自提点id;
mode int required cart fastbuy 购买方式,立即购买或加入购物车购买
need_invoice int 是否要开发票
invoice_type int 发票类型
invoice_content int 发票内容
invoice_title int 发票抬头
use_points int 使用的积分值

*返回内容示例



56. 计算订单包含运费后的金额(trade.price.total)

56.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
total_fee money required 订单总额
total_weight float required numeric 订单总重量
shop_id int required 店铺id
shipping_type string required express 配送类型
region_id string 收货地址编号
usedCartPromotionWeight float 收货地址编号
discount_fee string
usedToPostage string required 运费信息

*返回内容示例



57. 根据条件统计订单数量(trade.count)

57.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员id
shop_id int 店铺id
status int 订单状态

*返回内容示例



58. 统计订单未评价数量(trade.notrate.count)

58.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员id
shop_id int 店铺id

*返回内容示例



59. 订单备注添加(trade.add.memo)

59.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid int required 订单id
shop_id int required 订单所属店铺id
trade_memo string 备注内容
shop_memo string 备注内容

*返回内容示例



60. 根据用户ID,查询用户最近购买记录(trade.user.buyerList)

60.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户id

*返回内容示例



61. 确认收款、收货(trade.moneyAndGoods.receipt)

61.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid string required 订单编号
shop_id int required 订单所属店铺id
seller_id int required 订单所属店铺的操作员
seller_name int required 订单所属店铺的操作员
memo int required 操作备注

*返回内容示例



62. 创建结算单明细(clearing.detail.add)

62.1. 结算相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid string required 订单编号
settlement_type string 1 结算类型

*返回内容示例



63. 获取结算明细列表(clearing.detail.getlist)

63.1. 结算相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id string required 店铺编号id
settlement_time_than string 1 生成结算单开始时间
settlement_time_lthan string 1 生成结算单结束时间
settlement_type string 1 结算类型
fields field_list 需要的字段
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
orderBy string 排序,默认created_time asc

*返回内容示例



64. 获取结算单汇总列表(clearing.getList)

64.1. 结算相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id string required 店铺编号id
settlement_time_than string 1 生成结算单开始时间
settlement_time_lthan string 1 生成结算单结束时间
settlement_status string 1 结算状态
fields field_list 需要的字段
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
orderBy string 排序,默认created_time asc

*返回内容示例



65. 根据商品信息获取子订单列表(trade.order.list.item)

65.1. 交易相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 订单所属用户id
item_id int 商品id(和oids至少有一个必填)
keyword string 子订单商品搜索关键字
status string 子订单状态,如果多个状态用逗号隔开
page_no int int 分页当前页数,默认为1
page_size int int 每页数据条数,默认100条
order_by int created_time desc 排序方式
fields field_list required 获取单个子订单需要返回的字段

*返回内容示例



66. 库存报警(item.store.police)

66.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
store int required 2 库存数
shop_id string 18 店铺id
fields field_list item_id,title,item_store.store,item_status.approve_status 要获取的商品字段集 item_id
page_no int numeric 1 分页当前页码,1<=no<=499
page_size int numeric 40 分页每页条数(1<=size<=200)

*返回内容示例



67. 库存报警总数(item.store.police.count)

67.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
store int required 2 库存数
shop_id string 18 店铺id

*返回内容示例



68. 保存店铺分类(item.store.add)

68.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
policevalue int required 库存报警数量
shop_id int required 店铺id
police_id int 库存报警Id

*返回内容示例



69. 根据店铺ID获取店铺设置的库存报警值(item.store.info)

69.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺ID
fields field_list 店铺数据字段

*返回内容示例



70. 恢复库存(item.store.recover)

70.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required 2 商品id
sku_id int required 2 货品id
quantity int required 2 恢复库存数量
sub_stock bool 2 扣减库存方式(order_create,order_pay)
tradePay bool 1 订单支付状态

*返回内容示例



71. 付款,下单扣减库存(item.store.minus)

71.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required 188
sku_id int required 192
quantity int required 3
sub_stock boolean boolean 1
status string in:afterorder,afterpay afterorder

*返回内容示例



72. 回写库存(item.shop.store.update)

72.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
list_quantity string required [{"bn":"S558FBDE4EE0E901","quantity":100},{"bn":"S558FBDE4EE0E902","quantity":100}] 库存列表的json格式{"bn"=>,"quantity"=>},bn为sku_bn,不是商品bn
shop_id int required 18 店铺ID

*返回内容示例



73. 修改商品销量(item.updateSoldQuantity)

73.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required 商品ID
num int required 本次增加的商品销量

*返回内容示例



74. 修改评论数量(item.updateRateQuantity)

74.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required 商品ID
rate_good_count int 本次增加的好评次数
rate_neutral_count int 本次增加的中评次数
rate_bad_count int 本次增加的差评次数

*返回内容示例



75. 获取单个商品的详细信息(item.get)

75.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required 2 商品编号
shop_id int 2 店铺id
fields field_list title,item_store.store,item_status.approve_status 要获取的商品字段集

*返回内容示例



76. 商品id列表,多个item_id用逗号隔开 调用一次不超过20个(item.list.get)

76.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id string required 2,3,4 商品编号
shop_id string 18 店铺id
fields field_list required item_id,title,item_store.store,item_status.approve_status 要获取的商品字段集 item_id必填

*返回内容示例



77. 根据条件获取商品列表(item.search)

77.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id string 2,3,5,6 商品id,多个id用,隔开
shop_id int integer 店铺id
dlytmpl_id int integer 运费模板id
shop_cat_id int string 店铺自有类目id
search_shop_cat_id int 店铺搜索自有一级类目id
cat_id string 1,3 商城类目id
brand_id string 1,2,3 品牌ID
prop_index string 商品自然属性
search_keywords string 搜索商品关键字
buildExcerpts bool 是否关键字高亮
is_selfshop bool 是否是自营
use_platform string 1 0 商品使用平台(0=全部支持,1=仅支持pc端,2=仅支持wap端)如果查询不限制平台,则不需要传入该参数
min_price int numeric 搜索最小价格
max_price int numeric 搜索最大价格
bn string 搜索商品货号
approve_status string 商品上架状态
page_no int numeric 1 分页当前页码,1<=no<=499
page_size int numeric 40 分页每页条数(1<=size<=200)
orderBy string modified_time desc,list_time desc 排序方式
fields field_list 要获取的商品字段集

*返回内容示例



78. 获取指定商品的货品列表(item.sku.list)

78.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required 2 商品id

*返回内容示例



79. 根据sku_id获取货品数据(item.sku.get)

79.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 是否需要Oauth支持:是

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
sku_id string required 2 货品ID
item_id int 2 商品id

*返回内容示例



80. 根据搜索条件,列出渐进式的筛选项(item.search.filterItems)

80.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id string 2,3,5,6 商品id,多个id用,隔开
shop_id int 店铺id
shop_cat_id int 店铺自有类目id
cat_id int 商城类目id
approve_status string 商品上架状态
search_keywords string 搜索商品关键字
use_platform string 1 0 商品使用平台(0=全部支持,1=仅支持pc端,2=仅支持wap端)如果查询不限制平台,则不需要传入该参数

*返回内容示例



81. 更新商品的关联促销信息(item.promotion.addTag)

81.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required 商品ID
promotion_id int required 促销id

*返回内容示例



82. 删除商品的某个促销信息(item.promotion.deleteTag)

82.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
promotion_id int required int 促销id

*返回内容示例



83. 获取单个商品的促销信息(item.promotion.get)

83.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required int 商品ID

*返回内容示例



84. 统计商品数量(item.count)

84.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 2 店铺id
status string 2 商品状态

*返回内容示例



85. 获取商品统计数据(item.get.count)

85.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required 2 商品编号
fields field_list 要获取的统计字段

*返回内容示例



86. 商品添加(item.create)

86.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明

*返回内容示例



87. 商品上下架修改(item.sale.status)

87.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required int 2,3,5,6 商品id,多个id用,隔开
shop_id int required int 店铺id
approve_status string required 商品上架状态

*返回内容示例



88. 商品删除(item.delete)

88.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required int 2,3,5,6 商品id,多个id用,隔开
shop_id int required int 店铺id

*返回内容示例



89. 商品运费模板修改(item.update.dlytmpl)

89.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required int 1 商品id,多个id用,隔开
shop_id int required int 1 店铺id
dlytmpl_id int required 1 商品运费模板

*返回内容示例



90. 获取指定商品的自然属性(item.get.nature.prop)

90.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int required 商品id

*返回内容示例



91. sku列表查询(sku.list)

91.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
sku_ids string required 1,2,3,4,5 sku_id列表, id之间用","分割
fields field_list required item_id,title,item_store.store,item_status.approve_status 要获取的商品字段集 item_id必填

*返回内容示例



92. 根据搜索条件和库存报警数获取商品列表(search.item.oversku)

92.1. 商品相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
store int required 2 店铺设置的库存警告数
shop_id int required 店铺id
fields field_list item_id,title,item_store.store,item_status.approve_status 要获取的商品字段集 item_id
page_no int numeric 1 分页当前页码,1<=no<=499
page_size int numeric 40 分页每页条数(1<=size<=200)
search_shop_cat_id int 店铺搜索自有一级类目id
search_keywords string 搜索商品关键字
use_platform string 1 0 商品使用平台(0=全部支持,1=仅支持pc端,2=仅支持wap端)如果查询不限制平台,则不需要传入该参数
min_price int numeric 搜索最小价格
max_price int numeric 搜索最大价格
bn string 搜索商品货号

*返回内容示例



93. 对已完成的订单新增商品评论,店铺评分(rate.add)

93.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid string required 新增评论的订单ID
rate_data json required 对子订单评论的参数
tally_score int required 商品与描述相符
attitude_score int required 服务态度评分
delivery_speed_score int required 发货速度评分
logistics_service_score int required 物流公司服务评分

*返回内容示例



94. 用户删除评价(rate.delete)

94.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
rate_id int required 用户要删除的评价ID

*返回内容示例



95. 商家申诉修改评价成功,用户有7天的修改时限(rate.update)

95.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
rate_id int required 用户要操作的评价ID
result string required 评价结果,good 好评 neutral 中评 bad 差评
content string 评价内容
rate_pic string 晒单图片

*返回内容示例



96. 获取单条评论详情(rate.get)

96.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
role string 调用角色 buyer seller
rate_id int required 用户要操作的评价ID
fields field_list required 需要返回的字段

*返回内容示例



97. 获取评论列表(rate.list.get)

97.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
role string 调用角色
item_id bool 评价的商品ID
item_title string 评价的商品名称
rate_start_time time 申诉开始时间
rate_end_time time 申诉结束时间
is_content bool 是否有内容,true内容 false 全部
is_pic bool 是否有晒单 true 有晒图 false全部
is_reply bool 是否回复
result string 评价结果
appeal_again bool 再次申诉
appeal_start_time time 申诉开始时间
appeal_end_time time 申诉结束时间
appeal_status string 申诉结果
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
orderBy string 排序,默认created_time desc
fields field_list required 需要返回的字段

*返回内容示例



98. 商家解释,回复评论(rate.reply.add)

98.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
rate_id int required 商家要回复的评论ID
reply_content string required 商家回复的内容

*返回内容示例



99. 将评论的实名修改为匿名,但是修改为匿名之后则不能再次修改为实名(rate.set.anony)

99.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
rate_id int required 用户要操作的评价ID
user_id int required 1 用户ID

*返回内容示例



100. 卖家对评价进行追评(rate.append)

100.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 追评用户ID
rate_id int required 评论ID
content string required min:5 max:300 追评内容
pic string 追评图片,通过图片上传API返回的图片ID,多个用逗号隔开

*返回内容示例



101. 买家对追评进行回复(解释说明)(rate.append.reply)

101.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
rate_id int required numeric 评论ID
shop_id int required numeric 商家的店铺ID
reply_content string required min:5 max:300 追评内容

*返回内容示例



102. 商家对评论进行申诉(rate.appeal.add)

102.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
rate_id string required 需要申诉评论ID
is_again bool 是否为再次申诉,true再次申诉,false首次申诉
appeal_type string 申诉类型(首次申诉必填),APPLY_DELETE 申请删除评论;APPLY_UPDATE 申请修改评论
content string required 申诉内容
evidence_pic string 申诉图片凭证

*返回内容示例



103. 平台对商家申诉的评论进行审核(rate.appeal.check)

103.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
appeal_id string required 需要申诉评论ID
result string required 审核结果,true同意或者false驳回
reject_reason string 如果是驳回需要填写驳回的理由

*返回内容示例



104. 获取单条评论详情(rate.dsr.get)

104.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 用户要操作的评价ID
catDsrDiff string 是否需要返回行业平均分同比
countNum string 是否需要返回行店铺每个动态评分的数量

*返回内容示例



105. 商家对平台进行意见反馈(feedback.add)

105.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
name string required 张三 提交意见的姓名
email string required email example@shopex.cn 平台处理后告知结果的邮箱
tel string required 021-68100100 联系的电话或者手机号码
question string required min:10 max:300 反馈问题的详细描述

*返回内容示例



106. 获取评价统计(rate.count)

106.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺id

*返回内容示例



107. 获取咨询列表(rate.gask.list)

107.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int int 商品id
shop_id int int 店铺id
user_id int int 消费者id
type int 咨询类型
is_reply int 是否回复
page_no int int 分页当前页数,默认为1
page_size int int 每页数据条数,默认10条
orderBy string 排序,默认modified_time desc
fields field_list required 需要返回的字段

*返回内容示例



108. 删除咨询、回复(rate.gask.delete)

108.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
id string required id
user_id int 咨询人ID
shop_id int 店铺id

*返回内容示例



109. 商品咨询新增(rate.gask.create)

109.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id string required 商品id
type string required 咨询类型
content string required max:200 咨询内容
is_anonymity bool 是否匿名
user_id string required 咨询人ID
user_name string required 咨询人
contack string 联系方式

*返回内容示例



110. 商品咨询统计(rate.gask.count)

110.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
item_id int int 商品id
shop_id int int 店铺id
user_id int int 消费者id
type int 咨询类型

*返回内容示例



111. 咨询回复(rate.gask.reply)

111.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
id int required int 被回复的咨询id
content string required max:300 咨询内容
author_id string required 咨询人ID
author string required 咨询人
shop_id string required 店铺id

*返回内容示例



112. 更新咨询、回复(rate.gask.display)

112.1. 评价相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
id int required int id
shop_id int required int 所属店铺
display int required 是否显示

*返回内容示例



113. 根据订单总金额平摊使用的积分(point.deduction.num)

113.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 会员ID
use_point int required 会员使用的积分
total_money string required 本次订单总额
trade_money string required 店铺订单总额

*返回内容示例



114. 获取积分的配置信息(point.setting.get)

114.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
field 积分设置key值

*返回内容示例



115. 更新会员的积分值(user.updateUserPoint)

115.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 会员ID
type string required 积分记录类型("获得","消费")
num int required 积分数量
behavior string required 积分行为
remark string 备注

*返回内容示例



116. 更新会员的成长总值(user.updateUserExp)

116.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 会员ID
type string required 行为类型("增加","减少")
num int required 成长值数量
behavior string required 行为描述
remark string 备注

*返回内容示例



117. 获取积分记录列表(user.pointGet)

117.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认100条
orderBy int modified_time desc 排序方式
fields field_list 需要的字段

*返回内容示例



118. 获取指定会员的积分值(user.point.get)

118.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 会员ID

*返回内容示例



119. 获取积分记录列表(user.experienceGet)

119.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认100条
orderBy int modified_time desc 排序方式
fields field_list 需要的字段

*返回内容示例



120. 获取会员当前等级详细信息(user.grade.fullinfo)

120.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明

*返回内容示例



121. 获取会员当前等级基本信息(user.grade.basicinfo)

121.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明

*返回内容示例



122. 获取会员当前等级列表(user.grade.list)

122.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明

*返回内容示例



123. 下订单计算积分(user.pointcount)

123.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
money money 订单商品总额

*返回内容示例



124. 获取用户优惠券列表(user.coupon.list)

124.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
page_no int
page_size int
fields field_list
orderBy string
user_id int required
shop_id int
is_valid int
platform string

*返回内容示例



125. 获取用户优惠券数量(user.coupon.count)

125.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
page_no int
page_size int
orderBy string
user_id int required
shop_id int
is_valid int
platform string

*返回内容示例



126. 获取用户优惠券信息(user.coupon.get)

126.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
coupon_code string required 店铺ID

*返回内容示例



127. 取消订单返还优惠券(user.coupon.back)

127.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
tid int required 主订单号

*返回内容示例



128. 领取优惠券(user.coupon.getCode)

128.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
coupon_id int required 优惠券ID必填

*返回内容示例



129. 删除会员单条优惠券(user.coupon.remove)

129.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
coupon_code string required 优惠券CODE必填

*返回内容示例



130. 修改优惠券使用信息(user.coupon.useLog)

130.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
coupon_code string required 优惠券编码
tid int required 订单id

*返回内容示例



131. 过期优惠券状态更改(user.coupon.expire)

131.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
coupon_id int required 优惠券ID必填

*返回内容示例



132. 获取会员商品收藏列表(user.itemcollect.list)

132.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认20条
fields field_list 需要的字段
user_id int required 用户ID必填
cat_id int 商品3级分类
orderBy string 排序

*返回内容示例



133. 获取会员商品收藏总数(user.itemcollect.count)

133.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
cat_id int 商品3级分类

*返回内容示例



134. 添加商品收藏(user.itemcollect.add)

134.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
item_id int required 商品ID必填
objectType string 类型如:goods

*返回内容示例



135. 删除商品收藏(user.itemcollect.del)

135.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
item_id int 商品ID必填

*返回内容示例



136. 获取会员店铺收藏列表(user.shopcollect.list)

136.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认20条
fields field_list 需要的字段
user_id int required 用户ID必填
orderBy string 排序

*返回内容示例



137. 获取会员店铺收藏总数(user.shopcollect.count)

137.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填

*返回内容示例



138. 添加店铺收藏(user.shopcollect.add)

138.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
shop_id int required 店铺ID必填

*返回内容示例



139. 删除店铺收藏(user.shopcollect.del)

139.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
shop_id int required 店铺ID必填

*返回内容示例



140. 获取会员商品收藏和店铺收藏(user.collect.info)

140.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填

*返回内容示例



141. 会员地址添加(user.address.add)

141.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
addr_id int 收货地址ID
area string required 地区
addr string required 地址
zip string numeric max:999999 邮编
name string required 会员名称
mobile string 电话
def_addr bool 是否是设为默认

*返回内容示例



142. 会员地址默认设置(user.address.setDef)

142.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
addr_id int required 地址ID必填

*返回内容示例



143. 删除会员地址(user.address.del)

143.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
addr_id int required 地址ID必填

*返回内容示例



144. 获取会员目前地址数量和地址最大限制数量(user.address.count)

144.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填

*返回内容示例



145. 获取会员地址列表(user.address.list)

145.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
def_addr bool 0 是否为默认收货地址
fields field_list * 所需字段

*返回内容示例



146. 获取会员地址详情(user.address.info)

146.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID必填
addr_id int required 收货地址id
fields field_list * 所需字段

*返回内容示例



147. 创建会员信息(user.create)

147.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
account string required 用户名必填
password int required 密码必填
pwd_confirm int required 确认密码必填
reg_ip string required 会员注册时的IP

*返回内容示例



148. 获取用户登录信息(user.get.account.info)

148.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_name int required 登录用户名

*返回内容示例



149. 根据会员ID获取对应的用户名(user.get.account.name)

149.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id string required 用户ID必填

*返回内容示例



150. 根据用户名/手机/邮箱 获取会员ID(user.get.account.id)

150.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_name string required 会员用户名/手机号/邮箱

*返回内容示例



151. 检测用户登录类型(user.get.account.type)

151.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_name string required 登录用户名

*返回内容示例



152. (user.trust.authorize)

152.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
flag string 信任登陆标识
view string required in:wap,web web 显示视图
state string required 状态码
redirect_uri string required redirect_uri地址
params int required oauth callback参数

*返回内容示例



153. 获取用户的详细信息(user.get.info)

153.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id string required 会员id
fields field_list 查询字段

*返回内容示例



154. 用户基本信息更新(user.basics.update)

154.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明

*返回内容示例



155. 用户密码找回和修改(user.pwd.update)

155.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
type int required reset update 类型形式(密码重置[reset]、密码修改[update])必填
new_pwd int required 新的密码6-20个字符,必填
confirm_pwd int required 新密码确认, 必填
user_id int null 用户名id
old_pwd int null 原有密码(当类型形式type的值为update时,此值必填)
uname int null 用户名

*返回内容示例



156. 更改用户登录信息(user.account.update)

156.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required null 用户名id
user_name int required null 用户名
type string null 是解绑还是绑定

*返回内容示例



157. 用户登录(user.login)

157.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_name int required 登录用户名
password int required 用户登录密码

*返回内容示例



158. 检测用户登录密码(user.login.pwd.check)

158.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
password int required 登录用户密码

*返回内容示例



159. 验证邮箱(user.email.verify)

159.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 用户ID,必填
email int required 需要验证的邮箱,必填

*返回内容示例



160. 会员到货通知(user.notifyitem)

160.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 商家id
item_id int required 商品id
sku_id string required 货品id
email string required 邮件

*返回内容示例



161. 会员到货通知修改(user.updatenotifyitem)

161.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
gnotify_id int required 缺货ID

*返回内容示例



162. 会员到货通知列表(user.notifyItemList)

162.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 商家id
item_id int required 商品id
sendstatus string required 发送状态
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认20条
fields field_list 需要的字段

*返回内容示例



163. 获取用户的预存款信息(user.deposit.getInfo)

163.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id string required 会员id
with_log bool 是否查询日志
page bool numeric min:0 1 日志列表的页数
row_num bool numeric min:0 10 日志列表每页的行数

*返回内容示例



164. 用户付款接口(user.deposit.pay)

164.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id string required 会员id
password string required 会员预存款支付密码
fee float required numeric min:0 100.2 消费金额
memo string 前端消费,订单号:1111111,支付单号:222222222 备注信息

*返回内容示例



165. 用户充值接口(user.deposit.recharge)

165.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id string required 会员id
fee float required numeric min:0 100.2 消费金额
memo string 充值,支付单号:222222222 备注信息

*返回内容示例



166. 修改预存款密码的接口(不需要旧密码)(user.deposit.password.set)

166.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id string required 会员id
password string required 会员预存款支付密码

*返回内容示例



167. 修改预存款密码的接口(需要旧密码)(user.deposit.password.change)

167.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id string required 会员id
old_password string required 原有的会员预存款支付密码
new_password string required 新的会员预存款支付密码

*返回内容示例



168. 判断会员是否有预存款密码(user.deposit.password.has)

168.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id string required 会员id

*返回内容示例



169. 验证预存款原支付密码(user.check.deposit.oldpwd)

169.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required
old_password string required

*返回内容示例



170. 平台退款至预存款(user.deposit.refund)

170.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id string required 会员id
operator string required 操作员
fee float required numeric min:0 100.2 消费金额
memo string 前端消费,订单号:1111111,支付单号:222222222 备注信息

*返回内容示例



171. 验证会员登录密码和支付密码是否一致(user.check.loginPwd.DepositPwd)

171.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required 会员id
cipher string required 密码明文
check_type string required 验证类型

*返回内容示例



172. 申请提现(user.deposit.applyCash)

172.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int numeric required
amount float required
bank_card_id string required
bank_name string required
bank_card_owner string required
password string required

*返回内容示例



173. 申请提现数据验证(user.deposit.checkCash)

173.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required numeric
amount float required

*返回内容示例



174. 获取配置信息(user.deposit.getCashConf)

174.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int numeric

*返回内容示例



175. 申请提现(user.deposit.getCash)

175.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int numeric required
fields string
page int numeric min:0 1
row_num int numeric min:0 10

*返回内容示例



176. 存储消费者浏览商品历史纪录(user.browserHistory.set)

176.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required numeric 24
itemIds string required 140,30

*返回内容示例



177. 获取指定消费者浏览商品历史纪录(user.browserHistory.get)

177.1. 用户相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int required numeric 24

*返回内容示例



178. 获取指定类目信息(category.cat.get.info)

178.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
parent_id int 33 父类id
cat_id string 33 类目id,和cat_name二选一
cat_path string 33 类目id
cat_name string 大家电 类目名称和cat_id二选一
level int 1 类目等级1、2、3,当cat_name不为空时,此参数必填
fields field_list cat_name,cat_id cat_name,level,cat_id 获取类目的指定字段

*返回内容示例



179. 获取指定一级类目的信息以及2、3级类目信息(category.cat.get)

179.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
cat_id string required 1,23 类目id,以逗号相隔的多个id数据
fields field_list cat_name,cat_id cat_name,level,cat_id 获取类目的指定字段

*返回内容示例



180. 获取类目树形结构(category.cat.get.list)

180.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明

*返回内容示例



181. 类目删除(category.cat.remove)

181.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
cat_id int required 类目id

*返回内容示例



182. 获取指定3级类目的信息以及该父级的所有结构(category.cat.get.data)

182.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
cat_id string int required 23 类目id
fields field_list cat_name,cat_id cat_name,level,cat_id 获取类目的指定字段

*返回内容示例



183. 根据任意类目id获取对应类目的叶子类目ID(category.cat.get.leafCatId)

183.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
cat_id int int required 23 类目id

*返回内容示例



184. 获取品牌详情(category.brand.get.info)

184.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
brand_id string 1,2,3 品牌id,多个id以逗号相隔
fields string brand_id,brand_name * 品牌字段,多个以逗号隔开

*返回内容示例



185. 获取品牌列表(category.brand.get.list)

185.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
brand_id string 1,2,3 品牌id,多个id以逗号相隔
brand_name string apple,优衣库 品牌名称,多个以逗号隔开
fields string brand_id,brand_name * 品牌字段,多个以逗号隔开

*返回内容示例



186. 添加商品品牌(category.brand.add)

186.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
brand_id int 品牌id
brand_name string required 品牌名称
order_sort int 排序
brand_alias string 品牌别名
brand_logo string 品牌图片标识

*返回内容示例



187. 修改商品品牌(category.brand.update)

187.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
brand_id int required 品牌id
brand_name string required 品牌名称
order_sort int 排序
brand_alias string 品牌别名
brand_logo string 品牌图片标识

*返回内容示例



188. 获取类目关联的品牌(category.get.cat.rel.brand)

188.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id string 3 签约店铺id
cat_id int required 1 类目id
fields fields_list brand_id,brand_name 品牌字段集

*返回内容示例



189. 根据类目id获取类目关联的属性值(category.catprovalue.get)

189.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
cat_id int required 3级类目id
type int required 属性类型(nature,spec)
prop_id string 属性id集合,多个用逗号隔开

*返回内容示例



190. 获取属性列表(category.prop.list)

190.1. 品牌类目相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
prop_id string required 属性id集合,多个用逗号隔开

*返回内容示例



191. 检测店铺名称是否存在(shop.name.check)

191.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_name string required 1 店铺名称
enterapply_id int 1 入驻申请id

*返回内容示例



192. 获取商家签约的类目和品牌信息(id集)和店铺类型(shop.authorize.catbrandids.get)

192.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 1 店铺id
fields field_list cat.cat_id,cat,cat_name,brand.brand_id,brand.brand_name cat.cat_id,cat,cat_name,brand.brand_id,brand.brand_name 要获取店铺签约的类目和品牌字段集

*返回内容示例



193. 获取店铺自有类目(shop.cat.get)

193.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 1 店铺id
cat_id string 1 id
parent_id int 1 分类父级id
fields field_list shop_id,cat_name 店铺类目字段

*返回内容示例



194. 获取店铺基本信息(shop.get)

194.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 1 店铺id
fields field_list shop_id,shop_name shop_id,shop_name,shop_descript,shop_type,status,open_time,shop_logo,shop_area,shop_addr 店铺数据字段

*返回内容示例



195. 根据店铺名称查询店铺列表数据(shop.get.search)

195.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_name string required 1 店铺名称关键字
fields field_list shop_id,shop_name shop_id,shop_name,shop_descript,shop_type,status,open_time,shop_logo,shop_area,shop_addr 店铺数据字段

*返回内容示例



196. 根据店铺ID获取店铺列表数据(shop.get.list)

196.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id string required 1,3,4 店铺ID
fields field_list shop_id,shop_name shop_id,shop_name,shop_descript,shop_type,status,open_time,shop_logo,shop_area,shop_addr 店铺数据字段

*返回内容示例



197. 获取店铺详细信息(shop.get.detail)

197.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 1 店铺id
fields field_list shop_id,shop_name shop_id,shop_name,shop_descript,shop_type,status,open_time,shop_logo,shop_area,shop_addr 店铺数据字段

*返回内容示例



198. 获取店铺关联的类目费率(shop.get.cat.fee)

198.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 1 店铺id

*返回内容示例



199. 根据店铺id获取店铺名称(带后缀)(shop.get.shopname)

199.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id string required 1,3,5 店铺id串

*返回内容示例



200. 更新店铺基本信息暂时只修改店铺logo和店铺描述

200.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id string required 1,3,5 店铺id串
shop_logo string http://img0.cn/aa.jpg 店铺logo
shop_descript string 李维斯(Levi's)是著名的牛仔裤品牌 店铺基本描述

*返回内容示例



201. 保存店铺通知(shop.savenotice)

201.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
notice_id string 店铺id
notice_title string required http://img0.cn/aa.jpg 店铺通知标题
notice_content string required 店铺通知内容
notice_type string required 店铺通知类型
shop_id string 店铺id

*返回内容示例



202. 获取店铺单条通知(shop.get.shopnoticeinfo)

202.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
notice_id string required 店铺id
fields field_list 需要的字段

*返回内容示例



203. 获取店铺通知(shop.get.shopnoticelist)

203.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺id
notice_type string 店铺id
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认20条
fields field_list 需要的字段
orderBy string 排序

*返回内容示例



204. 获取店铺签约的类目(shop.authorize.cat)

204.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 1 店铺id
fields field_list cat_id,cat_name cat_id,cat_name 要获取店铺签约的类目字段集

*返回内容示例



205. 获取指定用户的店铺id(shop.get.loginId)

205.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
seller_id int 1 当前登录的商家 卖家用户id

*返回内容示例



206. 根据品牌id获取店铺id(shop.get.by.brand)

206.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
brand_id string required 1 品牌id,多个用逗号(,)隔开
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认20条
orderBy string shop_id desc 排序
fields field_list shop_id 需要的字段

*返回内容示例



207. 获取指定用户的店铺id(shop.get.by.cat)

207.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
cat_id string required 1 类目id,多个用逗号(,)隔开
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认20条
orderBy string shop_id desc 排序
fields field_list shop_id 需要的字段

*返回内容示例



208. 保存店铺分类(shop.save.cat)

208.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
catlist string 店铺分类
shop_id string required 店铺id

*返回内容示例



209. 获取入驻申请信息(shop.get.enterapply)

209.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
seller_id int required 入驻申请编号
fields field_list 入驻信息字段,多个用逗号隔开

*返回内容示例



210. 商家入驻申请(shop.create.enterapply)

210.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明

*返回内容示例



211. 商家入驻申请更改(shop.update.enterapply)

211.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
seller_id int required 入驻申请编号
shop_name int required 申请店铺名称
shop_type int required 申请店铺类型{flag,brand,cat}
shopuser_name int required 申请店铺店主名称
company_name int required 申请店铺公司名称
shop json required 店铺基本信息集合
shop_info json required 店铺详细信息集合

*返回内容示例



212. 获取该品牌签约的店铺(shop.check.brand.sign)

212.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明

*返回内容示例



213. 获取所有的店铺类型列表(shop.type.get)

213.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
seller_id int 1 当前登录的商家 店铺类型
is_display int 1 当前登录的商家 是否显示给商家

*返回内容示例



214. 获取店铺类型信息(shop.type.getinfo)

214.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 1 当前登录的商家id 店铺id
fields field_list shop_id,cat_name 店铺类目字段

*返回内容示例



215. 获取店铺签约物流详情(shop.dlycorp.getinfo)

215.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 1 物流公司编号id
corp_id int required 1 物流公司编号id
fields field_list corp_id,corp_code,corp_name corp_id,corp_code,corp_name,shop_id 获取指定字段

*返回内容示例



216. 获取店铺签约物流(shop.dlycorp.getlist)

216.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int int 1 店铺id
corp_id int 1 物流公司编号id
fields field_list corp_id,corp_code,corp_name corp_id,corp_code,corp_name,shop_id 获取指定字段
page_no int 分页当前页数,默认为1
page_size int int 500 分页每页条数(1<=size<=1000)
order_by int order_sort asc 排序方式

*返回内容示例



217. 店铺保存签约的物流公司(shop.dlycorp.save)

217.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 1 物流公司编号id
corp_id int required 1 物流公司编号id

*返回内容示例



218. 店铺解除被签约的物流公司(shop.dlycorp.remove)

218.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 1 物流公司编号id
corp_id int required 1 物流公司编号id

*返回内容示例



219. 店铺申请类目保存(shop.apply.cat.save)

219.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int int required 1 店铺id
cat_id string required 1 申请的类目ids
apply_reason string required 商家申请类目的原因

*返回内容示例



220. 获取店铺申请的类目列表(shop.apply.cat.getlist)

220.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int int required 1 店铺id
page_no int 分页当前页数,默认为1
page_size int int 500 分页每页条数(1<=size<=1000)
orderBy int apply_id desc 排序
fields field_list 获取指定字段

*返回内容示例



221. 店铺删除类目申请(shop.apply.cat.remove)

221.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
apply_id int int required 1 申请编号
shop_id int int required 1 店铺id

*返回内容示例



222. 获取店铺申请的类目(shop.apply.cat.get)

222.1. 店铺相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int int required 1 店铺id
cat_id int int required 类目id

*返回内容示例



223. 获取过期促销id(promotion.overdue.get)

223.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
end_time string required 活动结束时间
check_status string required 活动状态
fields field_list 需要的字段
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认20条

*返回内容示例



224. 获取单条促销信息详情(promotion.promotion.get)

224.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
promotion_id int 促销表id
platform string pc 促销规则应用平台

*返回内容示例



225. 根据多条促销ID,获取促销标签(promotion.promotion.list.tag)

225.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
promotion_id string required 促销表id
platform string pc 促销规则应用平台

*返回内容示例



226. 添加优惠券数据(promotion.coupon.add)

226.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
coupon_id int 优惠券id
coupon_name string 优惠券名称
coupon_status int 优惠券状态
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
orderBy string 排序,默认created_time asc

*返回内容示例



227. 更新优惠券信息(promotion.coupon.update)

227.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
coupon_id int 优惠券id

*返回内容示例



228. 删除单条优惠券信息(promotion.coupon.delete)

228.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺ID必填
coupon_id int required 优惠券ID必填

*返回内容示例



229. 获取单条优惠券数据(promotion.coupon.get)

229.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
coupon_id int 优惠券id
coupon_itemList string 优惠券的商品

*返回内容示例



230. 获取指定店铺的优惠券列表(promotion.coupon.list)

230.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
fields field_list 需要的字段
orderBy string 排序,默认created_time asc
shop_id int required 店铺ID,user_id和shop_id必填一个
coupon_id int 优惠券id
coupon_name string 优惠券名称
coupon_status int 优惠券状态
is_valid int 可用优惠券
is_cansend int 可领取优惠券
platform int 优惠券适用平台

*返回内容示例



231. 生成优惠券号码(promotion.coupon.gencode)

231.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
grade_id int required 用户等级id
coupon_id int required 优惠券id
gen_quantity int required 1 生成数量
old_quantity int 0 原有此优惠券数量

*返回内容示例



232. 使用优惠券促销(promotion.coupon.use)

232.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
coupon_code int required 优惠券编码
mode string 购物模式
platform string 平台

*返回内容示例



233. 应用优惠券促销(promotion.coupon.apply)

233.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
coupon_code int required 促销表id
cartItemsInfo string required 店铺有效的item_id,totalprice信息

*返回内容示例



234. 获取指定优惠券促销商品列表(promotion.couponitem.list)

234.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
coupon_id int required
page_no int
page_size int
orderBy string
fields field_list

*返回内容示例



235. 根据优惠券ID,获取优惠券列表(promotion.coupon.list.byid)

235.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
coupon_id string required 1,2,3 优惠券id
fields field_list required coupon_id,coupon_name 需要的字段

*返回内容示例



236. 取消单条优惠券促销(promotion.coupon.cancel)

236.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺ID必填
coupon_id int required 优惠券促销ID必填

*返回内容示例



237. 更新优惠券数量(promotion.coupon.updateCouponQuantity)

237.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
is_valid string required 优惠券状态
shop_id int required 店铺ID必填
coupon_id int required 优惠券ID必填

*返回内容示例



238. 添加满减促销数据(promotion.fullminus.add)

238.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
fullminus_name string required 满减促销名称
fullminus_status int 满减促销状态

*返回内容示例



239. 更新满减促销数据(promotion.fullminus.update)

239.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
fullminus_id int required 满减促销id
fullminus_name string required 满减促销名称
fullminus_status int 满减促销状态

*返回内容示例



240. 删除单条满减促销信息(promotion.fullminus.delete)

240.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺ID必填
fullminus_id int required 满减促销ID必填

*返回内容示例



241. 获取单条满减促销数据(promotion.fullminus.get)

241.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
fullminus_id int 满减促销id
fullminus_itemList string 满减促销的商品

*返回内容示例



242. 获取多条满减促销列表(promotion.fullminus.list)

242.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
fields field_list 需要的字段
orderBy string 排序,默认created_time asc
shop_id int required 店铺ID
fullminus_id int 满减促销id
fullminus_name string 满减促销名称
fullminus_status int 满减促销状态
is_valid int 可用满减
platform int 满减促销适用平台

*返回内容示例



243. 满减促销规则应用(promotion.fullminus.apply)

243.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
fullminus_id int required integer 满减促销表id
promotion_id int required integer 促销关联表id
forPromotionTotalPrice float 符合应用促销的商品总价

*返回内容示例



244. 获取多条满减促销商品列表(promotion.fullminusitem.list)

244.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
fullminus_id int required 满减促销id
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
orderBy string 排序,默认created_time asc
fields field_list 需要的字段

*返回内容示例



245. 取消单条满减促销(promotion.fullminus.cancel)

245.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺ID必填
fullminus_id int required 满减促销ID必填

*返回内容示例



246. 添加满折促销数据(promotion.fulldiscount.add)

246.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
fulldiscount_id int 满折促销id
fulldiscount_name string 满折促销名称
fulldiscount_status int 满折促销状态
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
orderBy string 排序,默认created_time asc

*返回内容示例



247. 更新满折促销数据(promotion.fulldiscount.update)

247.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
fulldiscount_id int 满折促销id

*返回内容示例



248. 删除单条满折促销信息(promotion.fulldiscount.delete)

248.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺ID必填
fulldiscount_id int required 满折促销ID必填

*返回内容示例



249. 获取单条满折促销数据(promotion.fulldiscount.get)

249.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
fulldiscount_id int 满折促销id
fulldiscount_itemList string 满折促销的商品

*返回内容示例



250. 获取多条满折促销列表(promotion.fulldiscount.list)

250.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
fields field_list 需要的字段
orderBy string 排序,默认created_time asc
shop_id int required 店铺ID
fulldiscount_id int 满折促销id
fulldiscount_name string 满折促销名称
fulldiscount_status int 满折促销状态
is_valid int 是否生效的满折促销
platform int 满折促销适用平台

*返回内容示例



251. 满折促销规则应用(promotion.fulldiscount.apply)

251.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
fulldiscount_id int required integer 满折促销表id
promotion_id int required integer 促销关联表id
forPromotionTotalPrice float 符合应用促销的商品总价

*返回内容示例



252. 获取多条满折促销商品列表(promotion.fulldiscountitem.list)

252.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
fulldiscount_id int required 满折促销id
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
orderBy string 排序,默认created_time asc
fields field_list 需要的字段

*返回内容示例



253. 取消单条满折促销(promotion.fulldiscount.cancel)

253.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺ID必填
fulldiscount_id int required 满折促销ID必填

*返回内容示例



254. 添加免邮数据(promotion.freepostage.add)

254.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
freepostage_id int 免邮id
freepostage_name string 免邮名称
freepostage_status int 免邮状态
condition_type string in:money,quantity money或者quantity 免邮规则类型
limit_money string required_if:condition_type,money 按金额
limit_quantity string required_if:condition_type,quantity integer 按数量
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
orderBy string 排序,默认created_time asc

*返回内容示例



255. 更新免邮信息(promotion.freepostage.update)

255.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int integer 会员ID,user_id和shop_id必填一个
shop_id int integer 店铺ID,user_id和shop_id必填一个
freepostage_id int required integer 免邮id
condition_type string in:money,quantity money或者quantity 免邮规则类型
limit_money string required_if:condition_type,money 按金额
limit_quantity string required_if:condition_type,quantity integer 按数量

*返回内容示例



256. 删除单条免邮信息(promotion.freepostage.delete)

256.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺ID必填
freepostage_id int required 免邮ID必填

*返回内容示例



257. 获取单条免邮数据(promotion.freepostage.get)

257.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
freepostage_id int 免邮id
freepostage_itemList string 免邮的商品

*返回内容示例



258. 获取多条免邮列表(promotion.freepostage.list)

258.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
fields field_list 需要的字段
orderBy string 排序,默认created_time asc
shop_id int required 店铺ID,user_id和shop_id必填一个
freepostage_id int 免邮id
freepostage_name string 免邮名称
freepostage_status int 免邮状态
is_valid int 可用免邮
is_cansend int 可领取免邮
platform int in:pc,wap 免邮适用平台

*返回内容示例



259. 免邮促销规则应用(promotion.freepostage.apply)

259.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
freepostage_id int required integer 促销表id
promotion_id int required integer 促销关联表id
forPromotionTotalPrice float 符合应用促销的商品总价
forPromotionTotalQuantity int 符合应用促销的商品总数量

*返回内容示例



260. 获取多条免邮促销商品列表(promotion.freepostageitem.list)

260.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
freepostage_id int required 优惠券促销id
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
orderBy string freepostage_id asc
fields field_list 需要的字段

*返回内容示例



261. 添加X件Y折促销数据(promotion.xydiscount.add)

261.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
xydiscount_name string required X件Y折促销名称
xydiscount_status int X件Y折促销状态

*返回内容示例



262. 更新X件Y折促销数据(promotion.xydiscount.update)

262.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
xydiscount_id int required X件Y折促销id
xydiscount_name string required X件Y折促销名称
xydiscount_status int X件Y折促销状态

*返回内容示例



263. 删除单条X件Y折促销信息(promotion.xydiscount.delete)

263.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺ID必填
xydiscount_id int required X件Y折促销ID必填

*返回内容示例



264. 获取单条X件Y折促销数据(promotion.xydiscount.get)

264.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
xydiscount_id int X件Y折促销id
xydiscount_itemList string X件Y折促销的商品

*返回内容示例



265. 获取多条X件Y折促销列表(promotion.xydiscount.list)

265.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
fields field_list 需要的字段
orderBy string 排序,默认created_time asc
shop_id int required 店铺ID,user_id和shop_id必填一个
xydiscount_id int X件Y折促销id
xydiscount_name string X件Y折促销名称
xydiscount_status int X件Y折促销状态
is_valid int 是否生效的X件Y折促销
platform int X件Y折促销适用平台

*返回内容示例



266. X件Y折促销规则应用(promotion.xydiscount.apply)

266.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
xydiscount_id int required integer X件Y折促销表id
promotion_id int required integer 促销关联表id
forPromotionTotalPrice float 符合应用促销的商品总价
forPromotionTotalQuantity int 符合应用促销的商品总数量

*返回内容示例



267. 获取多条xy促销商品列表(promotion.xydiscountitem.list)

267.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
xydiscount_id int required xy促销id
page_no int 分页当前页数,默认为1
page_size int 每页数据条数,默认10条
orderBy string xydiscount_id asc
fields field_list 需要的字段

*返回内容示例



268. 取消单条X件Y折促销(promotion.xydiscount.cancel)

268.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
shop_id int required 店铺ID必填
xydiscount_id int required X件Y折促销ID必填

*返回内容示例



269. 添加组合促销促销数据(promotion.package.add)

269.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本
  • 业务参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
user_id int 会员ID,user_id和shop_id必填一个
shop_id int 店铺ID,user_id和shop_id必填一个
package_name string required 组合促销促销名称
package_status int 组合促销促销状态
package_item_list array package的list[item_id=>[item_id=>id, package_price=>price]]

*返回内容示例



270. 更新组合促销促销数据(promotion.package.update)

270.1. 促销相关API

  • 接口参数

  • 支持的版本号:v1,

  • 系统参数
字段 标题 数据类型 验证条件 示例值 默认值 详细说明
method API的方法名 string required trade.get null 标识请求的是哪个API
format 返回数据格式 string required json json 返回数据是json格式的,目前只支持json
v 版本号 string required v1 null 标识该接口的版本