Refund
The input fields to create a refund.
Anchor to FieldsFields
- allowOverRefunding (Boolean)
- currency (CurrencyCode)
- discrepancyReason (OrderAdjustmentInputDiscrepancyReason)
- note (String)
- notify (Boolean)
- orderId (ID!)
- processedAt (DateTime)
- refundDuties ([RefundDutyInput!])
- refundLineItems ([RefundLineItemInput!])
- refundMethods ([RefundMethodInput!])
- shipping (ShippingRefundInput)
- transactions ([OrderTransactionInput!])
- Anchor to allowOverRefundingallow•Boolean
Over Refunding Default:false Whether refunds to the original payment method can cause the total refunded amount, including previously issued store credit, to exceed the amount paid for the order. Refunds issued as store credit can't exceed the amount paid.
- Anchor to currencycurrency•Currency
Code The currency that is used to refund the order. This must be the presentment currency, which is the currency used by the customer. This is a required field for orders where the currency and presentment currency differ.
Show enum values
- Anchor to discrepancyReasondiscrepancy•Order
Reason Adjustment Input Discrepancy Reason An optional reason for a discrepancy between calculated and actual refund amounts.
Show enum values
- Anchor to notenote•String
An optional note that's attached to the refund.
- Anchor to notifynotify•Boolean
Whether to send a refund notification to the customer.
- Anchor to orderIdorder•ID!
Id non-null The ID of the order that's being refunded.
- Anchor to processedAtprocessed•Date
At Time The date and time when the refund is being processed. If not provided, it will be set to the current time.
- Anchor to refundDutiesrefund•[Refund
Duties Duty Input!] A list of duties to refund.
Show input fields
- Anchor to refundLineItemsrefund•[Refund
Line Items Line Item Input!] A list of line items to refund.
Show input fields
- Anchor to refundMethodsrefund•[Refund
Methods Method Input!] Default:[] A list of instructions to process the financial outcome of the refund.
Show input fields
- Anchor to shippingshipping•Shipping
Refund Input The input fields that are required to reimburse shipping costs.
Show input fields
- Anchor to transactionstransactions•[Order
Transaction Input!] A list of transactions involved in the refund.
Show input fields