开发者中心

黄色仓库提供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.pzcra.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.pzcra.cn.sdk.WmsClient;
import com.pzcra.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('@pzcra.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.pzcra.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注册WebhookAPI Key
GET/v1/warehouses获取仓库列表API Key
PUT/v1/inventory/transfer库存调拨API Key

常见错误码

错误码HTTP状态描述解决方案
AUTH_001401API Key无效或已过期检查API Key是否正确,或重新生成
RATE_001429请求频率超限降低请求频率或升级套餐
INV_001400库存不足检查可用库存量后重试
ORD_002404订单不存在确认订单号是否正确
SYS_500500系统内部错误请稍后重试或联系技术支持

开始集成黄色仓库 API

注册即可获取API Key和沙箱环境,5分钟内完成首次API调用。

获取API Key