stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > OrderInput

AdminTypes.OrderInput interface

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

Signature:

export interface OrderInput 

Properties

Property Modifiers Type Description
customAttributes?   InputMaybe<Array<AttributeInput>> (Optional) A new list of custom attributes for the order. Overwrites the existing custom attributes.
email?   InputMaybe<Scalars[‘String’][‘input’]> (Optional) A new customer email address for the order. Overwrites the existing email address.
id   Scalars[‘ID’][‘input’] The ID of the order to update.
localizationExtensions?   InputMaybe<Array<LocalizationExtensionInput>> (Optional) 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?   InputMaybe<Array<MetafieldInput>> (Optional) A list of new metafields to add to the existing metafields for the order.
note?   InputMaybe<Scalars[‘String’][‘input’]> (Optional) The new contents for the note associated with the order. Overwrites the existing note.
poNumber?   InputMaybe<Scalars[‘String’][‘input’]> (Optional) The new purchase order number for the order.
shippingAddress?   InputMaybe<MailingAddressInput> (Optional) The new shipping address for the order. Overwrites the existing shipping address.
tags?   InputMaybe<Array<Scalars[‘String’][‘input’]>> (Optional) A new list of tags for the order. Overwrites the existing tags.