Refund
Requires access scope or access scope.
The Refund object represents a financial record of money returned to a customer from an order.
It provides a comprehensive view of all refunded amounts, transactions, and restocking instructions
associated with returning products or correcting order issues.
The Refund object provides information to:
- Process customer returns and issue payments back to customers
- Handle partial or full refunds for line items with optional inventory restocking
- Refund shipping costs, duties, and additional fees
- Issue store credit refunds as an alternative to original payment method returns
- Track and reconcile all financial transactions related to refunds
Each Refund object maintains detailed records of what was refunded, how much was refunded,
which payment transactions were involved, and any inventory restocking that occurred. The refund
can include multiple components such as product line items, shipping charges, taxes, duties, and
additional fees, all calculated with proper currency handling for international orders.
Refunds are always associated with an order and can optionally be linked to a return if the refund was initiated through the returns process. The refund tracks both the presentment currency (what the customer sees) and the shop currency for accurate financial reporting.
The existence of a Refund object doesn't guarantee that the money has been returned to the customer.
The actual financial processing happens through associated
objects, which can be in various states, such as pending, processing, success, or failure.
To determine if money has actually been refunded, check the
status
of the associated transactions.
Learn more about managing returns, refunding duties, and processing refunds.
Anchor to Fields and connectionsFields and connections
- Anchor to createdAtcreated•Date
At Time The date and time when the refund was created.
- Anchor to dutiesduties•[Refund
Duty!] A list of the refunded duties as part of this refund.
- •ID!non-null
A globally-unique ID.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to notenote•String
The optional note associated with the refund.
- Anchor to orderorder•Order!non-null
The order associated with the refund.
- Anchor to orderAdjustmentsorder•Order
Adjustments Adjustment Connection! non-null The order adjustments that are attached with the refund.
- Anchor to refundLineItemsrefund•Refund
Line Items Line Item Connection! non-null The
resources attached to the refund.- Anchor to refundShippingLinesrefund•Refund
Shipping Lines Shipping Line Connection! non-null The
resources attached to the refund.- Anchor to returnreturn•Return
The return associated with the refund.
- Anchor to staffMemberstaff•Staff
Member Member The staff member who created the refund.
- Anchor to totalRefundedSettotal•Money
Refunded Set Bag! non-null The total amount across all transactions for the refund, in shop and presentment currencies.
- Anchor to transactionstransactions•Order
Transaction Connection! non-null The transactions associated with the refund.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the refund was updated.
- Anchor to totalRefundedtotal•Money
Refunded V2! non-nullDeprecated
Anchor to QueriesQueries
- •query
Retrieves a refund by its ID. A refund represents a financial record of money returned to a customer from an order. It provides a comprehensive view of all refunded amounts, transactions, and restocking instructions associated with returning products or correcting order issues.
Use the
refundquery to retrieve information associated with the following workflows:- Displaying refund details in order management interfaces
- Building customer service tools for reviewing refund history
- Creating reports on refunded amounts and reasons
- Auditing refund transactions and payment gateway records
- Tracking inventory impacts from refunded items
A refund is associated with an order and includes refund line items that specify which items were refunded. Each refund processes through order transactions that handle the actual money transfer back to the customer.
Anchor to MutationsMutations
- •mutation
Creates a refund for an order, allowing you to process returns and issue payments back to customers.
Use the
mutation to programmatically process refunds in scenarios where you need to return money to customers, such as when handling returns, processing chargebacks, or correcting order errors.The
mutation supports various refund scenarios:- Refunding line items with optional restocking
- Refunding shipping costs
- Refunding duties and import taxes
- Refunding additional fees
- Processing refunds through different payment methods
- Issuing store credit refunds (when enabled)
You can create both full and partial refunds, and optionally allow over-refunding in specific cases.
After creating a refund, you can track its status and details through the order's
refundsfield. The refund is associated with the order and can be used for reporting and reconciliation purposes.Learn more about managing returns and refunding duties.
Note- Anchor to inputinput•Refund
Input! required The input fields that are used in the mutation for creating a refund.
Arguments
- Anchor to orderorder•Order
The order associated with the created refund.
- Anchor to refundrefund•Refund
The created refund.
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutationDeprecated
- Anchor to returnRefundInputreturn•Return
Refund Input Refund Input! required The input fields to refund a return.
Arguments
- Anchor to refundrefund•Refund
The created refund.
- Anchor to userErrorsuser•[Return
Errors User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields