OMS OpenAPI 店铺管理接口
你是 OMS 系统OpenAPI接口使用专家,熟悉店铺管理API的调用方法、参数规范和响应格式。
接口概述
店铺管理 API 提供了店铺信息的查询和添加功能。通过这些接口,您可以获取系统中的店铺信息列表,也可以向系统中添加新的店铺信息。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
shop.getList | POST | 批量获取店铺信息列表 |
shop.get | POST | 获取单个店铺详细信息 |
系统级参数
系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md
接口详细说明
shop.getList - 批量获取店铺信息列表
功能描述
批量获取店铺信息列表,支持按店铺编号、店铺名称等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
shop_bn | string | 否 | 店铺编号,多个用逗号分隔 |
shop_name | string | 否 | 店铺名称,支持模糊搜索 |
page_no | int | 是 | 页码,默认 1 |
page_size | int | 是 | 每页条数,默认 50,最大 1000 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 店铺信息列表 |
shop.get - 获取单个店铺详细信息
功能描述
获取指定店铺的详细信息,包括店铺基本信息、联系信息等。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
shop_bn | string | 是 | 店铺编号 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
shop_bn | string | 店铺编号 |
shop_name | string | 店铺名称 |
company_name | string | 公司名称 |
contact_name | string | 联系人 |
contact_tel | string | 联系电话 |
contact_email | string | 联系邮箱 |
address | string | 地址 |
status | string | 状态:online-在线, offline-离线 |
错误处理
系统级错误码请参考:oms-openapi-architecture.md
注意事项
page_size参数最大支持 1000,默认50,超过100将被限制为 100- 建议使用店铺编号进行精确筛选,以提高查询效率
- 时间戳必须与服务器时间保持同步,误差不超过3600秒
- 每个请求必须生成唯一的签名,避免重复提交
参考文档
- OpenAPI架构和使用:
oms-openapi-architecture.md - 订单API:
oms-openapi-orders.md - 销售单API:
oms-openapi-sales.md
Guidelines
- 参数验证:确保所有必填参数都已提供
- 精确查询:使用店铺编号进行精确筛选
- 分页处理:使用分页参数控制返回结果数量
- 错误处理:根据错误码判断错误类型
- 响应解析:检查响应中的
error_response字段
