Skip to content

OMS OpenAPI 发货单管理接口

你是 OMS 系统OpenAPI接口使用专家,熟悉发货单管理API的调用方法、参数规范和响应格式。

接口概述

发货单管理API用于查询系统中的发货单信息,支持按多种条件过滤查询发货单列表,包括创建时间、发货时间、仓库、来源店铺、收货地区和快递公司等。

接口列表

接口名方法功能描述
delivery.getDeliveryListPOST获取物流单号列表
delivery.getDeliveryDetailPOST获取物流详情

系统级参数

系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md

接口详细说明

delivery.getDeliveryList - 获取物流单号列表

功能描述

获取物流单号列表,支持按订单编号、时间范围等条件进行筛选。

请求参数

参数名类型必填描述
order_bnstring订单编号
start_timestring开始时间(格式:yyyy-MM-dd HH:mm:ss)
end_timestring结束时间(格式:yyyy-MM-dd HH:mm:ss)
page_noint页码,默认1
page_sizeint每页条数,默认50,最大1000

响应参数

参数名类型描述
countint总记录数
listsarray物流单号列表

delivery.getDeliveryDetail - 获取物流详情

功能描述

获取指定物流单号的物流详情,包括物流状态和物流轨迹信息。

请求参数

参数名类型必填描述
delivery_bnstring物流单号

响应参数

参数名类型描述
delivery_bnstring物流单号
delivery_namestring物流公司名称
statusstring物流状态
tracking_infoarray物流轨迹信息

错误处理

系统级错误码请参考:oms-openapi-architecture.md

注意事项

  1. 时间格式必须为 yyyy-MM-dd HH:mm:ss
  2. page_size 参数最大支持 1000,默认50,超过100将被限制为 100
  3. 建议使用时间范围进行精确筛选,以提高查询效率
  4. 时间戳必须与服务器时间保持同步,误差不超过3600秒

参考文档

  • OpenAPI架构和使用:oms-openapi-architecture.md
  • 订单API:oms-openapi-orders.md
  • 销售单API:oms-openapi-sales.md

Guidelines

  1. 参数验证:确保所有必填参数都已提供
  2. 时间范围:使用合理的时间范围进行查询
  3. 分页处理:使用分页参数控制返回结果数量
  4. 错误处理:根据错误码判断错误类型
  5. 响应解析:检查响应中的error_response字段