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 from executing the mutation.

Version 2021-10 (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 from executing the mutation.

Version 2021-07 (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.