RefundDetailsInput
Version 2024-04-01
Overview
Details for updating a refund that has been issued.
Note: The type currently doesn't capture reasons why a refund is being issued i.e. refunds for items on the order or specific charges like delivery charges, taxes etc. That will be added as we support more use-cases for creating/updating refunds.
Arguments
Argument | Description |
---|---|
aliases ([AliasInput]) | Aliases referencing a refund in an external system. |
id (ID) | Unique identifier for a refund. |
paymentDetails ([PaymentDetailsInput]) | A list of payment details that are applicable for a refund. This type allows capturing multiple payments that can be issued on a refund. It should only capture the payment details for this refund in the current update. For example, for a refund, if a previous refund update was done for 5$ and, this is another refund update for 3$, paymentDetails provided should be 3$. |
refundFor (RefundForInput) | Captures the reason for which this refund is entitled to e.g. refunds against a lineItem, a return etc. |
refundTotal (RefundTotalInput required) | Represents the money value of the total amount that has been refunded for this refund. It should also include any previous amount that was refunded. For example, for a refund, if a previous refund update was done for 5$ and, this is another refund update for 3$, refundTotal provided should be 8$. |
state (RefundStateInput) | Indicates the state of the refund. |
Updated about 2 months ago