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.

OrderInput

Version 2019-04

Specifies the information to be updated on the requested order.

Show definition
"""
Specifies the information to be updated on the requested order.
"""
input OrderInput {
  """
  Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
  """
  customAttributes: [AttributeInput!]
  """
  The email address associated with the order.
  """
  email: String
  """
  The ID of the order to update.
  """
  id: ID!
  """
  The order note.
  """
  note: String
  """
  The shipping address associated with the order.
  """
  shippingAddress: MailingAddressInput
  """
  The order tags.
  """
  tags: [String!]
}

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.

Version 2019-07 (Latest)

Specifies the information to be updated on the requested order.

Show definition
"""
Specifies the information to be updated on the requested order.
"""
input OrderInput {
  """
  Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
  """
  customAttributes: [AttributeInput!]
  """
  The email address associated with the order.
  """
  email: String
  """
  The ID of the order to update.
  """
  id: ID!
  """
  The metafields to associate with this order.
  """
  metafields: [MetafieldInput!]
  """
  The order note.
  """
  note: String
  """
  The shipping address associated with the order.
  """
  shippingAddress: MailingAddressInput
  """
  The order tags.
  """
  tags: [String!]
}

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.

Version 2019-10 (Release candidate)

Specifies the information to be updated on the requested order.

Show definition
"""
Specifies the information to be updated on the requested order.
"""
input OrderInput {
  """
  Custom information to add to the order, represented as a key value pair. Also referred to as note attributes.
  """
  customAttributes: [AttributeInput!]
  """
  The email address associated with the order.
  """
  email: String
  """
  The ID of the order to update.
  """
  id: ID!
  """
  The metafields to associate with this order.
  """
  metafields: [MetafieldInput!]
  """
  The order note.
  """
  note: String
  """
  The shipping address associated with the order.
  """
  shippingAddress: MailingAddressInput
  """
  The order tags.
  """
  tags: [String!]
}

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.

Sign up for a Partner account to get started.

Sign up