orderClose mutation
Closes an open order.
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
(
OrderCloseInput!
)
required
|
The input for the mutation. |
OrderCloseInput fields
id
(ID!)
Required
|
The ID of the order to close. |
Return fields
order
(Order)
|
The closed order. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Closes an open order.
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
(
OrderCloseInput!
)
required
|
The input for the mutation. |
OrderCloseInput fields
id
(ID!)
Required
|
The ID of the order to close. |
Return fields
order
(Order)
|
The closed order. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Closes an open order.
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
(
OrderCloseInput!
)
required
|
The input for the mutation. |
OrderCloseInput fields
id
(ID!)
Required
|
The ID of the order to close. |
Return fields
order
(Order)
|
The closed order. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Closes an open order.
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
(
OrderCloseInput!
)
required
|
The input for the mutation. |
OrderCloseInput fields
id
(ID!)
Required
|
The ID of the order to close. |
Return fields
order
(Order)
|
The closed order. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |