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

orderEditCommit mutation

Version unstable

Applies and saves staged changes to an order.

Required access

write_order_edits 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

id ( ID! ) required

The ID of the calculated order that will have its changes applied to the order.

notifyCustomer ( Boolean )

Whether to notify the customer or not.

staffNote ( String )

Note for staff members.

Return fields

order (Order)

The order with changes applied.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Applies and saves staged changes to an order.

Required access

write_order_edits 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

id ( ID! ) required

The ID of the calculated order that will have its changes applied to the order.

notifyCustomer ( Boolean )

Whether to notify the customer or not.

staffNote ( String )

Note for staff members.

Return fields

order (Order)

The order with changes applied.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-10 (Latest)

Applies and saves staged changes to an order.

Required access

write_order_edits 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

id ( ID! ) required

The ID of the calculated order that will have its changes applied to the order.

notifyCustomer ( Boolean )

Whether to notify the customer or not.

staffNote ( String )

Note for staff members.

Return fields

order (Order)

The order with changes applied.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-07

Applies and saves staged changes to an order.

Required access

write_order_edits 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

id ( ID! ) required

The ID of the calculated order that will have its changes applied to the order.

notifyCustomer ( Boolean )

Whether to notify the customer or not.

staffNote ( String )

Note for staff members.

Return fields

order (Order)

The order with changes applied.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-04

Applies and saves staged changes to an order.

Required access

write_order_edits 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

id ( ID! ) required

The ID of the calculated order that will have its changes applied to the order.

notifyCustomer ( Boolean )

Whether to notify the customer or not.

staffNote ( String )

Note for staff members.

Return fields

order (Order)

The order with changes applied.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-01

Applies and saves staged changes to an order.

Required access

write_order_edits 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

id ( ID! ) required

The ID of the calculated order that will have its changes applied to the order.

notifyCustomer ( Boolean )

Whether to notify the customer or not.

staffNote ( String )

Note for staff members.

Return fields

order (Order)

The order with changes applied.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Applies and saves staged changes to an order.

Required access

write_order_edits 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

id ( ID! ) required

The ID of the calculated order that will have its changes applied to the order.

notifyCustomer ( Boolean )

Whether to notify the customer or not.

staffNote ( String )

Note for staff members.

Return fields

order (Order)

The order with changes applied.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Applies and saves staged changes to an order.

Required access

write_order_edits 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

id ( ID! ) required

The ID of the calculated order that will have its changes applied to the order.

notifyCustomer ( Boolean )

Whether to notify the customer or not.

staffNote ( String )

Note for staff members.

Return fields

order (Order)

The order with changes applied.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Applies and saves staged changes to an order.

Required access

write_order_edits 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

id ( ID! ) required

The ID of the calculated order that will have its changes applied to the order.

notifyCustomer ( Boolean )

Whether to notify the customer or not.

staffNote ( String )

Note for staff members.

Return fields

order (Order)

The order with changes applied.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.