Refund record structure
Each refund on an order is stored in therefunds array of the order record. A Refund contains:
| Field | Description |
|---|---|
refund_id | Unique identifier for the refund |
amount | Total amount to be refunded |
reason | Text description of why the refund was requested |
status | Current RefundStatus value |
items | Array of RefundItem objects specifying which items are refunded |
issued_by | Identifier of the user or system that issued the refund |
transaction_id | Associated transaction reference, or null if not yet processed |
created_at | When the refund was requested |
processed_at | When the refund was processed, or null if still pending |
notes | Optional notes on the refund, or null |
Refund items
Theitems array specifies exactly which order items are included in the refund:
| Field | Description |
|---|---|
item_id | References the item_id of the original OrderItem |
product_id | Product being refunded |
variant_id | Variant reference, or null |
quantity | Number of units being refunded |
amount | Refund amount for this item |
Refund statuses
| Status | Meaning |
|---|---|
pending | Refund has been requested and is awaiting review |
approved | Refund has been approved and will be processed |
rejected | Refund request was reviewed and denied |
partial | A partial refund was issued rather than the full requested amount |
When an order has at least one approved refund, its
status changes to refunded or partially_refunded depending on whether the full order amount was returned.Issuing a refund from the order detail view
Navigate to the order
Go to Orders and click the order you want to refund. You can search by order number or use the status and date filters to find it.
Open the Refunds section
Scroll to the Refunds section within the order detail view. Any existing refunds on this order are listed here with their current status.
Initiate a new refund
Click Issue Refund. Enter the refund amount and a reason. If you are refunding specific items rather than the full order, select the items and quantities to include.
Submit the refund
Confirm the refund details and submit. The refund is created with a status of
pending and added to the order’s refunds array.Reviewing refund requests
The Refunds section of the dashboard lists all orders with refund activity. You can filter by refund status to focus on pending requests that need a decision.- Pending — requests waiting for approval or rejection
- Approved — refunds that have been greenlit for processing
- Rejected — requests that were denied