RefundInput input object
Specifies the fields to create a refund.
Input fields
-
currency (
CurrencyCode
)The currency (in ISO format) that is used to refund the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.
-
note (
String
)An optional note attached to a refund.
-
notify (
Boolean
)Whether to send a refund notification to the customer.
-
orderId (
ID!
) RequiredOrder ID for which the refund is created.
-
refundDuties (
[RefundDutyInput!]
)A list of duties to refund.
-
refundLineItems (
[RefundLineItemInput!]
)A list of line items to refund.
-
shipping (
ShippingRefundInput
)Specifies how much of the shipping cost to refund.
-
transactions (
[OrderTransactionInput!]
)A list of transactions involved in the refund.
Specifies the fields to create a refund.
Input fields
-
currency (
CurrencyCode
)The currency (in ISO format) that is used to refund the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.
-
note (
String
)An optional note attached to a refund.
-
notify (
Boolean
)Whether to send a refund notification to the customer.
-
orderId (
ID!
) RequiredOrder ID for which the refund is created.
-
refundDuties (
[RefundDutyInput!]
)A list of duties to refund.
-
refundLineItems (
[RefundLineItemInput!]
)A list of line items to refund.
-
shipping (
ShippingRefundInput
)Specifies how much of the shipping cost to refund.
-
transactions (
[OrderTransactionInput!]
)A list of transactions involved in the refund.
Specifies the fields to create a refund.
Input fields
-
currency (
CurrencyCode
)The currency (in ISO format) that is used to refund the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.
-
note (
String
)An optional note attached to a refund.
-
notify (
Boolean
)Whether to send a refund notification to the customer.
-
orderId (
ID!
) RequiredOrder ID for which the refund is created.
-
refundDuties (
[RefundDutyInput!]
)A list of duties to refund.
-
refundLineItems (
[RefundLineItemInput!]
)A list of line items to refund.
-
shipping (
ShippingRefundInput
)Specifies how much of the shipping cost to refund.
-
transactions (
[OrderTransactionInput!]
)A list of transactions involved in the refund.
Specifies the fields to create a refund.
Input fields
-
currency (
CurrencyCode
)The currency (in ISO format) that is used to refund the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.
-
note (
String
)An optional note attached to a refund.
-
notify (
Boolean
)Whether to send a refund notification to the customer.
-
orderId (
ID!
) RequiredOrder ID for which the refund is created.
-
refundDuties (
[RefundDutyInput!]
)A list of duties to refund.
-
refundLineItems (
[RefundLineItemInput!]
)A list of line items to refund.
-
shipping (
ShippingRefundInput
)Specifies how much of the shipping cost to refund.
-
transactions (
[OrderTransactionInput!]
)A list of transactions involved in the refund.
Specifies the fields to create a refund.
Input fields
-
currency (
CurrencyCode
)The currency (in ISO format) that is used to refund the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.
-
note (
String
)An optional note attached to a refund.
-
notify (
Boolean
)Whether to send a refund notification to the customer.
-
orderId (
ID!
) RequiredOrder ID for which the refund is created.
-
refundDuties (
[RefundDutyInput!]
)A list of duties to refund.
-
refundLineItems (
[RefundLineItemInput!]
)A list of line items to refund.
-
shipping (
ShippingRefundInput
)Specifies how much of the shipping cost to refund.
-
transactions (
[OrderTransactionInput!]
)A list of transactions involved in the refund.
Specifies the fields to create a refund.
Input fields
-
currency (
CurrencyCode
)The currency (in ISO format) that is used to refund the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.
-
note (
String
)An optional note attached to a refund.
-
notify (
Boolean
)Whether to send a refund notification to the customer.
-
orderId (
ID!
) RequiredOrder ID for which the refund is created.
-
refundDuties (
[RefundDutyInput!]
)A list of duties to refund.
-
refundLineItems (
[RefundLineItemInput!]
)A list of line items to refund.
-
shipping (
ShippingRefundInput
)Specifies how much of the shipping cost to refund.
-
transactions (
[OrderTransactionInput!]
)A list of transactions involved in the refund.
Specifies the fields to create a refund.
Input fields
-
currency (
CurrencyCode
)The currency (in ISO format) that is used to refund the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.
-
note (
String
)An optional note attached to a refund.
-
notify (
Boolean
)Whether to send a refund notification to the customer.
-
orderId (
ID!
) RequiredOrder ID for which the refund is created.
-
refundLineItems (
[RefundLineItemInput!]
)A list of line items to refund.
-
shipping (
ShippingRefundInput
)Specifies how much of the shipping cost to refund.
-
transactions (
[OrderTransactionInput!]
)A list of transactions involved in the refund.
Specifies the fields to create a refund.
Input fields
-
currency (
CurrencyCode
)The currency (in ISO format) that is used to refund the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.
-
note (
String
)An optional note attached to a refund.
-
notify (
Boolean
)Whether to send a refund notification to the customer.
-
orderId (
ID!
) RequiredOrder ID for which the refund is created.
-
refundLineItems (
[RefundLineItemInput!]
)A list of line items to refund.
-
shipping (
ShippingRefundInput
)Specifies how much of the shipping cost to refund.
-
transactions (
[OrderTransactionInput!]
)A list of transactions involved in the refund.
Specifies the fields to create a refund.
Input fields
-
currency (
CurrencyCode
)The currency (in ISO format) that is used to refund the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.
-
note (
String
)An optional note attached to a refund.
-
notify (
Boolean
)Whether to send a refund notification to the customer.
-
orderId (
ID!
) RequiredOrder ID for which the refund is created.
-
refundLineItems (
[RefundLineItemInput!]
)A list of line items to refund.
-
shipping (
ShippingRefundInput
)Specifies how much of the shipping cost to refund.
-
transactions (
[OrderTransactionInput!]
)A list of transactions involved in the refund.
Specifies the fields to create a refund.
Input fields
-
currency (
CurrencyCode
)The currency (in ISO format) that is used to refund the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.
-
note (
String
)An optional note attached to a refund.
-
notify (
Boolean
)Whether to send a refund notification to the customer.
-
orderId (
ID!
) RequiredOrder ID for which the refund is created.
-
refundLineItems (
[RefundLineItemInput!]
)A list of line items to refund.
-
shipping (
ShippingRefundInput
)Specifies how much of the shipping cost to refund.
-
transactions (
[OrderTransactionInput!]
)A list of transactions involved in the refund.