Order
Requires access scope.
A change that has been applied to an order.
Anchor to Possible typesPossible types
- OrderStagedChangeAddCustomItem (OrderStagedChangeAddCustomItem)
- OrderStagedChangeAddLineItemDiscount (OrderStagedChangeAddLineItemDiscount)
- OrderStagedChangeAddShippingLine (OrderStagedChangeAddShippingLine)
- OrderStagedChangeAddVariant (OrderStagedChangeAddVariant)
- OrderStagedChangeDecrementItem (OrderStagedChangeDecrementItem)
- OrderStagedChangeIncrementItem (OrderStagedChangeIncrementItem)
- OrderStagedChangeRemoveDiscount (OrderStagedChangeRemoveDiscount)
- OrderStagedChangeRemoveShippingLine (OrderStagedChangeRemoveShippingLine)
- •OBJECT
A change to the order representing the addition of a custom line item. For example, you might want to add gift wrapping service as a custom line item.
- Anchor to originalUnitPriceoriginal•Money
Unit Price V2! non-null The price of an individual item without any discounts applied. This value can't be negative.
- Anchor to quantityquantity•Int!non-null
The quantity of the custom item to add to the order. This value must be greater than zero.
- Anchor to titletitle•String!non-null
The title of the custom item.
- •OBJECT
The discount applied to an item that was added during the current order edit.
- Anchor to descriptiondescription•String!non-null
The description of the discount.
- •ID!non-null
A globally-unique ID.
- Anchor to valuevalue•Pricing
Value! non-null The pricing value of the discount.
- •OBJECT
A new shipping line added as part of an order edit.
- Anchor to phonephone•String
The phone number at the shipping address.
- Anchor to presentmentTitlepresentment•String
Title The shipping line's title that's shown to the buyer.
- Anchor to priceprice•Money
V2! non-null The price that applies to the shipping line.
- Anchor to titletitle•String
The title of the shipping line.
- •OBJECT
A change to the order representing the addition of an existing product variant.
- Anchor to quantityquantity•Int!non-null
The quantity of the product variant that was added.
- Anchor to variantvariant•Product
Variant! non-null The product variant that was added.
- •OBJECT
An removal of items from an existing line item on the order.
- Anchor to deltadelta•Int!non-null
The number of items removed.
- Anchor to lineItemline•Line
Item Item! non-null The original line item.
- Anchor to restockrestock•Boolean!non-null
The intention to restock the removed items.
- •OBJECT
An addition of items to an existing line item on the order.
- Anchor to deltadelta•Int!non-null
The number of items added.
- Anchor to lineItemline•Line
Item Item! non-null The original line item.
- •OBJECT
A discount application removed during an order edit.
- Anchor to discountApplicationdiscount•Discount
Application Application! non-null The removed discount application.
- •OBJECT
A shipping line removed during an order edit.
- Anchor to shippingLineshipping•Shipping
Line Line! non-null The removed shipping line.
Anchor to Fields with this unionFields with this union
- •OBJECT
A line item involved in order editing that may be newly added or have new changes applied.
- •OBJECT
An order during an active edit session with all proposed changes applied but not yet committed. When you begin editing an order with the
mutation, the system creates athat shows how theOrderwill look after your changes. The calculated order tracks the original order state and all staged modifications (added or removedobjects, quantity adjustments, discount changes, andupdates). Use the calculated order to preview the financial impact of edits before committing them with themutation.Learn more about editing existing orders.
- •CONNECTION
An auto-generated type for paginating through multiple OrderStagedChanges.
- •OBJECT
An auto-generated type which holds one OrderStagedChange and a cursor during pagination.