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

draftOrderComplete mutation

Version unstable

Completes a draft order and creates an order.

Required access

write_draft_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
id ( ID! ) required

Specifies the draft order to complete.
paymentPending ( Boolean )

Specifies whether the payment is pending or not.
Default value: false

Return fields

  • draftOrder (DraftOrder)

    The completed draft order.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-07 (Release candidate)

Completes a draft order and creates an order.

Required access

write_draft_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
id ( ID! ) required

Specifies the draft order to complete.
paymentPending ( Boolean )

Specifies whether the payment is pending or not.
Default value: false

Return fields

  • draftOrder (DraftOrder)

    The completed draft order.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Latest)

Completes a draft order and creates an order.

Required access

write_draft_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
id ( ID! ) required

Specifies the draft order to complete.
paymentPending ( Boolean )

Specifies whether the payment is pending or not.
Default value: false

Return fields

  • draftOrder (DraftOrder)

    The completed draft order.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01

Completes a draft order and creates an order.

Required access

write_draft_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
id ( ID! ) required

Specifies the draft order to complete.
paymentPending ( Boolean )

Specifies whether the payment is pending or not.
Default value: false

Return fields

  • draftOrder (DraftOrder)

    The completed draft order.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Completes a draft order and creates an order.

Required access

write_draft_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
id ( ID! ) required

Specifies the draft order to complete.
paymentPending ( Boolean )

Specifies whether the payment is pending or not.
Default value: false

Return fields

  • draftOrder (DraftOrder)

    The completed draft order.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

Completes a draft order and creates an order.

Required access

write_draft_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
id ( ID! ) required

Specifies the draft order to complete.
paymentPending ( Boolean )

Specifies whether the payment is pending or not.
Default value: false

Return fields

  • draftOrder (DraftOrder)

    The completed draft order.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04

Completes a draft order and creates an order.

Required access

write_draft_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
id ( ID! ) required

Specifies the draft order to complete.
paymentPending ( Boolean )

Specifies whether the payment is pending or not.
Default value: false

Return fields

  • draftOrder (DraftOrder)

    The completed draft order.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

Completes a draft order and creates an order.

Required access

write_draft_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
id ( ID! ) required

Specifies the draft order to complete.
paymentPending ( Boolean )

Specifies whether the payment is pending or not.
Default value: false

Return fields

  • draftOrder (DraftOrder)

    The completed draft order.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Completes a draft order and creates an order.

Required access

write_draft_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
id ( ID! ) required

Specifies the draft order to complete.
paymentPending ( Boolean )

Specifies whether the payment is pending or not.
Default value: false

Return fields

  • draftOrder (DraftOrder)

    The completed draft order.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Completes a draft order and creates an order.

Required access

write_draft_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
id ( ID! ) required

Specifies the draft order to complete.
paymentPending ( Boolean )

Specifies whether the payment is pending or not.
Default value: false

Return fields

  • draftOrder (DraftOrder)

    The completed draft order.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Completes a draft order and creates an order.

Required access

write_draft_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
id ( ID! ) required

Specifies the draft order to complete.
paymentPending ( Boolean )

Specifies whether the payment is pending or not.
Default value: false

Return fields

  • draftOrder (DraftOrder)

    The completed draft order.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.