Order
Return type for mutation.
Anchor to FieldsFields
- Anchor to orderorder•Order
The order with changes applied.
- Anchor to successMessagessuccess•[String!]
Messages Messages to display to the user after the staged changes are commmitted.
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
Anchor to Mutations with this payloadMutations with this payload
- •mutation
Applies staged changes from an order editing session to the original order. This finalizes all modifications made during the edit session, including changes to line items, quantities, discounts, and shipping lines.
Order editing follows a three-step workflow: start with
to create an editing session, apply changes using various orderEdit mutations, and then save the changes with themutation. The mutation can optionally notify the customer of changes and add staff notes for internal tracking.You can only edit unfulfilled line items. If an edit changes the total order value, then the customer might need to pay a balance or receive a refund.
Learn more about editing existing orders.
- •ID!required
The ID of the calculated order or the order edit session that will have its changes applied to the order.
- Anchor to notifyCustomernotify•Boolean
Customer Whether to notify the customer or not.
- Anchor to staffNotestaff•String
Note Note for staff members.
Arguments
- •ID!