orderClose mutation

Version unstable

Closes an open order.

Required access

write_orders access scope.

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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Closes an open order.

Required access

write_orders access scope.

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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-07 (Latest)

Closes an open order.

Required access

write_orders access scope.

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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-04

Closes an open order.

Required access

write_orders access scope.

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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-01

Closes an open order.

Required access

write_orders access scope.

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

Argument Description
input ( OrderCloseInput! ) required

The input for the mutation.