跳到主要内容

查询库存状态

系统相关界面​

"界面路径：【库存】----【库存状态】"

请求地址​

环境服务地址(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
stock.api.status.query
必填

请求参数​

参数名
类型
描述
必填
默认值
itemType
integer
商品类型；0-组合商品（仅单品），1-套件，2-组合装，3-加工
0
mainOuterId
string
主商家编码（与规格商家编码二选一必填）
skuOuterId
string
规格商家编码（与主商家编码二选一必填）
stockStatuses
integer
库存状态(1-正常，2-警戒，3-无货，4-超卖，6-有货)
warehouseId
long
仓库ID
pageSize
integer
分页数量，最大100条
pageNo
integer
当前页
created
string
商品创建时间，格式:yyyy-MM-dd HH:mm:ss
modified
string
商品更新时间，格式:yyyy-MM-dd HH:mm:ss
startStockModified
string
库存修改开始时间，格式:yyyy-MM-dd HH:mm:ss
endStockModified
string
库存修改结束时间，格式:yyyy-MM-dd HH:mm:ss
brands
string
品牌名称，多个以逗号隔开
relationInfoFields
string
关联字段，多个用逗号隔开，指定查询关联字段信息会在relationInfo中返回， publicStock：公有可用数

请求示例​

示例一：

{
  "stockStatuses": integer,
  "warehouseId": long,
  "pageSize": integer,
  "pageNo": long
}

响应参数​

参数名
类型
描述
必填
msg
string
返回消息
必填
traceId
string
流水id
必填
total
long
返回总数(仅在请求参数pageNo传1时才会返回)
必填
stockStatusVoList
array
数据列表
必填
mainOuterId
string
主商家编码
必填
outerId
string
平台商家编码
必填
skuOuterId
String
平台规格商家编码
必填
title
string
商品名称
必填
shortTitle
string
商品简称
必填
stockStatus
integer
库存状态（1-正常，2-警戒，3-无货，4-超卖，6-有货）
必填
totalAvailableStockSum
long
当前商品的实际总库存，实际总库存=实际锁定数+实际可用数+次品数
必填
totalLockStock
long
实际锁定数
必填
totalAvailableStock
long
实际可用数
必填
totalDefectiveStock
long
次品数
必填
sellableNum
long
可售数
必填
allocateNum
long
调拨在途数
必填
purchaseNum
long
采购在途数
必填
onTheWayNum
Long
销退在途数
必填
refundStock
Long
销退暂存区库存
必填
purchaseStock
Long
入库暂存区库存
必填
sysItemId
long
系统主商品ID
必填
itemBarcode
string
商品条形码
必填
picPath
string
商品图片
必填
sysSkuId
long
系统商品skuID
必填
skuBarcode
string
规格条形码
必填
propertiesName
string
商品规格属性
必填
skuPicPath
string
sku图片
必填
brand
string
品牌
必填
itemCategoryNames
string
商品分类
必填
cidName
string
商品类目
必填
sellingPrice
double
销售价
必填
purchasePrice
double
成本价
必填
marketPrice
double
市场价
必填
unit
string
单位
必填
place
string
产地
必填
supplierCodes
string
供应商编码 多个用,隔开
必填
supplierNames
string
供应商名 多个用,隔开
必填
wareHouseId
long
仓库ID（请求参数指定仓库时有效）
必填
stockModifiedTime
long
库存修改时间
必填
relationInfo
object
关联信息（公有可用数）
必填
publicStock
Long
公有可用数
必填

响应示例​

{
  "msg": "zhangsan",
  "traceId": "zhangsan",
  "total": 12345,
  "code": "zhangsan",
  "solution": "zhangsan",
  "subCode": "zhangsan",
  "stockStatusVoList": [
    {
      "supplierCodes": "zhangsan",
      "marketPrice": 10000,
      "totalAvailableStock": 12345,
      "sysItemId": 12345,
      "skuPicPath": "zhangsan",
      "itemCategoryNames": "zhangsan",
      "shortTitle": "zhangsan",
      "totalLockStock": 12345,
      "purchasePrice": 10000,
      "title": "zhangsan",
      "allocateNum": 12345,
      "totalAvailableStockSum": 12345,
      "supplierNames": "zhangsan",
      "sellingPrice": 10000,
      "totalDefectiveStock": 12345,
      "sellableNum": 12345,
      "stockStatus": 1,
      "wareHouseId": 12345,
      "place": "zhangsan",
      "brand": "zhangsan",
      "refundStock": 12345,
      "itemBarcode": "zhangsan",
      "propertiesName": "zhangsan",
      "picPath": "zhangsan",
      "sysSkuId": 12345,
      "mainOuterId": "zhangsan",
      "cidName": "zhangsan",
      "unit": "zhangsan",
      "stockModifiedTime": "@date",
      "outerId": "zhangsan",
      "purchaseNum": 12345,
      "skuBarcode": "zhangsan"
    }
  ],
  "subMsg": "zhangsan",
  "body": "zhangsan",
  "forbiddenField": "zhangsan"
}

异常示例​

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

错误码解释​

错误码错误信息解决方案
50库存状态不合法库存状态(1正常，2警戒，3,无货，4超卖)
20001页码为空或不符合规定页码的值不能为空，且不能小于1
20002页数为空或不符合规定页数的值不能为空，且不能小于1
20019页数不能超过100页数不能超过100
20307商品类型不合法请检查该参数的值是否规范
20305仓库ID不能为空或小于0请检查该参数的值是否为空或小于0