跳到主要内容

查询商品列表

接口描述​

查询商品列表，支持获取商品列表，包括普通商品，套件商品、组合商品、加工商品

系统相关界面​

"界面路径：【商品】----【商品档案】"

请求地址​

环境服务地址(HTTP/HTTPS)
V2正式环境（推荐）https://gw.superboss.cc/router

2022年4月1日以后申请的APP Key，统一使用V2正式环境的请求地址：https://gw.superboss.cc/router

公共参数​

调用任何一个API都必须传入的参数，目前支持的公共参数有：

参数名称参数类型是否必须参数描述
methodstring是API接口名称
appKeystring是分配给应用的AppKey
timestampstring是时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟
formatstring否响应格式。默认为json格式，可选值：json
versionstring是API协议版本 可选值：1.0
sign_methodstring否签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。
signstring是签名
sessionstring是授权会话信息 （即access_token，由系统分配）

请求头​

参数名
类型
描述
必填
Content-Type
string
application/x-www-form-urlencoded
必填

API接口地址​

参数名
类型
描述
必填
method
string
item.list.query
必填

请求参数​

参数名
类型
描述
必填
默认值
activeStatus
integer
数据的可用状态，0表示停用，1表示启用
startModified
string
起始的修改时间 , 示例：2000-01-01 00:00:00
endModified
string
结束的修改时间, 示例：2000-01-01 00:00:00
pageNo
integer
页码 取值范围:大于零的整数
1
pageSize
integer
每页条数 取值范围:大于零的整数;最大值：200；
40
type
integer
商品类型 0-普通商品（含组合、加工商品）且不是虚拟商品 1-套件（含纯套件、sku套件） 3-普通商品（含组合、加工商品）且是虚拟商品 6-仅加工商品 7-普通商品（不含组合、加工商品）且不是虚拟商品 8-非包材商品 9-仅组合商品 10-普通商品（含组合、加工、虚拟商品）
orderBy
string
排序方式 示例 modified:desc ， 选值：modified；
created:desc
whetherReturnPurchase
integer
是否返回采购链接 0.否 1.是
0

请求示例​

示例一：

{
  "pageNo":integer,
  "pageSize":integer
}

响应参数​

参数名
类型
描述
必填
msg
string
返回消息
必填
traceId
string
流水id
必填
total
long
返回总数
必填
code
string
返回码
必填
solution
string
解决方案
必填
body
string
返回内容
必填
items
array
数据列表
必填
outerId
string
平台商家编码（主商家编码）
必填
sysItemId
long
系统主商品ID
必填
title
string
商品名称
必填
shortTitle
string
商品简称
必填
barcode
string
商品条形码
必填
type
string
商品类型 0-普通（含虚拟商品，用 isVirtual字段描述
组合装商品） 1-sku套件 2-纯套件 3-包材商品
typeTag
integer
基于type下的二级分类 type=0 : 0-正常商品，1-sku加工商品，2-纯加工商品 3-含sku组合装商品 4-不含sku组合装商品
必填
activeStatus
integer
数据的可用状态，0表示停用，1表示启用
必填
isVirtual
integer
是否是虚拟商品，是：1，否：0
必填
catId
string
商品类目属性ID
必填
picPath
string
商品图片URL
必填
purchasePrice
double
成本价（单位：元），示例：100.99
必填
priceOutput
double
销售价（单位：元），示例：100.99
必填
weight
double
商品重量（单位：Kg）， 示例：0.05
必填
hasSupplier
integer
是否关联供应商 是：1 否：0
必填
makeGift
boolean
是否标记为赠品
必填
unit
string
商品单位 ，示例：件、箱
必填
x
double
长（单位：cm） ，示例：0.01
必填
y
double
宽（单位：cm） ，示例：0.01
必填
z
double
高（单位：cm） ，示例：0.01
必填
listTime
long
上架日期
必填
isSkuItem
integer
是否是含有sku的商品，是：1，否：0
必填
skus
array
关联的SKU信息列表
必填
propertiesName
string
规格真正的属性，以逗号分隔
必填
skuOuterId
string
平台规格商家编码
必填
sysItemId
long
系统主商品ID
必填
sysSkuId
long
系统商品skuID
必填
shortTitle
string
规格简称
必填
propertiesAlias
string
规格别名
必填
barcode
string
规格条形码
必填
weight
double
重量（单位：Kg），示例：0.05
必填
purchasePrice
double
成本价（单位：元），示例：100.99
必填
priceOutput
double
销售价（单位：元），示例：100.99
必填
unit
string
单位
必填
skuPicPath
string
sku的图片地址
必填
hasSupplier
integer
是否关联供应商 是：1 否：0
必填
makeGift
boolean
是否标记为赠品
必填
activeStatus
integer
规格的可用状态，0表示停用，1表示启用
必填
created
long
创建时间
必填
modified
long
更新时间
必填
x
double
长（单位：cm） ，示例：0.01
必填
y
double
宽（单位：cm） ，示例：0.01
必填
z
double
高（单位：cm） ，示例：0.01
必填
boxnum
int
箱规
必填
sellerCats
array
必填
name
string
分类名称
必填
cid
long
分类ID
必填
fullName
string
分类全路径名称
必填
parentCid
long
父级分类ID
必填
classify
必填
id
long
类目ID
必填
name
string
类目名称
必填
fullName
string
类目全路径名称
必填
parentId
long
父级类目ID
必填
brand
string
规格品牌名称
必填
standard
string
执行标准
必填
safekind
string
安全类别
必填
marketPrice
double
规格市场价（单位：元）
必填
otherPrice1
double
规格其他价格1（单位：元）
必填
otherPrice2
double
规格其他价格2（单位：元）
必填
otherPrice3
double
规格其他价格3（单位：元）
必填
customAttribute
array
自定义属性信息，格式 ：[{"definedValue":"1111","definedKey":"自定义字段名称"}]
必填
definedKey
string
属性名称
必填
definedValue
string
属性值
必填
created
long
创建时间
必填
modified
long
更新时间
必填
purchaseLinkSkuList
array
采购链接
必填
outerId
string
商品的商家编码
必填
skuOuterId
string
规格商家编码
必填
sysItemId
long
系统商品编码
必填
sysSkuId
long
系统规格ID
必填
purchaseLinkList
list
采购链接详情列表
必填
defaultFlag
boolean
默认标识
必填
link
string
链接
必填
source
string
来源
必填
sourceName
string
来源名称
必填
boxnum
int
箱规
必填
sellerCats
array
分类列表
必填
id
long
分类id，示例：94385
必填
cid
long
分类编码，示例：-1
必填
name
string
分类名称
必填
fullName
string
分类全路径名称 ，示例： ["百货1","服装1","男士服饰1"]
必填
classify
object
类目
必填
id
long
类目ID
必填
name
string
类目名称
必填
parentId
long
父级类目ID
必填
fullName
string
类目全路径名称，示例：["百货1","服装1","男士服饰1"]
必填
brand
string
商品品牌名称
必填
standard
string
执行标准
必填
safekind
string
安全类别
必填
marketPrice
double
市场价（单位：元）
必填
otherPrice1
double
其他价格1（单位：元）
必填
otherPrice2
double
其他价格2（单位：元）
必填
otherPrice3
double
其他价格3（单位：元）
必填
customAttribute
array
规格自定义属性信息，格式 ：[{"definedValue":"1111","definedKey":"自定义字段名称"}]
必填
definedKey
string
属性名称
必填
definedValue
string
属性值
必填
remark
string
商品备注
必填

响应示例​

{
  "msg": "zhangsan",
  "traceId": "zhangsan",
  "total": 12345,
  "code": "zhangsan",
  "solution": "zhangsan",
  "subCode": "zhangsan",
  "subMsg": "zhangsan",
  "body": "zhangsan",
  "forbiddenField": "zhangsan",
  "items": [
    {
      "typeTag": 1,
      "created": "zhangsan",
      "sysItemId": 12345,
      "weight": 10000,
      "shortTitle": "zhangsan",
      "title": "zhangsan",
      "type": "zhangsan",
      "isSkuItem": 1,
      "picPath": "zhangsan",
      "catId": "zhangsan",
      "unit": "zhangsan",
      "activeStatus": 1,
      "hasSupplier": 1,
      "modified": "zhangsan",
      "outerId": "zhangsan",
      "makeGift": true,
      "isVirtual": 1,
      "items": [
        {
          "created": "zhangsan",
          "sysItemId": 12345,
          "skuPicPath": "zhangsan",
          "weight": 10000,
          "shortTitle": "zhangsan",
          "propertiesName": "zhangsan",
          "propertiesAlias": "zhangsan",
          "sysSkuId": 12345,
          "unit": "zhangsan",
          "activeStatus": 1,
          "hasSupplier": 1,
          "modified": "zhangsan",
          "makeGift": true,
          "barcode": "zhangsan",
          "skuOuterId": "zhangsan"
        }
      ],
      "barcode": "zhangsan"
    }
  ]
}

异常示例​

{
    "code": "25",
    "msg": "服务方法(item.list.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}

错误码解释​

错误码错误信息解决方案
20001页码为空或不符合规定页码的值不能为空，且不能小于1
20002页数为空或不符合规定页数的值不能为空，且不能小于1或超过200
20004排序方式不正确排序方式的值不能为空，且只能为desc或asc
20109系统商品状态不正确请检查系统商品状态是否填写规范，其中 0-表示停用，1-表示启用
20103查询商品列表有误请根据返回错误信息进行处理
50只能选择[0,1,3,6,7,8,9,10]的其中一位商品类型数值请检查该参数的值是否规范