接口分类

认证授权 订单管理 库存管理 发货管理 商品管理 财务管理

认证授权

POST /api/v1/open/auth/token

获取访问令牌,用于调用其他API接口

请求参数
参数名 类型 必填 说明
appKey String 应用标识,从系统获取
appSecret String 应用密钥,从系统获取
请求示例
{ "appKey": "your_app_key", "appSecret": "your_app_secret" }
响应示例
{ "code": 0, "msg": "success", "data": { "accessToken": "eyJhbGciOiJIUzI1NiJ9...", "expiresIn": 7200 } }

订单管理

GET /api/v1/open/orders/list

获取订单列表,支持多条件筛选

请求参数
参数名 类型 必填 说明
shopId Long 店铺ID
status String 订单状态:PENDING/PAID/SHIPPED/COMPLETED/CANCELLED
startDate String 开始日期 yyyy-MM-dd
endDate String 结束日期 yyyy-MM-dd
pageNum Integer 页码,默认1
pageSize Integer 每页数量,默认20
GET /api/v1/open/orders/{orderId}

获取订单详情

路径参数
参数名 类型 说明
orderId Long 订单ID
POST /api/v1/open/orders/sync

手动同步平台订单,从电商平台拉取最新订单

请求参数
参数名 类型 必填 说明
shopId Long 店铺ID

库存管理

GET /api/v1/open/inventory/query

查询库存信息

请求参数
参数名 类型 必填 说明
warehouseId Long 仓库ID
sku String 商品SKU编码
productId Long 商品ID
POST /api/v1/open/inventory/adjust

库存调整

请求参数
参数名 类型 必填 说明
warehouseId Long 仓库ID
sku String 商品SKU编码
quantity Integer 调整数量,正数增加,负数减少
reason String 调整原因

发货管理

POST /api/v1/open/shipping/create

创建发货单/备货单

请求参数
参数名 类型 必填 说明
orderId Long 订单ID
warehouseId Long 发货仓库ID
shippingType String 发货类型:LOCAL/CLOUD/SUPPLIER
GET /api/v1/open/shipping/trace/{shippingId}

获取物流轨迹

路径参数
参数名 类型 说明
shippingId Long 发货单ID

商品管理

GET /api/v1/open/products/list

获取商品列表

请求参数
参数名 类型 必填 说明
categoryId Long 分类ID
status String 商品状态:ON_SALE/OFF_SALE
pageNum Integer 页码
pageSize Integer 每页数量

财务管理

GET /api/v1/open/finance/settlement

获取结算记录

请求参数
参数名 类型 必填 说明
type String 结算类型:MERCHANT/SUPPLIER
startDate String 开始日期
endDate String 结束日期

公共说明

公共请求头

Header名 必填 说明
Authorization Bearer {accessToken},通过登录接口获取
Content-Type application/json

公共响应码

code msg 说明
0 success 请求成功
401 unauthorized 未授权或token过期
403 forbidden 无权限访问
404 not_found 资源不存在
500 internal_error 服务器内部错误

接口基础地址

# 网关地址(外部调用) https://api.qihangerp.com/api/v1/open # 开发环境 http://localhost:8088/api/v1/open

需要更多API支持?

联系我们获取定制化API开发服务