We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

orderUpdate

Version 2019-04

Updates an order.

Required access

write_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

input ( OrderInput! ) required

The input for the mutation.

Input 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!) Required

The ID of the order to update.

note (String)

The order note.

shippingAddress (MailingAddressInput)

The shipping address associated with the order.

tags ([String!])

The order tags.

Return Fields

order (Order)

The updated order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Latest)

Updates an order.

Required access

write_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

input ( OrderInput! ) required

The input for the mutation.

Input 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!) Required

The 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!])

The order tags.

Return Fields

order (Order)

The updated order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Release candidate)

Updates an order.

Required access

write_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

input ( OrderInput! ) required

The input for the mutation.

Input 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!) Required

The 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!])

The order tags.

Return Fields

order (Order)

The updated order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up