OrderInput - admin-graphql - INPUT_OBJECT

Version: unstable

Description:

The input fields for specifying the information to be updated on an order when using the orderUpdate mutation.

Access Scopes

Fields

  • customAttributes: AttributeInput - A new list of custom attributes for the order. Overwrites the existing custom attributes.
  • email: String - A new customer email address for the order. Overwrites the existing email address.
  • id: ID! - The ID of the order to update.
  • localizationExtensions: LocalizationExtensionInput - A list of new [localization extensions](https://shopify.dev/api/admin-graphql/latest/objects/localizationextension) to add to the existing list of localization extensions for the order.
  • metafields: MetafieldInput - A list of new metafields to add to the existing metafields for the order.
  • note: String - The new contents for the note associated with the order. Overwrites the existing note.
  • poNumber: String - The new purchase order number for the order.
  • privateMetafields: PrivateMetafieldInput - A list of new private metafields to add to the existing private metafields for the order.
  • shippingAddress: MailingAddressInput - The new shipping address for the order. Overwrites the existing shipping address.
  • tags: String - A new list of tags for the order. Overwrites the existing tags.

Input objects with this input object

  • orderUpdate

Examples