仓库管理接口

1. 获取仓库列表

请求地址

GET /warehouse

参数说明

仓库查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录

返回结果

{
    "offset": 0,
    "total": 0,
    "results": [
        {
            "code": "1001",
            "name": "北京仓",
            "isShared": false,
            "isCheckLock": 0,
            "disabled": false,
            "ownCompanyName": "测试公司",
            "ownCompanyCode": "3725581",
            "ownCompanyId": "7024"
        }
    ],
    "meta": {}
}

参数	说明
offset	当前结果对于首条结果的偏移量，指定分页查询时不为0
total	所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0
results	符合查询条件的仓库详情集合
meta	其他信息

2. 创建仓库

请求地址

POST /warehouse

请求示例

{
    "ownCompanyCode":"112233",
    "code":"36668",
    "name":"仓库",
    "isShared":true
}

参数说明

参数	是否必须	说明
Code	是	仓库编码
Name	是	仓库名称
ownCompanyCode	是	所属公司
isShared	否	是否共享

返回结果

{}

对于成功新增的请求，该接口仅返回HTTP 200 OK

3. 更新仓库

请求地址

PUT /warehouse/{code}
POST /warehouse/{code}/put

对于不支持PUT请求的网络环境，请尝试使用备份的POST请求地址

请求示例

{
    "ownCompanyCode":"112233",
    "code":"36668",
    "name":"仓库",
    "isShared":true
}

参数说明

参数	是否必须	说明
Code	是	仓库编码
Name	是	仓库名称
ownCompanyCode	是	所属公司
isShared	否	是否共享

返回结果

{}

对于成功更新的请求，该接口仅返回HTTP 200 OK

4. 删除仓库

请求地址

DELETE /warehouse/{code}
POST /warehouse/{code}/delete

对于不支持DELETE请求的网络环境，请尝试使用备份的POST请求地址

返回结果

{}

对于成功删除的请求，该接口仅返回HTTP 200 OK

5. 设置仓库的可用状态

请求地址

PUT /warehouse/{code}/state
POST /warehouse/{code}/state/put

对于不支持PUT请求的网络环境，请尝试使用备份的POST请求地址

请求示例

{
    "enable":false
}

参数说明

参数	是否必须	说明
enable	是	是否禁用（false：禁用、true：启用）

返回结果

{}

对于成功删除的请求，该接口仅返回HTTP 200 OK

附录

1. 支持的查询参数

如无特别说明，下列操作对于查询实体对象中的任意属性均适用。使用时只需将其追加至请求的querystring中即可。对实体对象中不存在的属性进行操作将会得到不可预期的结果。

分页

skip={数字} 跳过指定条数的记录数

take={数字}取出指定条数的记录数（注：最大值为1500，即单页最多返回1500条数据）

include=total 需要返回记录总数

排序

orderBy=[-]{属性名称},[-]{属性名称} 返回结果按指定属性排序，在名称前加”-“表示按倒序排序。多个属性的排序可使用逗号分隔。如：orderBy=-Id,Name,-Age

条件过滤

不等于

{属性名称}!={值} 如：Id!=1

大于等于

>{属性名称}={值} 如：>Id=1

大于

{属性名称}>={值} 如：Id>=1

小于

<{属性名称}={值} 如：<Id=1

小于等于

{属性名称}<={值} 如：Id<=1

In

{属性名称}In={值，值，值} 属性的值需包含在指定的集合中，如：IdIn=1,2,3

Between

{属性名称}Between={值，值} 属性的值需处于指定的区间之间，仅支持数字，如： IdBetween=1,3

字符串包含指定字符

{属性名称}Contains={值} 如：nameContains=abc

字符串以指定字符开头

{属性名称}StartsWith={值} 如：nameStartsWith=abc

字符串以指定字符结尾

{属性名称}EndsWith={值} 如：nameEndsWith=abc

2. 数据实体格式

1. 仓库数据对象格式

属性名称	说明
code	仓库编码
name	仓库名称
isShared	是否共享
isCheckLock	仓库是否被盘点单锁定
disabled	是否被禁用
ownCompanyName	所属公司名称
ownCompanyCode	所属公司编码
ownCompanyId	所属公司id