AI-WMS

简体中文

日本語
English

简体中文

日本語
English

Appearance

API 文档 ​

欢迎使用 AI-WMS API 文档。本文档将帮助您了解如何使用我们的API接口，实现与AI-WMS系统的集成。

快速开始 ​

认证方式 ​

AI-WMS API 使用 API Key 进行身份认证。

获取API Key：

  1. 登录AI-WMS管理后台
  2. 进入"系统设置" → "API管理"
  3. 创建新的API Key
  4. 保存API Key（仅显示一次，请妥善保管）

使用API Key： 在请求头中添加认证信息：

Authorization: Bearer {your-api-key}

基础URL ​

生产环境：https://api.ai-wms.com/v1
测试环境：https://api-test.ai-wms.com/v1

请求格式 ​

所有API请求均使用JSON格式，请求头需包含：

Content-Type: application/json
Authorization: Bearer {your-api-key}

响应格式 ​

所有API响应均为JSON格式：

成功响应示例：

json
{
  "code": 200,
  "message": "success",
  "data": {
    // 响应数据
  }
}

错误响应示例：

json
{
  "code": 400,
  "message": "参数错误",
  "error": "具体的错误信息"
}

API端点 ​

商品管理 ​

获取商品列表 ​

GET /products

请求参数：

  • page (int) - 页码，默认为1
  • page_size (int) - 每页数量，默认为20，最大100
  • keyword (string) - 搜索关键词（商品编码/名称）
  • category_id (int) - 分类ID

响应示例：

json
{
  "code": 200,
  "message": "success",
  "data": {
    "total": 100,
    "page": 1,
    "page_size": 20,
    "items": [
      {
        "id": 1,
        "sku": "SKU001",
        "name": "商品名称",
        "category": "分类名称",
        "stock": 100,
        "price": 99.00
      }
    ]
  }
}

获取商品详情 ​

GET /products/{product_id}

创建商品 ​

POST /products

更新商品 ​

PUT /products/{product_id}

删除商品 ​

DELETE /products/{product_id}

库存管理 ​

获取库存信息 ​

GET /inventory

更新库存 ​

PUT /inventory/{product_id}

库存调整 ​

POST /inventory/adjust

订单管理 ​

获取订单列表 ​

GET /orders

创建订单 ​

POST /orders

获取订单详情 ​

GET /orders/{order_id}

更新订单状态 ​

PUT /orders/{order_id}/status

入库管理 ​

创建入库单 ​

POST /inbound

获取入库单列表 ​

GET /inbound

确认入库 ​

POST /inbound/{inbound_id}/confirm

出库管理 ​

创建出库单 ​

POST /outbound

获取出库单列表 ​

GET /outbound

确认出库 ​

POST /outbound/{outbound_id}/confirm

调用限制 ​

不同版本的API调用限制：

  • Lite版本 - 10,000次/天
  • Pro版本 - 100,000次/天
  • Core版本 - 无限制

超出限制后，请求将返回429错误。建议：

  • 合理控制请求频率
  • 使用批量接口减少请求次数
  • 考虑升级版本

错误码说明 ​

错误码说明
200请求成功
400请求参数错误
401认证失败
403权限不足
404资源不存在
429请求频率超限
500服务器错误

SDK和示例代码 ​

SDK下载 ​

我们提供以下语言的SDK：

  • Python SDK
  • Java SDK
  • PHP SDK
  • JavaScript SDK

下载SDK →

代码示例 ​

Python示例：

python
import requests

api_key = "your-api-key"
base_url = "https://api.ai-wms.com/v1"

headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

# 获取商品列表
response = requests.get(
    f"{base_url}/products",
    headers=headers,
    params={"page": 1, "page_size": 20}
)

print(response.json())

JavaScript示例：

javascript
const apiKey = 'your-api-key';
const baseUrl = 'https://api.ai-wms.com/v1';

const headers = {
  'Authorization': `Bearer ${apiKey}`,
  'Content-Type': 'application/json'
};

// 获取商品列表
fetch(`${baseUrl}/products?page=1&page_size=20`, {
  headers: headers
})
  .then(response => response.json())
  .then(data => console.log(data));

更多资源 ​

联系我们 ​

如有API相关问题，欢迎联系：