LineItem

Version 2019-04 (latest)

Represents a single line in a shopping cart.

Required access

read_orders access scope

Show definition

"""
Represents a single line in a shopping cart.
"""
type LineItem implements Node {
  """
  Whether the line item's variant has an ID and inventory is managed by Shopify.
  """
  canRestock: Boolean!
  """
  List of additional information (metafields) about the line item.
  """
  customAttributes: [Attribute!]!
  """
  The discounts that have been allocated onto the line item by discount applications.
  """
  discountAllocations: [DiscountAllocation!]!
  """
  The total line price after discounts are applied.
  """
  discountedTotal: Money!
  """
  The total line price after discounts are applied in shop and presentment currencies.
  """
  discountedTotalSet: MoneyBag!
  """
  The price of a single variant unit after discounts are applied.
  """
  discountedUnitPrice: Money!
  """
  The price of a single variant unit after discounts are applied in shop and presentment currencies.
  """
  discountedUnitPriceSet: MoneyBag!
  """
  The total number of units to fulfill.
  """
  fulfillableQuantity: Int!
  """
  Name of the service provider who fulfilled the order.
  Valid values are either manual or the name of the provider.
  For example, amazon, shipwire.
  """
  fulfillmentService: FulfillmentService!
  """
  The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity,
  'partial' if  fulfillableQuantity > 0, and 'unfulfilled' otherwise.
  """
  fulfillmentStatus: String!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The Image object associated to the line item's variant.
  """
  image(
    """
    Crops the image according to the specified region. This argument is
    deprecated: Use crop on Image.transformedSrc instead.
    """
    crop: CropRegion
    """
    Image height in pixels between 1 and 2048. This argument is deprecated: Use
    maxHeight on Image.transformedSrc instead.
    """
    maxHeight: Int
    """
    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    """
    maxWidth: Int
    """
    Image size multiplier for high-resolution retina displays. Must be between 1
    and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    """
    scale: Int = 1
  ): Image
  """
  Name of the product.
  """
  name: String!
  """
  A count of the number of line items that cannot be fulfilled.
  """
  nonFulfillableQuantity: Int!
  """
  Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.
  """
  originalTotal: Money!
  """
  Total price (without discounts) of the line item, based on the original unit
  price of the  variant x quantity in shop and presentment currencies.
  """
  originalTotalSet: MoneyBag!
  """
  Variant price without any discounts applied.
  """
  originalUnitPrice: Money!
  """
  Variant price without any discounts applied in shop and presentment currencies.
  """
  originalUnitPriceSet: MoneyBag!
  """
  The Product object associated with this line item's variant.
  """
  product: Product
  """
  Number of variant items ordered.
  """
  quantity: Int!
  """
  The line item's quantity minus its refundedQuantity.
  """
  refundableQuantity: Int!
  """
  Whether physical shipping is required for the variant.
  """
  requiresShipping: Boolean!
  """
  Whether the line item's variant has an ID and inventory is managed by Shopify.
  """
  restockable: Boolean!
  """
  Variant SKU number.
  """
  sku: String
  """
  The TaxLine object connected to this line item.
  """
  taxLines(
    """
    Truncate the array result to this size.
    """
    first: Int
  ): [TaxLine!]!
  """
  Whether the variant is taxable.
  """
  taxable: Boolean!
  """
  Title of the product or variant (this field only applies to custom line items).
  """
  title: String!
  """
  The sum of all AppliedDiscounts on this line item.
  """
  totalDiscount: Money!
  """
  The sum of all AppliedDiscounts on this line item in shop and presentment currencies.
  """
  totalDiscountSet: MoneyBag!
  """
  The total discounted value of unfulfilled units.
  """
  unfulfilledDiscountedTotal: Money!
  """
  The total discounted value of unfulfilled units in shop and presentment currencies.
  """
  unfulfilledDiscountedTotalSet: MoneyBag!
  """
  The total value before discount of all unfulfilled units.
  """
  unfulfilledOriginalTotal: Money!
  """
  The total value before discount of all unfulfilled units in shop and presentment currencies.
  """
  unfulfilledOriginalTotalSet: MoneyBag!
  """
  The number of units not yet fulfilled.
  """
  unfulfilledQuantity: Int!
  """
  The Variant object associated with this line item.
  """
  variant: ProductVariant
  """
  Name of the variant.
  """
  variantTitle: String
  """
  Name of the vendor who made the variant.
  """
  vendor: String
}

Implements

• Node

Fields

customAttributes ([Attribute!]!)	List of additional information (metafields) about the line item.
discountAllocations ([DiscountAllocation!]!)	The discounts that have been allocated onto the line item by discount applications.
discountedTotalSet (MoneyBag!)	The total line price after discounts are applied in shop and presentment currencies.
discountedUnitPriceSet (MoneyBag!)	The price of a single variant unit after discounts are applied in shop and presentment currencies.
fulfillableQuantity (Int!)	The total number of units to fulfill.
fulfillmentService (FulfillmentService!)	Name of the service provider who fulfilled the order. Valid values are either manual or the name of the provider. For example, amazon, shipwire.
fulfillmentStatus (String!)	The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise.
id (ID!)	Globally unique identifier.
image (Image)	The Image object associated to the line item's variant.
crop ( CropRegion )	Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.
maxHeight ( Int )	Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
maxWidth ( Int )	Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
scale ( Int )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead. Default value: true
name (String!)	Name of the product.
nonFulfillableQuantity (Int!)	A count of the number of line items that cannot be fulfilled.
originalTotalSet (MoneyBag!)	Total price (without discounts) of the line item, based on the original unit price of the variant x quantity in shop and presentment currencies.
originalUnitPriceSet (MoneyBag!)	Variant price without any discounts applied in shop and presentment currencies.
product (Product)	The Product object associated with this line item's variant.
quantity (Int!)	Number of variant items ordered.
refundableQuantity (Int!)	The line item's quantity minus its refundedQuantity.
requiresShipping (Boolean!)	Whether physical shipping is required for the variant.
restockable (Boolean!)	Whether the line item's variant has an ID and inventory is managed by Shopify.
sku (String)	Variant SKU number.
taxLines ([TaxLine!]!)	The TaxLine object connected to this line item.
first ( Int )	Truncate the array result to this size.
taxable (Boolean!)	Whether the variant is taxable.
title (String!)	Title of the product or variant (this field only applies to custom line items).
totalDiscountSet (MoneyBag!)	The sum of all AppliedDiscounts on this line item in shop and presentment currencies.
unfulfilledDiscountedTotalSet (MoneyBag!)	The total discounted value of unfulfilled units in shop and presentment currencies.
unfulfilledOriginalTotalSet (MoneyBag!)	The total value before discount of all unfulfilled units in shop and presentment currencies.
unfulfilledQuantity (Int!)	The number of units not yet fulfilled.
variant (ProductVariant)	The Variant object associated with this line item.
variantTitle (String)	Name of the variant.
vendor (String)	Name of the vendor who made the variant.

Deprecated fields

Show/Hide

canRestock (Boolean!) deprecated	Whether the line item's variant has an ID and inventory is managed by Shopify. Deprecation warning Use restockable instead
discountedTotal (Money!) deprecated	The total line price after discounts are applied. Deprecation warning Use discountedTotalSet instead
discountedUnitPrice (Money!) deprecated	The price of a single variant unit after discounts are applied. Deprecation warning Use discountedUnitPriceSet instead
originalTotal (Money!) deprecated	Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. Deprecation warning Use originalTotalSet instead
originalUnitPrice (Money!) deprecated	Variant price without any discounts applied. Deprecation warning Use originalUnitPriceSet instead
totalDiscount (Money!) deprecated	The sum of all AppliedDiscounts on this line item. Deprecation warning Use totalDiscountSet instead
unfulfilledDiscountedTotal (Money!) deprecated	The total discounted value of unfulfilled units. Deprecation warning Use unfulfilledDiscountedTotalSet instead
unfulfilledOriginalTotal (Money!) deprecated	The total value before discount of all unfulfilled units. Deprecation warning Use unfulfilledOriginalTotalSet instead