Home > @infiniteobjects/shopify-data-manager > AdminTypes > RefundInput
The input fields to create a refund.
Signature:
export interface RefundInput
Property | Modifiers | Type | Description |
---|---|---|---|
currency? | InputMaybe<CurrencyCode | `${CurrencyCode}`> | (Optional) 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. | |
note? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) An optional note that’s attached to the refund. | |
notify? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) Whether to send a refund notification to the customer. | |
orderId | Scalars[‘ID’][‘input’] | The ID of the order that’s being refunded. | |
refundDuties? | InputMaybe<Array<RefundDutyInput>> | (Optional) A list of duties to refund. | |
refundLineItems? | InputMaybe<Array<RefundLineItemInput>> | (Optional) A list of line items to refund. | |
shipping? | InputMaybe<ShippingRefundInput> | (Optional) The input fields that are required to reimburse shipping costs. | |
transactions? | InputMaybe<Array<OrderTransactionInput>> | (Optional) A list of transactions involved in the refund. |