orderEditCommit mutation

Version 2020-04 (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-01 (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.

Sign up for a Partner account to get started.

Sign up