Refund Create Payload
Return type for mutation.
Anchor to FieldsFields
- order (Order)
- refund (Refund)
- userErrors ([UserError!]!)
- 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.
Anchor to Mutations with this payloadMutations with this payload
- refundCreate (RefundCreatePayload)
- •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.
NoteNote: The refunding behavior of the <code><span class="PreventFireFoxApplyingGapToWBR">refund<wbr/>Create</span></code> mutation is similar to the <a href="https://shopify.dev/docs/api/admin-graphql/latest/mutations/returnRefund"><code><span class="PreventFireFoxApplyingGapToWBR">refund<wbr/>Return</span></code></a> mutation. The key difference is that the <code><span class="PreventFireFoxApplyingGapToWBR">refund<wbr/>Create</span></code> mutation lets you to specify restocking behavior for line items, whereas the <code><span class="PreventFireFoxApplyingGapToWBR">return<wbr/>Refund</span></code> mutation focuses solely on handling the financial refund without any restocking input.
CautionAs of 2026-01, this mutation supports an optional idempotency key using the
@idempotentdirective. As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.Caution:As of 2026-01, this mutation supports an optional idempotency key using the
@idempotentdirective. As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.Caution: As of 2026-01, this mutation supports an optional idempotency key using the <code>@idempotent</code> directive. As of 2026-04, the idempotency key is required and must be provided using the <code>@idempotent</code> directive. For more information, see the <a href="https://shopify.dev/docs/api/usage/idempotent-requests">idempotency documentation</a>.
- Anchor to inputinput•Refund
Input! required The input fields that are used in the mutation for creating a refund.
Arguments