orderEditCommit mutation
Applies and saves staged changes to an order.
Required access
write_order_edits
access scope.
On this page
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
|
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.
Applies and saves staged changes to an order.
Required access
write_order_edits
access scope.
On this page
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
|
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.
Applies and saves staged changes to an order.
Required access
write_order_edits
access scope.
On this page
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
|
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.
Applies and saves staged changes to an order.
Required access
write_order_edits
access scope.
On this page
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
|
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.
Applies and saves staged changes to an order.
Required access
write_order_edits
access scope.
On this page
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
|
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.
Applies and saves staged changes to an order.
Required access
write_order_edits
access scope.
On this page
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
|
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.
Applies and saves staged changes to an order.
Required access
write_order_edits
access scope.
On this page
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
|
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.
Applies and saves staged changes to an order.
Required access
write_order_edits
access scope.
On this page
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
|
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.
Applies and saves staged changes to an order.
Required access
write_order_edits
access scope.
On this page
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
|
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.
Applies and saves staged changes to an order.
Required access
write_order_edits
access scope.
On this page
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
|
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.
Applies and saves staged changes to an order.
Required access
write_order_edits
access scope.
On this page
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
|
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.