CalculatedLineItem - admin-graphql - OBJECT

Version: 2024-10

Description:

A line item involved in order editing that may be newly added or have new changes applied.

Access Scopes

`read_order_edits` access scope.

Fields

  • calculatedDiscountAllocations: CalculatedDiscountAllocation! - The discounts that have been allocated onto the line item by discount applications.
  • customAttributes: Attribute! - A list of attributes that represent custom features or special requests.
  • discountAllocations: DiscountAllocation! - The discounts that have been allocated onto the line item by discount applications.
  • discountedUnitPriceSet: MoneyBag! - The price of a single quantity of the line item with line item discounts applied, in shop and presentment currencies. Discounts applied to the entire order aren't included in this price.
  • editableQuantity: Int! - The total number of items that can be edited.
  • editableQuantityBeforeChanges: Int! - The editable quantity prior to any changes made in the current edit.
  • editableSubtotalSet: MoneyBag! - The total price of editable lines in shop and presentment currencies.
  • hasStagedLineItemDiscount: Boolean! - Whether the calculated line item has a staged discount.
  • id: ID! - A globally-unique ID.
  • image: Image - The image object associated to the line item's variant.
  • originalUnitPriceSet: MoneyBag! - The variant unit price in shop and presentment currencies, without any discounts applied.
  • quantity: Int! - The total number of items.
  • restockable: Boolean! - Whether the line item can be restocked or not.
  • restocking: Boolean! - Whether the changes on the line item will result in a restock.
  • sku: String - The variant SKU number.
  • stagedChanges: OrderStagedChange! - A list of changes that affect this line item.
  • title: String! - The title of the product.
  • uneditableSubtotalSet: MoneyBag! - The total price of uneditable lines in shop and presentment currencies.
  • variant: ProductVariant - The product variant associated with this line item. The value is null for custom line items and items where the variant has been deleted.
  • variantTitle: String - The title of the variant.

Connections

Related queries

Related mutations

  • orderEditAddCustomItem Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a [custom line item](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing#add-a-custom-line-item). To learn how to edit existing orders, refer to [Edit an existing order with Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).
  • orderEditAddLineItemDiscount Adds a discount to a line item on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).
  • orderEditAddVariant Adds a line item from an existing product variant.
  • orderEditRemoveLineItemDiscount Removes a line item discount that was applied as part of an order edit.
  • orderEditSetQuantity Sets the quantity of a line item on an order that is being edited. For more information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).

Related Unions

Examples