1. 售后
西之月开放接口（openapi）
  • 西之月开放平台介绍
  • 西之月接入流程
  • 西之月开放API
  • 西之月订阅通知
  • 公共错误码
  • 货盘页面接入说明
  • openapi
    • 商品
      • 📖商品能力
      • SKU
        • SKU列表
        • SKU信息
        • SKU信息及价格
        • SKU查询客户价格
        • SKU查询英代欧代美代协议
        • SKU一体化标签
        • SKU一体化标签平台
        • SKU证书
        • SKU六面图
        • SKU商品图包
        • SKU视频
        • SKU商品标签【国内】
        • SKU产品文案
        • SKU实拍图附带一体化标签
        • SKU图包资料
      • 库存
        • 商品总库存列表
        • 商品分仓库存列表
        • 指定商品分仓库存
        • 圈货、备货库存查询
        • SKU实时库存【国内】
      • 商品列表
      • 商品详情
      • 商品价格
      • 个性化商品价格列表
      • 商品所有档位价格
      • 商品分类
      • 商品分类-获取子分类
      • 商品品牌
      • 商品证书
      • 商品使用说明书
    • 订单
      • 📖订单能力
      • 交接单
        • 交接单列表
        • 验证订单允许上传交接单
        • 上传交接单文件
        • 保存交接单
      • 创建订单
      • 订单预计算
      • 订单列表
      • 订单详情
      • 订单详情列表
      • 订单取消
      • 订单状态
      • 订单支付状态
      • 订单物流轨迹
    • 支付
      • 📖支付能力
      • 订单支付页面
      • 发起支付
      • 获取支付方式
      • 获取订单支付信息
    • 售后
      • 📖售后能力
      • 获取发起售后配置数据
        GET
      • 订单发起售后
        POST
      • 撤销售后
        POST
    • 账期
      • 📖账期能力
      • 已结清账期-账单列表
      • 未结清账期-账单列表
      • 未结清账单-销售订单列表
      • 未结清账单-售后订单列表
    • 品牌授权
      • 📖品牌授权能力
      • 获取授权平台列表
      • 获取模板类型列表
      • 获取授权品牌列表
      • 获取执照列表信息
      • 品牌授权申请
      • 品牌授权记录
      • 品牌授权作废
    • 其他
      • 📖其它能力
      • 仓库
        • 仓库列表信息
        • 发货区域列表
      • 物流
        • 物流公司列表
        • 获取运费接口
      • 平台
        • 获取授权码
        • 平台列表信息-新
        • 平台列表信息
      • 用户
        • 根据token获取用户信息
    • 订阅通知
      • 商品信息变更
      • 商品上下架状态变更
      • 商品库存变更
      • 商品价格变更
      • 商品删除
  1. 售后

订单发起售后

外部-测试环境
https://testing.westmonth.com
外部-测试环境
https://testing.westmonth.com
POST
/openapi/afterSale/apply

订单发起售后接口#

提供订单售后申请的提交能力，支持用户根据订单商品信息发起退款、退货、换货或补发等售后请求，接口需配合【获取发起售后配置数据】接口使用，确保售后类型和原因符合系统规范。

适用场景#

针对订单中的商品发起仅退款申请
申请普通退货（退款+退货）
申请换货（更换商品）
申请补发商品（商品漏发或损坏时）

接口类型#

POST

请求频率限制#

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

请求说明#

请求URL
正式环境：https://www.westmonth.com/openapi/afterSale/apply
测试环境：https://testing.westmonth.com/openapi/afterSale/apply

请求参数#

Header参数#

参数名类型必填示例值说明
Authorizationstring是authorization身份验证Token
Content-Typestring是application/json固定传此值

Body参数#

根 字段
参数名类型必填说明
order_productarray是订单商品列表，需包含售后涉及的商品信息
typeinteger是售后类型：
- 0：仅退款
- 1：普通退货
- 2：换货
- 3：补发
需取自【获取发起售后配置数据】接口的type字段
reason_idinteger是售后原因ID，需取自【获取发起售后配置数据】接口的reasons.id字段
detail_idinteger否售后原因详情ID，需取自【获取发起售后配置数据】接口的children.id字段（最底层原因ID）
remarkstring是售后申请备注说明（如问题描述、具体需求等）
imagesarray否图片文件地址数组（OSS链接），用于证明售后问题（如商品破损照片）
attachmentsarray否附件文件地址数组（OSS链接），如相关凭证、检测报告等
amountinteger是申请售后金额（单位：分，需与订单商品金额匹配）
goods_statusstring是货物状态编码：
- BUYER_NOT_RECEIVED：买家未收货
- BUYER_RECEIVED：买家已收货
- BUYER_RETURNED_GOODS：买家已退货
- SELLER_RECEIVED：卖家已收货
order_idstring否订单ID（与order_number二选一，推荐传order_number）
order_numberstring是西月订单号（与order_id二选一，优先使用）
after_sale_shipment_productsarray是退款/换货/补发 产品明细
third_after_sale_nostring否第三方售后单
order_product数组 字段
参数名类型必填说明
order_product_idinteger否订单商品ID（与order_product_sku二选一）
quantityinteger是该商品的售后数量（需≤订单中的购买数量）
order_product_skustring否订单商品SKU编码（与order_product_id二选一，推荐传此值）
after_sale_shipment_products数组 字段
参数名类型必填说明
product_sku_idinteger是产品sku
order_product_idinteger是原来订单产品id
quantityinteger是数量

响应字段说明#

成功响应（HTTP 200）
根 字段
字段类型说明
statusstring请求状态（success表示成功，error表示失败）
messagestring请求状态描述（如“售后申请提交成功”或具体错误原因）
dataobject售后单信息（成功时返回）
data对象 字段
字段类型说明
numberstring售后单单号（系统生成的唯一标识）
idinteger售后单ID（用于后续查询或操作该售后单）

错误处理#

HTTP状态码status说明解决方案
200error授权无效确认Authorization的正确性
200error参数错误检查：1. 必选参数是否缺失；2. type、reason_id是否与【获取发起售后配置数据】接口返回值匹配；3. amount是否为正数且合理；4. order_product中的quantity是否超过订单购买数量
200error订单状态不支持售后该订单可能已完成售后、已取消或超过售后时效，确认订单状态后再操作
200error图片/附件格式错误检查images和attachments中的URL是否为有效的OSS链接，格式是否正确
500-服务错误稍后重试，若持续报错请联系技术支持

注意事项#

售后类型（type）、原因ID（reason_id）、原因详情ID（detail_id）必须与【获取发起售后配置数据】接口返回的配置一致，否则会导致参数错误
售后金额（amount）需根据商品单价和售后数量计算，不得超过订单中对应商品的总金额
货物状态（goods_status）需如实填写，否则可能影响售后审核结果（如未收货却填已收货，可能被驳回）
上传图片或附件时，需确保链接有效且可访问，建议先通过OSS接口上传文件获取链接后再提交
换货时（type=2），需传入exchange_product_sku_id指定目标商品的SKU ID，且该商品需与原商品属于同一订单或可替换范围

常见问题#

Q1：如何确定reason_id和detail_id的取值？#

A：调用【获取发起售后配置数据】接口，根据返回的层级结构选择：
reason_id对应二级原因ID（如“未收到货”的id）
detail_id对应三级原因ID（如“货物短缺-数量短缺”的id）

Q2：售后申请提交后，如何查询进度？#

A：可通过后续的“售后单详情查询接口”（如有）查询售后单的审核状态、处理进度等信息。

Q3：发起普通退货（type=1）时，是否需要填写退货地址？#

A：该接口暂不包含退货地址参数，通常在售后申请审核通过后，系统会返回退货地址，具体以平台流程为准。

Q4：同一笔订单是否可以重复发起售后#

A：
如果是同一笔订单的不同sku，是允许的；
如果同一笔订单且相同sku，只允许有一笔售后单。即，该售后单一但通过，不允许再对该订单的该sku发起售后。想修改售后数量或其他信息，只能售后未完成前，取消售后并再重新发起售后。

版本历史#

版本日期修改说明
v1.02025-04-10初始版本，支持发起各类售后申请

请求参数

Header 参数

Body 参数application/json

示例
{
    "order_product": [
        {
            "order_product_id": 0,
            "quantity": 1,
            "order_product_sku": "NO-B07-0017-01223"
        }
    ],
    "type": 0,
    "reason_id": 2,
    "detail_id": 6,
    "remark": "23213",
    "images": [
        "https://oss.westmonth.com/westmonth/SKUDatum/old/HOA02-A082-50-MX1/mainpicture/HOA02-A082-50-MX1-001.jpg?x-oss-process=image/resize,m_lfit,w_500"
    ],
    "attachments": [],
    "amount": 1,
    "goods_status": "BUYER_NOT_RECEIVED",
    "order_id": "BXY2505121479552"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://testing.westmonth.com/openapi/afterSale/apply' \
--header 'Authorization: {{token}}' \
--header 'Cookie: {{cookie}};{{cookie}}' \
--header 'Content-Type: application/json' \
--data '{
    "order_product": [
        {
            "order_product_id": 0,
            "quantity": 1,
            "order_product_sku": "NO-B07-0017-01223"
        }
    ],
    "type": 0,
    "reason_id": 2,
    "detail_id": 6,
    "remark": "23213",
    "images": [
        "https://oss.westmonth.com/westmonth/SKUDatum/old/HOA02-A082-50-MX1/mainpicture/HOA02-A082-50-MX1-001.jpg?x-oss-process=image/resize,m_lfit,w_500"
    ],
    "attachments": [],
    "amount": 1,
    "goods_status": "BUYER_NOT_RECEIVED",
    "order_id": "BXY2505121479552"
}'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{
    "status": "string",
    "message": "string",
    "data": {
        "number": "string",
        "id": 0
    }
}
修改于 2026-02-24 03:26:17
上一页
获取发起售后配置数据
下一页
撤销售后
Built with