English

简体中文

English

简体中文

Appearance

About Refund ​

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

Refund Management is a crucial component of the Genstore trading system, offering standardized refund processing workflows and management capabilities. Through standardized refund handling mechanisms, it helps merchants efficiently process various refund scenarios and improve after-sales service quality.

Core Features

  • Create Refund: Create refund request, specify refund amount, set refund reason and method
  • Manage Refund Status: Update refund status, track refund progress
  • Query Refund Information: Get refund details, list refund orders, query order-related refunds

Use Cases

  • After-sales Refund Processing: Customer service teams can quickly respond to refund applications, track refund progress, and maintain refund records to ensure efficient after-sales service experience.
  • Refund Risk Management: Risk control teams can review abnormal refunds, monitor refund trends, and identify fraud risks to ensure transaction security.
  • Financial Reconciliation: Finance teams can analyze refund data, verify refund details, and generate reconciliation reports to achieve accurate financial management.
  • Business Analysis: Operations teams can analyze refund reasons, evaluate service quality, and optimize product strategies to improve operational efficiency.

Endpoints

EVENT refunds/create: Refund status update

The Refund resource Object ​

The Refund resource

Properties ​

refundobject
Information about the refund.
- Hide child properties
idnumber
This is a refund order number.
customerIdnumber
Customer unique identification.
customerobject
Information about the customer.
+ Show child properties
lineItemsarray
A list of refunded line items. Each entry has the following properties:
+ Show child properties
notestring
An optional note attached to a refund.
createTimestring
The date and time (ISO 8601 format) when the refund was created.
updateTimestring
The date and time (ISO 8601 format) when the refund was update.
refundPricenumber
This is the requested refund amount.
bash
{
  "refund": {
    "lineItems": [
      {
        "line_item": "",
        "line_item_id": "",
        "quantity": "",
        "subtotal": "10.00",
        "id": "",
        "total_tax": "0.00",
        "location_id": ""
      }
    ],
    "note": "Note",
    "createTime": "2013-06-27T08:48:27-04:00",
    "customerId": "1020000013594",
    "updateTime": "2012-08-24T14:01:46-04:00",
    "id": "1000069823694",
    "refundPrice": "10.00",
    "customer": {
      "lastName": "Terry",
      "note": "This is Note.",
      "updatedTime": "2012-08-24T14:01:46-04:00",
      "addresses": "",
      "taxExempt": "",
      "taxExemptions": "",
      "tags": "",
      "firstName": "",
      "phone": "",
      "createdTime": "2013-06-27T08:48:27-04:00",
      "currency": "",
      "id": "",
      "state": "",
      "email": "",
      "verifiedEmail": "",
      "defaultAddress": ""
    }
  }
}

EVENT Refund status update ​

This is a refund message, mainly including refund in progress, refunded, and fund change messages.

Access scope

Requires ANY of the following access scopes: write_refunds read_refunds

Topic

EVENT refunds/create 

Event Data

refundobject
This is the refund object.
- Hide child properties
lineItemsarray
A list of refunded line items.
+ Show child properties
orderIdnumber
This is the order number corresponding to the refund.
refundPricenumber
This is the requested refund amount.
createTimestring
This is the refund creation time record.
updateTimestring
This is the update time record for refund creation.
idnumber
The unique identifier for the refund.
customerobject
Information about the customer.
+ Show child properties
notestring
An optional note attached to a refund.
json
{
  "refund": {
    "lineItems": [
      {
        "totalTax": "0.00",
        "quantity": "1",
        "lineItem": {
          "quantity": "1",
          "productId": "12901212",
          "price": "10.00",
          "discountAllocations": [
            {
              "amount": "0.01"
            }
          ],
          "variantId": "12901312",
          "sku": "128G;白色;",
          "currentQuantity": "1",
          "taxLines": [
            {
              "price": "10.00"
            }
          ]
        },
        "subtotal": "1"
      }
    ],
    "note": "Note",
    "orderId": "300141548096383",
    "createTime": "2024-12-31 00:00:00",
    "updateTime": "2024-12-31 00:00:00",
    "id": "10220473645",
    "refundPrice": "10.00",
    "customer": {
      "lastName": "Terry",
      "note": "Note",
      "updatedTime": "2013-06-27T08:48:27-04:00",
      "addresses": "1990 Poplar Ridge Road",
      "taxExempt": "true",
      "tags": "[ \"xinsheng\",          \"human\" ]",
      "firstName": "wh",
      "phone": "+16173034750",
      "createdTime": "2012-08-24T14:01:46-04:00",
      "currency": "USD",
      "id": "1",
      "state": "DECLINED",
      "email": "[email protected]",
      "verifiedEmail": "1",
      "defaultAddress": "1990 Poplar Ridge Road"
    }
  }
}