1. 仓库模块API
API URL
post {HTTP(S)地址}/api/{version}/warehouse
1.1. 仓库列表查询列表
1.1.1. SERVICE_TYPE
QUERY_WAREHOUSE_LIST
1.1.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| page | Y | Number | 1 | 页码，默认1 |
| pageSize | Y | Number | 50 | 每页条数.不超过200条; 默认100 |
| status | N | String | LOCK,UNLOCK | 仓库启停状态 |
| name | N | String | Warehouse | 仓库名称 |
1.1.3. 返回参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | 错误码 |
| errorMsg | Y | String | “输入参数不对” | 业务错误信息 |
| state | Y | String | success | 请求结果 |
| total | Y | Number | 100 | 总条数 |
| result | Y | List<Warehouse> | 仓库信息,详情查看下表 |
Warehouse(仓库)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| id | Y | 仓库id | 1001 | 仓库id |
| name | Y | String | 马来仓库 | 仓库名称，最大50字符 |
| kind | Y | String | SHIP, TRANSFER, COMPLEX | 仓库类型，发货仓，中转仓，综合仓 |
| providerName | Y | String | 百世 | 仓库服务商条码 |
| code | Y | String | G_01 | 对应WMS开启仓库code |
| codeName | Y | String | 百世-01 | 对应WMS开启仓库名称 |
| country | Y | String | US，JP | 仓库对应国家枚举 |
| timezoneId | Y | String | Asia/Shanghai | 仓库所在时区 |
| status | N | String | LOCK,UNLOCK | 仓库启停状态 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/warehouse' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_WAREHOUSE_LIST"' \
--form 'bizParam="{
\"page\": 1,
\"pageSize\":3
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="502e6339f3e2ecb2cd6f8823ec764642"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"country\":\"CN\",\"id\":13338,\"isDeleted\":0,\"kind\":\"SHIP\",\"name\":\"pm国内集货仓\",\"providerName\":\"自定义 （custom）\",\"status\":\"UNLOCK\",\"timezoneId\":\"Asia/Shanghai\"},{\"code\":\"136\",\"codeName\":\"印尼2仓\",\"country\":\"US\",\"id\":13337,\"isDeleted\":0,\"kind\":\"SHIP\",\"name\":\"易达云仓\",\"providerName\":\"易达云仓\",\"status\":\"UNLOCK\",\"timezoneId\":\"America/Los_Angeles\"},{\"code\":\"IDNXH01\",\"codeName\":\"IDNXH01\",\"country\":\"ID\",\"id\":13335,\"isDeleted\":0,\"kind\":\"COMPLEX\",\"name\":\"WH-TGR04\",\"providerName\":\"TA\",\"status\":\"UNLOCK\",\"timezoneId\":\"Asia/Jakarta\"}],\"state\":\"success\",\"total\":1197}",
"requestId": "6cfb99c8-29bc-4682-b954-4ff0852db7d1"
}