关于退货

访问范围

需要多个访问范围—请参阅每个端点以了解访问范围要求。

需要访问受保护的客户数据。

退款管理是 Genstore 交易系统的重要组成部分，它提供了规范化的退款处理流程和管理能力。通过标准化的退款处理机制，帮助商户高效处理各类退款场景，提升售后服务质量。

核心功能

创建退款：创建退款申请、指定退款金额、设置退款原因和方式。
管理退款状态：更新退款状态、跟踪退款进度。
查询退款信息：查询退款单详情、查询退款列表、查询订单关联退款。

使用场景

售后退款处理：客服团队可快速响应退款申请、跟进退款进度、维护退款记录，确保高效的售后服务体验。
退款风控管理：风控团队可审核异常退款、监控退款趋势、识别欺诈风险，保障交易安全。
财务对账核算：财务团队可统计退款数据、核对退款明细、生成对账报表，实现准确的财务管理。
经营分析决策：运营团队可分析退款原因、评估服务质量、优化商品策略，提升经营效率。

接口

POST /api/202412/refunds: 创建售后记录

PUT /api/202412/refunds/{refundId}: 审核售后状态

GET /api/202412/orders/{orderId}/refunds: 获取订单售后列表

GET /api/202412/refunds?orderId={orderId}&refundId={refundId}: 获取指定售后信息

退货业务对象对象

退货退款业务对象

属性

refundobjectrequired

售后信息。

- 收起属性

refundIdnumberrequired

售后单号。

customerIdnumberrequired

客户唯一标识。

lineItemsarrayrequired

售后行。

+ 展开属性

notestringrequired

售后备注。

createTimestringrequired

创建时间。

updateTimestringrequired

更新时间。

refundPricenumberrequired

这是售后的金额。

statusnumberrequired

售后单的状态。枚举值: 1. 已发起售后 2. 处理中 3. 已完成 4. 已取消 5. 异常状态

退货业务对象对象

bash

{
  "refund": {
    "lineItems": [
      {
        "totalTax": "0.00",
        "lineItem": {
          "productId": "123",
          "variantId": "222"
        },
        "quantity": "",
        "lineItemId": "",
        "subtotal": "10.00"
      }
    ],
    "note": "Note",
    "createTime": "2013-06-27T08:48:27-04:00",
    "customerId": "1020000013594",
    "updateTime": "2012-08-24T14:01:46-04:00",
    "refundPrice": "10.00",
    "refundId": "1000069823694",
    "status": ""
  }
}

`POST` 创建售后记录

创建售后记录。

访问范围

需要以下任意访问权限: write_refunds

接口

POST /api/202412/refunds

请求参数

refundobjectrequired

退货信息。

- 收起属性

requestNostringrequired

创建记录的幂等号，防止重复创建。长度不超过50字符，大于等于20字符。

customerIdnumber

客户唯一标识。

lineItemsarrayrequired

退款行。

+ 展开属性

notestringrequired

退款备注。

orderIdnumberrequired

创建售后记录的订单号。

rightsTypenumber

售后类型 1: 退货退款(默认值) 2: 退款

响应数据

refundobjectrequired

退货信息。

- 收起属性

refundIdnumberrequired

退款单号。

customerIdnumberrequired

客户唯一标识。

lineItemsarrayrequired

退款行。

+ 展开属性

notestringrequired

退款备注。

createTimestringrequired

创建时间。

updateTimestringrequired

更新时间。

orderIdnumberrequired

创建售后记录的订单号。

statusnumberrequired

售后单的状态。枚举值: 1. 已发起售后 2. 处理中 3. 已完成 4. 已取消 5. 异常状态

rightsTypenumberrequired

售后类型 1: 退货退款 2: 退款

POST /api/202412/refunds

bash

curl -X POST \ 
https://{shop}.genmystore.com/api/202412/refunds" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"refund":{
		"lineItems":[
			{
				"quantity":"12",
				"lineItemId":"128323456"
			}
		],
		"note":"Item was damaged during shipping",
		"rightsType":"1",
		"orderId":"",
		"customerId":"238478920",
		"requestNo":"asdfaddsadafd"
	}
}'

响应

json

HTTP/1.1 200 OK
{
  "refund": {
    "lineItems": [
      {
        "totalTax": "0.00",
        "lineItem": {
          "productId": "123",
          "variantId": "222"
        },
        "quantity": "12",
        "lineItemId": "128323456",
        "subtotal": "1"
      }
    ],
    "note": "Item was damaged during shipping",
    "rightsType": "1",
    "createTime": "2008-01-10T11:00:00-05:00",
    "orderId": "",
    "customerId": "238478920",
    "updateTime": "2008-01-10T11:00:00-05:00",
    "refundId": "255858046",
    "status": ""
  }
}

`PUT` 审核售后状态

审核售后状态。

访问范围

需要以下任意访问权限: write_refunds

接口

PUT /api/202412/refunds/{refundId}

请求参数

orderIdnumberrequired

订单号。

refundIdnumberrequired

退款单号。

actionnumberrequired

审核状态。枚举值如下: 1: 通过，会进行最终的退款动作 2: 驳回，订单状态将变为取消状态

响应数据

refundobjectrequired

退货信息。

- 收起属性

refundIdnumberrequired

退款单号。

lineItemsarrayrequired

退款行。

+ 展开属性

notestringrequired

退款备注。

createTimestringrequired

创建时间。

updateTimestringrequired

更新时间。

statusnumberrequired

售后单的状态。枚举值: 1. 已发起售后 2. 处理中 3. 已完成 4. 已取消 5. 异常状态

customerIdnumberrequired

客户唯一标识。

rightsTypenumberrequired

售后类型 1: 退货退款 2: 退款

PUT /api/202412/refunds/{refundId}

bash

curl -X PUT \ 
https://{shop}.genmystore.com/api/202412/refunds/{refundId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"orderId":"39072856",
	"action":"1",
	"refundId":"255858046"
}'

响应

json

HTTP/1.1 200 OK
{
  "refund": {
    "lineItems": [
      {
        "totalTax": "0.00",
        "lineItem": {
          "productId": "123",
          "variantId": "222"
        },
        "quantity": "12",
        "lineItemId": "128323456",
        "subtotal": "1"
      }
    ],
    "note": "Item was damaged during shipping",
    "rightsType": "1",
    "createTime": "2008-01-10T11:00:00-05:00",
    "customerId": "238478920",
    "updateTime": "2008-01-10T11:00:00-05:00",
    "refundId": "255858046",
    "status": "1"
  }
}

`GET` 获取订单售后列表

根据订单查询售后信息。

访问范围

需要以下任意访问权限: read_refunds

接口

GET /api/202412/orders/{orderId}/refunds

请求参数

orderIdnumberrequired

订单号。

limitnumberrequired

每页显示的数据条数，默认为 50，最多可设为 250

响应数据

refundsarrayrequired

退款信息。

- 收起属性

refundIdnumberrequired

退款单号。

customerIdnumberrequired

客户唯一标识。

lineItemsarrayrequired

退款行。

+ 展开属性

notestringrequired

退款备注。

createTimestringrequired

创建时间。

updateTimestringrequired

更新时间。

statusnumberrequired

售后单的状态。枚举值: 1. 已发起售后 2. 处理中 3. 已完成 4. 已取消 5. 异常状态

rightsTypenumberrequired

售后类型 1: 退货退款 2: 退款

GET /api/202412/orders/{orderId}/refunds

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/orders/{orderId}/refunds" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "refunds": [
    {
      "lineItems": [
        {
          "totalTax": "0.00",
          "lineItem": {
            "productId": "123",
            "variantId": "222"
          },
          "quantity": "12",
          "lineItemId": "128323456",
          "subtotal": "1"
        }
      ],
      "note": "Item was damaged during shipping",
      "rightsType": "1",
      "createTime": "2008-01-10T11:00:00-05:00",
      "customerId": "238478920",
      "updateTime": "2008-01-10T11:00:00-05:00",
      "refundId": "255858046",
      "status": ""
    }
  ]
}

`GET` 获取指定售后信息

获取指定售后信息。

访问范围

需要以下任意访问权限: read_refunds

接口

GET /api/202412/refunds?orderId={orderId}&refundId={refundId}

请求参数

orderIdnumberrequired

订单号。

refundIdnumberrequired

售后单号。

响应数据

refundobjectrequired

售后信息。

- 收起属性

refundIdnumberrequired

退款单号。

customerIdnumberrequired

客户唯一标识。

lineItemsarrayrequired

退款行。

+ 展开属性

notestringrequired

退款备注。

createTimestringrequired

创建时间。

updateTimestringrequired

更新时间。

statusnumberrequired

售后单的状态。枚举值: 1. 已发起售后 2. 处理中 3. 已完成 4. 已取消 5. 异常状态

rightsTypenumberrequired

售后类型 1: 退货退款 2: 退款

GET /api/202412/refunds?orderId={orderId}&refundId={refundId}

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/refunds?orderId={orderId}&refundId={refundId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "refund": {
    "lineItems": [
      {
        "totalTax": "0.00",
        "lineItem": {
          "productId": "123",
          "variantId": "222"
        },
        "quantity": "12",
        "lineItemId": "128323456",
        "subtotal": "1"
      }
    ],
    "note": "Item was damaged during shipping",
    "rightsType": "1",
    "createTime": "2008-01-10T11:00:00-05:00",
    "customerId": "238478920",
    "updateTime": "2008-01-10T11:00:00-05:00",
    "refundId": "255858046",
    "status": "1"
  }
}

产品

变体

系列

库存

类目

礼品卡

厂商

订单

履约

退货

客户

主题

页面

店铺

市场

翻译

素材

元字段

元字段定义

账户

交易

折扣

消息订阅

订阅收费

使用量收费

关于 退货 ​

退货业务对象 对象 ​

属性 ​

POST 创建售后记录 ​

请求参数

响应数据

PUT 审核售后状态 ​

请求参数

响应数据

GET 获取订单售后列表 ​

请求参数

响应数据

GET 获取指定售后信息 ​

请求参数

响应数据

关于 退货 ​

退货业务对象 对象 ​

属性 ​

POST 创建售后记录 ​

PUT 审核售后状态 ​

GET 获取订单售后列表 ​

GET 获取指定售后信息 ​

关于退货

退货业务对象对象

属性

`POST` 创建售后记录

`PUT` 审核售后状态

`GET` 获取订单售后列表

`GET` 获取指定售后信息

关于退货

退货业务对象对象

属性

`POST` 创建售后记录

`PUT` 审核售后状态

`GET` 获取订单售后列表

`GET` 获取指定售后信息