获取发起售后配置数据接口

提供发起售后时所需的配置数据查询能力，返回可选择的售后类型及对应的售后原因层级结构，帮助用户规范填写售后申请信息，确保售后流程的准确性和一致性。

适用场景

发起售后申请前，获取系统支持的售后类型（如仅退款、退货、换货等）

展示售后原因的层级选项，辅助用户选择具体的售后原因

对接售后申请页面，动态生成符合系统要求的售后原因选择表单

接口类型

GET

请求频率限制

默认频率：以平台配额为准

请求说明

请求URL

正式环境：https://www.westmonth.com/openapi/afterSale/getApplyDataConfig
测试环境：https://testing.westmonth.com/openapi/afterSale/getApplyDataConfig

请求参数

Header参数

参数名	类型	必填	示例值	说明
Authorization	string	是	authorization	身份验证Token
Content-Type	string	否	application/json	可选，建议传此值

Query参数

参数名	类型	必填	默认值	说明
order_number	string	否	-	西月订单号，传入后可返回与该订单匹配的售后配置（如根据订单状态过滤不可用的售后类型）

响应字段说明

成功响应（HTTP 200）

根字段

字段	类型	说明
status	string	请求状态（success表示成功）
message	string	请求状态描述（成功时为“请求成功！”）
data	array	售后配置数据列表

data数组字段

字段	类型	说明
type	integer	售后类型编码： - 0：仅退款 - 1：普通退货 - 2：换货 - 3：补发
name	string	售后类型名称（如：“仅退款”）
reasons	array	该售后类型下的售后原因层级结构

reasons数组字段

字段	类型	说明
id	integer	售后原因ID
enum	string	售后原因枚举值（如：BUYER_NOT_RECEIVED表示“未收到货”）
name	string	售后原因名称（如：“未收到货”“已收到货”）

错误处理

HTTP状态码	status	说明	解决方案
200	error	授权失败	确认Authorization的正确性
200	error	参数错误	检查order_number是否为有效的西月订单号
500	-	服务错误	稍后重试，若持续报错请联系技术支持

注意事项

售后原因采用三级层级结构：一级原因（如“未收到货”）→ 二级原因（如“仓库发货问题”）→ 三级原因（如“货物短缺-数量短缺”），实际使用时需选择到最底层原因

传入order_number时，系统会根据订单的当前状态（如是否已发货、是否已签收）过滤掉不适用的售后类型或原因（例如已签收的订单不会显示“未收到货”相关原因）

枚举值（enum）可用于系统间的参数传递，名称（name）用于前端展示给用户

常见问题

Q1：返回的售后类型只有“仅退款”，没有“退货”或“换货”是什么原因？

A：可能是因为传入的order_number对应的订单状态不支持退货或换货（如订单尚未发货，仅支持退款），系统会根据订单状态动态过滤售后类型。

Q2：如何选择售后原因？

A：需从层级结构中选择到最底层的原因（即没有children的节点），例如：“仅退款”→“未收到货”→“仓库发货问题”→“货物短缺-数量短缺”。

Q3：不同订单的售后配置可能不同吗？

A：是的，传入不同的order_number可能返回不同的配置，因为系统会根据订单的状态、商品类型等因素过滤不适用的售后选项。

版本历史

版本	日期	修改说明
v1.0	2025-04-01	初始版本，支持售后配置数据查询

application/json

Bodyapplication/json

示例

{
    "status": "success",
    "message": "请求成功！",
    "data": [
        {
            "type": 0,
            "name": "仅退款",
            "reasons": [
                {
                    "id": 198,
                    "name": "国外-已签收-仅退款-未收到货"
                }
            ]
        },
        {
            "type": 1,
            "name": "退货退款",
            "reasons": [
                {
                    "id": 203,
                    "name": "错发"
                }
            ]
        }
    ]
}

获取发起售后配置数据

获取发起售后配置数据接口

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Query参数

响应字段说明

错误处理

注意事项

常见问题

Q1：返回的售后类型只有“仅退款”，没有“退货”或“换货”是什么原因？

Q2：如何选择售后原因？

Q3：不同订单的售后配置可能不同吗？

版本历史

请求参数

请求示例代码

返回响应

获取发起售后配置数据

获取发起售后配置数据接口#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

Query参数#

响应字段说明#

错误处理#

注意事项#

常见问题#

Q1：返回的售后类型只有“仅退款”，没有“退货”或“换货”是什么原因？#

Q2：如何选择售后原因？#

Q3：不同订单的售后配置可能不同吗？#

版本历史#

请求参数

请求示例代码

返回响应

获取发起售后配置数据接口

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Query参数

响应字段说明

错误处理

注意事项

常见问题

Q1：返回的售后类型只有“仅退款”，没有“退货”或“换货”是什么原因？

Q2：如何选择售后原因？

Q3：不同订单的售后配置可能不同吗？

版本历史