1. Warehouse API
API URL
post {HTTP(S)host} /api/{version}/warehouse
1.1. Query Warehouse list
1.1.1. SERVICE_TYPE
QUERY_WAREHOUSE_LIST
1.1.2. Request
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
page | Y | Number | 1 | Page number, default 1 |
pageSize | Y | Number | 50 | Number of records per page. no more than 200; Default is 100 |
status | N | String | LOCK,UNLOCK | Warehouse status |
name | N | String | Warehouse | Warehouse name |
1.1.3. Reponse
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
errorCode | Y | String | “DATA_INPUT_ERROR” | Error Code |
errorMsg | Y | String | “The input of Params is incorrect” | Business Error Messages |
state | Y | String | success | Response State |
total | Y | Number | 100 | Total num |
result | Y | List<Warehouse> | For warehouse information, see the following table for details |
Warehouse
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
id | Y | 仓库id | 1001 | Warehouse ID |
name | Y | String | Malay warehouse | Warehouse name, up to 50 characters |
kind | Y | String | SHIP, TRANSFER, COMPLEX | Warehouse type |
providerName | Y | String | 百世 | Warehouse service provider barcode |
code | Y | String | G_01 | Corresponding WMS open repository code |
codeName | Y | String | 百世-01 | Enable Warehouse for WMS name |
country | Y | String | US,JP | Warehouse Country |
timezoneId | Y | String | Asia/Shanghai | The time zone in which the warehouse is located |
status | N | String | LOCK,UNLOCK | Warehouse status |
Request:
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"'
Response:
{
"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"
}