Skip to content

OMS OpenAPI 售后单管理接口

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

接口概述

售后管理 API 提供了查询售后单信息的功能,包括售后单列表查询和 JIT 售后单查询。通过这些接口,您可以获取系统中的售后单数据,用于数据分析和业务处理。

接口列表

接口名方法功能描述
aftersales.getListPOST获取售后单列表
aftersales.getDetailPOST获取售后单详情

系统级参数

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

接口详细说明

aftersales.getList - 获取售后单列表

功能描述

获取售后单列表,支持按时间范围、更新时间范围等条件进行筛选。

请求参数

参数名类型必填描述
start_timestring开始时间(格式:yyyy-MM-dd HH:mm:ss)
end_timestring结束时间(格式:yyyy-MM-dd HH:mm:ss)
modified_startstring更新开始时间(格式:yyyy-MM-dd HH:mm:ss)
modified_endstring更新结束时间(格式:yyyy-MM-dd HH:mm:ss)
page_noint页码,默认1
page_sizeint每页条数,默认100,最大1000

响应参数

参数名类型描述
countint总记录数
listsarray售后单列表

aftersales.getDetail - 获取售后单详情

功能描述

获取指定售后单的详细信息,包括售后单基本信息、售后商品明细等。

请求参数

参数名类型必填描述
aftersale_nostring售后单号

响应参数

参数名类型描述
aftersale_nostring售后单号
shop_codestring店铺编码
shop_namestring店铺名称
order_nostring订单编号
aftersale_typestring售后类型
refund_moneystring退款金额
aftersale_itemsarray售后商品明细

错误处理

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

注意事项

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

参考文档

  • OpenAPI架构和使用:oms-openapi-architecture.md
  • 退款单API:oms-openapi-refunds.md
  • 订单API:oms-openapi-orders.md

Guidelines

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