开发者中心
黄色仓库提供200+标准RESTful API接口,完善的多语言SDK和详尽的技术文档。无论您使用何种技术栈,都能快速完成系统集成。API网关支持每秒10,000+并发请求,P99延迟低于50ms。
📖
API参考文档
200+接口的完整参数说明、请求示例和响应格式。支持在线调试,一键生成多语言请求代码。
💻
多语言SDK
官方维护的Java、Python、Node.js、Go、PHP、C# SDK,封装认证、重试、分页等通用逻辑。
🔔
Webhook事件
50+事件类型的实时推送,包括库存变动、订单状态更新、物流轨迹更新等关键业务事件。
快速开始 - 查询库存
import requests
# 查询SKU库存
url = "https://api.lwphg.cn/v1/inventory"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
}
params = {
"sku": "SKU-10086",
"warehouse_id": "WH-001"
}
response = requests.get(url, params=params, headers=headers)
data = response.json()
print(f"可用库存: {data['available_qty']}")
print(f"锁定库存: {data['locked_qty']}")
print(f"安全库存: {data['safety_stock']}")
# 输出: 可用库存: 3420, 锁定库存: 180, 安全库存: 500
import com.lwphg.cn.sdk.WmsClient;
import com.lwphg.cn.sdk.model.InventoryQuery;
// 初始化客户端
WmsClient client = new WmsClient("YOUR_API_KEY");
// 查询库存
InventoryQuery query = InventoryQuery.builder()
.sku("SKU-10086")
.warehouseId("WH-001")
.build();
InventoryResult result = client.inventory().query(query);
System.out.println("可用库存: " + result.getAvailableQty());
System.out.println("锁定库存: " + result.getLockedQty());
const { WmsClient } = require('@lwphg.cn/sdk');
// 初始化客户端
const client = new WmsClient({ apiKey: 'YOUR_API_KEY' });
// 查询库存
async function queryInventory() {
const result = await client.inventory.query({
sku: 'SKU-10086',
warehouseId: 'WH-001'
});
console.log(`可用库存: ${result.availableQty}`);
console.log(`锁定库存: ${result.lockedQty}`);
}
queryInventory();
curl -X GET "https://api.lwphg.cn/v1/inventory?sku=SKU-10086&warehouse_id=WH-001" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
# 响应示例:
# {
# "code": 200,
# "data": {
# "sku": "SKU-10086",
# "warehouse_id": "WH-001",
# "available_qty": 3420,
# "locked_qty": 180,
# "safety_stock": 500,
# "last_updated": "2024-06-15T14:30:00Z"
# }
# }
核心API接口列表
| 方法 | 端点 | 描述 | 认证 |
|---|---|---|---|
| GET | /v1/inventory | 查询库存信息 | API Key |
| POST | /v1/inbound | 创建入库单 | API Key |
| POST | /v1/outbound | 创建出库单 | API Key |
| GET | /v1/orders/{id} | 查询订单详情 | API Key |
| GET | /v1/tracking/{waybill} | 查询物流轨迹 | API Key |
| POST | /v1/webhooks | 注册Webhook | API Key |
| GET | /v1/warehouses | 获取仓库列表 | API Key |
| PUT | /v1/inventory/transfer | 库存调拨 | API Key |
常见错误码
| 错误码 | HTTP状态 | 描述 | 解决方案 |
|---|---|---|---|
| AUTH_001 | 401 | API Key无效或已过期 | 检查API Key是否正确,或重新生成 |
| RATE_001 | 429 | 请求频率超限 | 降低请求频率或升级套餐 |
| INV_001 | 400 | 库存不足 | 检查可用库存量后重试 |
| ORD_002 | 404 | 订单不存在 | 确认订单号是否正确 |
| SYS_500 | 500 | 系统内部错误 | 请稍后重试或联系技术支持 |