orderUpdate mutation
Updates an order.
Required access
write_orders
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 |
---|---|
input
(
OrderInput!
)
required
|
The input for the mutation. |
OrderInput fields
-
customAttributes (
[AttributeInput!]
)Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
-
email (
String
)The email address associated with the order.
-
id (
ID!
) RequiredThe ID of the order to update.
-
localizationExtensions (
[LocalizationExtensionInput!]
)The localization extensions attached to the order. For example, Tax IDs.
-
metafields (
[MetafieldInput!]
)The metafields to associate with this order.
-
note (
String
)The order note.
-
privateMetafields (
[PrivateMetafieldInput!]
)The private metafields attached to the order.
-
shippingAddress (
MailingAddressInput
)The shipping address associated with the order.
-
tags (
[String!]
)A comma separated list of tags that have been added to the order.
Return fields
-
order (
Order
)The updated order.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
Updates an order.
Required access
write_orders
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 |
---|---|
input
(
OrderInput!
)
required
|
The input for the mutation. |
OrderInput fields
-
customAttributes (
[AttributeInput!]
)Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
-
email (
String
)The email address associated with the order.
-
id (
ID!
) RequiredThe ID of the order to update.
-
localizationExtensions (
[LocalizationExtensionInput!]
)The localization extensions attached to the order. For example, Tax IDs.
-
metafields (
[MetafieldInput!]
)The metafields to associate with this order.
-
note (
String
)The order note.
-
shippingAddress (
MailingAddressInput
)The shipping address associated with the order.
-
tags (
[String!]
)A comma separated list of tags that have been added to the order.
Return fields
-
order (
Order
)The updated order.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
Updates an order.
Required access
write_orders
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 |
---|---|
input
(
OrderInput!
)
required
|
The input for the mutation. |
OrderInput fields
-
customAttributes (
[AttributeInput!]
)Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
-
email (
String
)The email address associated with the order.
-
id (
ID!
) RequiredThe ID of the order to update.
-
localizationExtensions (
[LocalizationExtensionInput!]
)The localization extensions attached to the order. For example, Tax IDs.
-
metafields (
[MetafieldInput!]
)The metafields to associate with this order.
-
note (
String
)The order note.
-
shippingAddress (
MailingAddressInput
)The shipping address associated with the order.
-
tags (
[String!]
)A comma separated list of tags that have been added to the order.
Return fields
-
order (
Order
)The updated order.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
Updates an order.
Required access
write_orders
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 |
---|---|
input
(
OrderInput!
)
required
|
The input for the mutation. |
OrderInput fields
-
customAttributes (
[AttributeInput!]
)Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
-
email (
String
)The email address associated with the order.
-
id (
ID!
) RequiredThe ID of the order to update.
-
metafields (
[MetafieldInput!]
)The metafields to associate with this order.
-
note (
String
)The order note.
-
shippingAddress (
MailingAddressInput
)The shipping address associated with the order.
-
tags (
[String!]
)A comma separated list of tags that have been added to the order.
Return fields
-
order (
Order
)The updated order.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
Updates an order.
Required access
write_orders
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 |
---|---|
input
(
OrderInput!
)
required
|
The input for the mutation. |
OrderInput fields
-
customAttributes (
[AttributeInput!]
)Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
-
email (
String
)The email address associated with the order.
-
id (
ID!
) RequiredThe ID of the order to update.
-
metafields (
[MetafieldInput!]
)The metafields to associate with this order.
-
note (
String
)The order note.
-
shippingAddress (
MailingAddressInput
)The shipping address associated with the order.
-
tags (
[String!]
)A comma separated list of tags that have been added to the order.
Return fields
-
order (
Order
)The updated order.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
Updates an order.
Required access
write_orders
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 |
---|---|
input
(
OrderInput!
)
required
|
The input for the mutation. |
OrderInput fields
-
customAttributes (
[AttributeInput!]
)Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
-
email (
String
)The email address associated with the order.
-
id (
ID!
) RequiredThe ID of the order to update.
-
metafields (
[MetafieldInput!]
)The metafields to associate with this order.
-
note (
String
)The order note.
-
shippingAddress (
MailingAddressInput
)The shipping address associated with the order.
-
tags (
[String!]
)A comma separated list of tags that have been added to the order.
Return fields
-
order (
Order
)The updated order.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
Updates an order.
Required access
write_orders
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 |
---|---|
input
(
OrderInput!
)
required
|
The input for the mutation. |
OrderInput fields
-
customAttributes (
[AttributeInput!]
)Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
-
email (
String
)The email address associated with the order.
-
id (
ID!
) RequiredThe ID of the order to update.
-
metafields (
[MetafieldInput!]
)The metafields to associate with this order.
-
note (
String
)The order note.
-
shippingAddress (
MailingAddressInput
)The shipping address associated with the order.
-
tags (
[String!]
)A comma separated list of tags that have been added to the order.
Return fields
-
order (
Order
)The updated order.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
Updates an order.
Required access
write_orders
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 |
---|---|
input
(
OrderInput!
)
required
|
The input for the mutation. |
OrderInput fields
-
customAttributes (
[AttributeInput!]
)Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
-
email (
String
)The email address associated with the order.
-
id (
ID!
) RequiredThe ID of the order to update.
-
metafields (
[MetafieldInput!]
)The metafields to associate with this order.
-
note (
String
)The order note.
-
shippingAddress (
MailingAddressInput
)The shipping address associated with the order.
-
tags (
[String!]
)A comma separated list of tags that have been added to the order.
Return fields
-
order (
Order
)The updated order.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
Updates an order.
Required access
write_orders
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 |
---|---|
input
(
OrderInput!
)
required
|
The input for the mutation. |
OrderInput fields
-
customAttributes (
[AttributeInput!]
)Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
-
email (
String
)The email address associated with the order.
-
id (
ID!
) RequiredThe ID of the order to update.
-
metafields (
[MetafieldInput!]
)The metafields to associate with this order.
-
note (
String
)The order note.
-
shippingAddress (
MailingAddressInput
)The shipping address associated with the order.
-
tags (
[String!]
)A comma separated list of tags that have been added to the order.
Return fields
-
order (
Order
)The updated order.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
Updates an order.
Required access
write_orders
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 |
---|---|
input
(
OrderInput!
)
required
|
The input for the mutation. |
OrderInput fields
-
customAttributes (
[AttributeInput!]
)Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
-
email (
String
)The email address associated with the order.
-
id (
ID!
) RequiredThe ID of the order to update.
-
metafields (
[MetafieldInput!]
)The metafields to associate with this order.
-
note (
String
)The order note.
-
shippingAddress (
MailingAddressInput
)The shipping address associated with the order.
-
tags (
[String!]
)A comma separated list of tags that have been added to the order.
Return fields
-
order (
Order
)The updated order.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.