refundCreate mutation
Creates a refund.
Required access
write_orders access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
input
(
RefundInput!
)
required
|
The input fields for the mutation. |
RefundInput 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. |
Return fields
order
(Order)
|
The order associated with the created refund. |
refund
(Refund)
|
The created refund. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Creates a refund.
Required access
write_orders access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
input
(
RefundInput!
)
required
|
The input fields for the mutation. |
RefundInput 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. |
Return fields
order
(Order)
|
The order associated with the created refund. |
refund
(Refund)
|
The created refund. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Creates a refund.
Required access
write_orders access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
input
(
RefundInput!
)
required
|
The input fields for the mutation. |
RefundInput 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. |
Return fields
order
(Order)
|
The order associated with the created refund. |
refund
(Refund)
|
The created refund. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Creates a refund.
Required access
write_orders access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
input
(
RefundInput!
)
required
|
The input fields for the mutation. |
RefundInput 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. |
Return fields
order
(Order)
|
The order associated with the created refund. |
refund
(Refund)
|
The created refund. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Creates a refund.
Required access
write_orders access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
input
(
RefundInput!
)
required
|
The input fields for the mutation. |
RefundInput 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. |
Return fields
order
(Order)
|
The order associated with the created refund. |
refund
(Refund)
|
The created refund. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Creates a refund.
Required access
write_orders access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
input
(
RefundInput!
)
required
|
The input fields for the mutation. |
RefundInput 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. |
Return fields
order
(Order)
|
The order associated with the created refund. |
refund
(Refund)
|
The created refund. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Creates a refund.
Required access
write_orders access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
input
(
RefundInput!
)
required
|
The input fields for the mutation. |
RefundInput 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. |
Return fields
order
(Order)
|
The order associated with the created refund. |
refund
(Refund)
|
The created refund. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Creates a refund.
Required access
write_orders access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
input
(
RefundInput!
)
required
|
The input fields for the mutation. |
RefundInput 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. |
Return fields
order
(Order)
|
The order associated with the created refund. |
refund
(Refund)
|
The created refund. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Creates a refund.
Required access
write_orders access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
input
(
RefundInput!
)
required
|
The input fields for the mutation. |
RefundInput 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. |
Return fields
order
(Order)
|
The order associated with the created refund. |
refund
(Refund)
|
The created refund. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |