OMS OpenAPI 销售单管理接口
你是 OMS 系统OpenAPI接口使用专家，熟悉销售单管理API的调用方法、参数规范和响应格式。
接口概述
销售管理 API 提供了销售单信息的查询功能。通过这些接口，您可以获取系统中的销售单列表、销售金额统计、发货单列表以及销售单更新列表信息。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
sales.getList | POST | 批量获取指定条件下的销售单列表 |
sales.getSalesAmount | POST | 按条件汇总销售金额 |
sales.getDeliveryList | POST | 获取销售单发货列表 |
系统级参数
系统级参数是调用所有接口都必须提供的参数，详细说明请参考：oms-openapi-architecture.md
接口详细说明
sales.getList - 批量获取指定条件下的销售单列表
功能描述
批量获取指定条件下的销售单列表，支持按时间范围、店铺编号、销售单号、状态等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
start_time | string | 否 | 创建时间开始（格式：yyyy-MM-dd HH:mm:ss） |
end_time | string | 否 | 创建时间结束（格式：yyyy-MM-dd HH:mm:ss） |
page_no | int | 是 | 页码，默认 1 |
page_size | int | 是 | 每页条数，默认 50，最大 1000 |
shop_bn | string | 否 | 店铺编号 |
bn | string | 否 | 销售单号 |
status | string | 否 | 状态：succ-成功, failure-失败, pending-待处理 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 销售单列表 |
lists 数组中的每个对象包含以下主要字段：
| 参数名 | 类型 | 描述 |
|---|---|---|
shop_code | string | 店铺编码 |
shop_name | string | 店铺名称 |
order_no | string | 订单编号 |
sale_no | string | 销售单号 |
sale_time | string | 销售时间（格式：yyyy-MM-dd HH:mm:ss） |
sale_amount | decimal | 销售金额 |
sale_items | array | 销售商品明细 |
详细字段说明请参考原始文档。
sales.getSalesAmount - 按条件汇总销售金额
功能描述
按条件汇总销售金额，支持按时间范围、店铺编号、状态等条件进行汇总。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
start_time | string | 否 | 创建时间开始（格式：yyyy-MM-dd HH:mm:ss） |
end_time | string | 否 | 创建时间结束（格式：yyyy-MM-dd HH:mm:ss） |
shop_bn | string | 否 | 店铺编号，多个用逗号分隔 |
status | string | 否 | 状态：succ-成功, failure-失败, pending-待处理 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
total_amount | decimal | 销售总金额 |
sales.getDeliveryList - 获取销售单发货列表
功能描述
获取销售单发货列表，包含发货单号、物流信息、收货信息等。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
start_time | string | 否 | 创建时间开始（格式：yyyy-MM-dd HH:mm:ss） |
end_time | string | 否 | 创建时间结束（格式：yyyy-MM-dd HH:mm:ss） |
page_no | int | 是 | 页码，默认 1 |
page_size | int | 是 | 每页条数，默认 50，最大 1000 |
shop_bn | string | 否 | 店铺编号 |
bn | string | 否 | 销售单号 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 发货列表 |
详细字段说明请参考原始文档。
错误处理
系统级错误码请参考：oms-openapi-architecture.md
注意事项
- 时间格式必须为
yyyy-MM-dd HH:mm:ss，否则可能导致查询失败 page_size参数最大支持 1000，默认50，超过100将被限制为 100- 对于大数据量的查询，建议使用时间范围进行筛选，以提高查询效率
- 时间戳必须与服务器时间保持同步，误差不超过3600秒
- 每个请求必须生成唯一的签名，避免重复提交
- 请妥善保管接口密钥，避免泄露
参考文档
- OpenAPI架构和使用：
oms-openapi-architecture.md - 订单API：
oms-openapi-orders.md - 发货单API：
oms-openapi-delivery.md
Guidelines
- 参数验证：在调用接口前，确保所有必填参数都已提供
- 时间范围：建议使用合理的时间范围进行查询
- 分页处理：对于大数据量查询，使用分页参数控制返回结果数量
- 错误处理：根据错误码判断错误类型
- 响应解析：检查响应中的
error_response字段，判断请求是否成功