API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

RefundInput input object

Version unstable

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!) Required

    Order 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.

Version 2021-04 (Release candidate)

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!) Required

    Order 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.

Version 2021-01 (Latest)

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!) Required

    Order 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.

Version 2020-10

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!) Required

    Order 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.

Version 2020-07

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!) Required

    Order 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.

Version 2020-04

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!) Required

    Order 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.

Version 2020-01 (Unsupported)

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!) Required

    Order 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.

Version 2019-10 (Unsupported)

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!) Required

    Order 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.

Version 2019-07 (Unsupported)

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!) Required

    Order 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.

Version 2019-04 (Unsupported)

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!) Required

    Order 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.