Refund
The input fields to create a refund.
Anchor to FieldsFields
- Anchor to allowOverRefundingallow•Boolean
Over Refunding Default:false Whether to allow the total refunded amount to surpass the amount paid for the order.
- 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.
- Anchor to discrepancyReasondiscrepancy•Order
Reason Adjustment Input Discrepancy Reason An optional reason for a discrepancy between calculated and actual refund amounts.
- 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 refundAdditionalFeesrefund•[Refund
Additional Fees Additional Fee Input!] A list of additional fees to refund.
- Anchor to refundDutiesrefund•[Refund
Duties Duty Input!] A list of duties to refund.
- Anchor to refundLineItemsrefund•[Refund
Line Items Line Item Input!] A list of line items to refund.
- Anchor to refundMethodsrefund•[Refund
Methods Method Input!] Default:[] A list of instructions to process the financial outcome of the refund.
- Anchor to shippingshipping•Shipping
Refund Input The input fields that are required to reimburse shipping costs.
- Anchor to transactionstransactions•[Order
Transaction Input!] A list of transactions involved in the refund.