第9章:基础信息
9.1 获取仓库信息列表
9.1.1 接口说明
获取系统中所有可用的仓库信息列表,包括仓库编码、名称、地址、时区、截单时间等基础信息。
9.1.2 请求信息
- 接口地址:
GET /onixport/api/wms/warehouse/info - 请求方式:GET
- Content-Type:application/json
9.1.3 请求参数
无请求参数
9.1.4 响应参数
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Boolean | 是 | 请求是否成功 |
| errorCode | Integer | 否 | 错误码。当 success=true 时,该字段为 null;当 success=false 时,该字段有值 |
| errorMsg | String | 否 | 错误信息。当 success=true 时,该字段为 null;当 success=false 时,该字段有值 |
| result | Array | 否 | 仓库信息列表 |
| result[].warehouseCode | String | 是 | 仓库编码(唯一) |
| result[].warehouseName | String | 是 | 仓库名称 |
| result[].countryCode | String | 是 | 仓库所在地国家(ISO标准,如CN、US) |
| result[].state | String | 是 | 仓库所在地州/省二字码 |
| result[].city | String | 是 | 仓库所在地城市名称 |
| result[].address | String | 是 | 仓库所在地详细地址 |
| result[].zipCode | String | 是 | 仓库所在地邮编 |
| result[].timeZone | String | 是 | 仓库所在地时区 |
| result[].cutoffTime | String | 是 | 仓库每日截单时间(当地时间),格式:HH:mm:ss |
9.1.5 请求示例
GET /onixport/api/wms/warehouse/info
9.1.6 响应示例
成功响应
{
"success": true,
"errorCode": null,
"errorMsg": null,
"result": [
{
"warehouseCode": "W1",
"warehouseName": "LA Warehouse",
"countryCode": "US",
"state": "CA",
"city": "Los Angeles",
"address": "1234 Warehouse St",
"zipCode": "90001",
"timeZone": "America/Los_Angeles",
"cutoffTime": "17:00:00"
},
{
"warehouseCode": "W2",
"warehouseName": "NJ Warehouse",
"countryCode": "US",
"state": "NJ",
"city": "Newark",
"address": "5678 Distribution Ave",
"zipCode": "07102",
"timeZone": "America/New_York",
"cutoffTime": "17:00:00"
}
]
}
失败响应
{
"success": false,
"errorCode": 500,
"errorMsg": "服务器错误",
"result": null
}
9.1.7 错误码说明
| 错误码 | 说明 | 解决方案 |
|---|---|---|
| 500 | 服务器错误 | 稍后重试或联系技术支持 |
9.1.8 注意事项
1. 仓库编码(warehouseCode)是唯一标识,在创建出库订单等业务操作时需要用到
2. 截单时间(cutoffTime)为仓库所在地的当地时间,用于计算发货日期
3. 时区信息(timeZone)遵循 IANA 时区数据库标准