接口 operators.depot.list

接口说明

获取运营商仓库列表,支持按仓库名称搜索和分页查询,返回仓库详细信息及统计数据

业务参数

参数名称 类型 是否必须 说明
page number N 页码,默认 1
pageSize number N 每页数量,默认 10
criteria object N 查询条件
sort string N 排序规则

criteria 对象说明

参数名称 类型 是否必须 说明
Name string N 仓库名称,支持模糊搜索

请求示例

{
  "page": 1,
  "pageSize": 10,
  "criteria": {
    "Name": "中心仓库"
  },
  "sort": "-CreateAt"
}

返回示例

{
  "error_code": 0,
  "error_msg": "SUCCESS",
  "sub_error_code": null,
  "sub_error_msg": null,
  "data": {
    "total": 1,
    "per_page": 10,
    "current_page": 1,
    "last_page": 1,
    "from": 0,
    "to": 10,
    "data": [
      {
        "OID": "660641dae4f5df001010f240",
        "Name": "仓库1",
        "PrincipalAccountID": "5d25404ad66b8d0011cfab72",
        "Remarks": "",
        "Province": "北京市",
        "City": "北京市",
        "District": "石景山区",
        "Address": "1",
        "Phone": "1",
        "IsDefault": false,
        "CreateAt": 1725849188,
        "UpdatedAt": 1725849188,
        "id": "66de5e64db53d900102d022c",
        "PrincipalAccountName": "lsy",
        "TotalSpecQty": 10,
        "TotalQty": -15,
        "TotalPrice": -1485,
        "TotalQtyWarning": 10
      }
    ]
  }
}

返回字段说明

字段名称 类型 说明
error_code number 错误码,0 表示成功
error_msg string 错误信息
sub_error_code number 子错误码
sub_error_msg string 子错误信息
data object 返回数据
data.total number 总记录数
data.per_page number 每页数量
data.current_page number 当前页码
data.last_page number 最后一页页码
data.from number 起始位置
data.to number 结束位置
data.data array 仓库列表
data.data[].id string 仓库 ID
data.data[].OID string 运营商 ID
data.data[].Name string 仓库名称
data.data[].Province string 省份
data.data[].City string 城市
data.data[].District string 区县
data.data[].Address string 详细地址
data.data[].Phone string 联系电话
data.data[].PrincipalAccountID string 负责人账号 ID
data.data[].PrincipalAccountName string 负责人姓名
data.data[].Remarks string 备注信息
data.data[].IsDefault boolean 是否默认仓库
data.data[].TotalSpecQty number 商品品类总数(SKU 数量)
data.data[].TotalQty number 商品总数量(库存总数,可能为负数)
data.data[].TotalPrice number 库存总价值,单位:分(可能为负数)
data.data[].TotalQtyWarning number 库存预警商品数量
data.data[].CreateAt number 创建时间,Unix 时间戳
data.data[].UpdatedAt number 更新时间,Unix 时间戳

错误代码

error_msg 描述
INVALID_PARAMS 参数格式错误
ERR_DEPOT_QUERY_FAIL 仓库查询失败
Copyright © YoPoint.com 2019 all right reserved,powered by Gitbook该文件修订时间: 2025-10-10 22:13:32

results matching ""

    No results matching ""