RefundInput

Version 2019-04

Specifies the fields to create a refund.

Show definition
"""
Specifies the fields to create a refund.
"""
input RefundInput {
  """
  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.
  """
  currency: CurrencyCode
  """
  An optional note attached to a refund.
  """
  note: String
  """
  Whether to send a refund notification to the customer.
  """
  notify: Boolean
  """
  Order ID for which the refund is created.
  """
  orderId: ID!
  """
  A list of line items to refund.
  """
  refundLineItems: [RefundLineItemInput!]
  """
  Whether to add the line items back to the store's inventory. This argument is
  deprecated: Use `restockType` on `RefundLineItemInput` on field
  `refundLineItems` instead.
  """
  restock: Boolean
  """
  Specifies how much of the shipping cost to refund.
  """
  shipping: ShippingRefundInput
  """
  A list of transactions involved in the refund.
  """
  transactions: [OrderTransactionInput!]
}

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.

restock (Boolean)

Whether to add the line items back to the store's inventory. This argument is deprecated: Use restockType on RefundLineItemInput on field refundLineItems instead.

shipping (ShippingRefundInput)

Specifies how much of the shipping cost to refund.

transactions ([OrderTransactionInput!])

A list of transactions involved in the refund.

Version 2019-07 (Latest)

Specifies the fields to create a refund.

Show definition
"""
Specifies the fields to create a refund.
"""
input RefundInput {
  """
  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.
  """
  currency: CurrencyCode
  """
  An optional note attached to a refund.
  """
  note: String
  """
  Whether to send a refund notification to the customer.
  """
  notify: Boolean
  """
  Order ID for which the refund is created.
  """
  orderId: ID!
  """
  A list of line items to refund.
  """
  refundLineItems: [RefundLineItemInput!]
  """
  Whether to add the line items back to the store's inventory. This argument is
  deprecated: Use restockType on RefundLineItemInput on field
  refundLineItems instead.
  """
  restock: Boolean
  """
  Specifies how much of the shipping cost to refund.
  """
  shipping: ShippingRefundInput
  """
  A list of transactions involved in the refund.
  """
  transactions: [OrderTransactionInput!]
}

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.

restock (Boolean)

Whether to add the line items back to the store's inventory. This argument is deprecated: Use restockType on RefundLineItemInput on field refundLineItems instead.

shipping (ShippingRefundInput)

Specifies how much of the shipping cost to refund.

transactions ([OrderTransactionInput!])

A list of transactions involved in the refund.

Version 2019-10 (Release candidate)

Specifies the fields to create a refund.

Show definition
"""
Specifies the fields to create a refund.
"""
input RefundInput {
  """
  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.
  """
  currency: CurrencyCode
  """
  An optional note attached to a refund.
  """
  note: String
  """
  Whether to send a refund notification to the customer.
  """
  notify: Boolean
  """
  Order ID for which the refund is created.
  """
  orderId: ID!
  """
  A list of line items to refund.
  """
  refundLineItems: [RefundLineItemInput!]
  """
  Whether to add the line items back to the store's inventory. This argument is
  deprecated: Use restockType on RefundLineItemInput on field
  refundLineItems instead.
  """
  restock: Boolean
  """
  Specifies how much of the shipping cost to refund.
  """
  shipping: ShippingRefundInput
  """
  A list of transactions involved in the refund.
  """
  transactions: [OrderTransactionInput!]
}

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.

restock (Boolean)

Whether to add the line items back to the store's inventory. This argument is deprecated: Use restockType on RefundLineItemInput on field refundLineItems instead.

shipping (ShippingRefundInput)

Specifies how much of the shipping cost to refund.

transactions ([OrderTransactionInput!])

A list of transactions involved in the refund.

Sign up for a Partner account to get started.

Sign up