stack

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

AdminTypes.LineItemMutable interface

Represents a single line item on an order.

Signature:

export interface LineItemMutable extends Node 

Extends: Node

Properties

Property	Modifiers	Type	Description
canRestock		Scalars[‘Boolean’][‘output’]	Whether the line item can be restocked.
customAttributes		Array<Attribute>	A list of attributes that represent custom features or special requests.
discountAllocations		Array<DiscountAllocation>	The discounts that have been allocated onto the line item by discount applications.
discountedTotal		Scalars[‘Money’][‘output’]	The total line price after discounts are applied, in shop currency.
discountedTotalSet		MoneyBag	The total line price after discounts are applied, in shop and presentment currencies.
discountedUnitPrice		Scalars[‘Money’][‘output’]	The approximate split price of a line item unit, in shop currency. This value doesn’t include discounts applied to the entire order.
discountedUnitPriceSet		MoneyBag	The approximate split price of a line item unit, in shop and presentment currencies. This value doesn’t include discounts applied to the entire order.
fulfillableQuantity		Scalars[‘Int’][‘output’]	The total number of units to fulfill.
fulfillmentService?		Maybe<FulfillmentService>	<p>(Optional) The service provider that fulfills the line item.</p><p>Deleted fulfillment services will return null.</p>
fulfillmentStatus		Scalars[‘String’][‘output’]	The line item’s fulfillment status. Returns ‘fulfilled’ if fulfillableQuantity >= quantity, ‘partial’ if fulfillableQuantity > 0, and ‘unfulfilled’ otherwise.
id		Scalars[‘ID’][‘output’]	A globally-unique ID.
image?		Maybe<Image>	(Optional) The image associated to the line item’s variant.
merchantEditable		Scalars[‘Boolean’][‘output’]	Whether the line item can be edited or not.
name		Scalars[‘String’][‘output’]	The name of the product.
nonFulfillableQuantity		Scalars[‘Int’][‘output’]	The total number of units that can’t be fulfilled. For example, if items have been refunded, or the item isn’t something that can be fulfilled, like a tip.
originalTotal		Scalars[‘Money’][‘output’]	The total price without any discounts applied, in shop currency. ““This value is based on the unit price of the variant x quantity.
originalTotalSet		MoneyBag	The total price in shop and presentment currencies, without discounts applied. This value is based on the unit price of the variant x quantity.
originalUnitPrice		Scalars[‘Money’][‘output’]	The variant unit price without discounts applied, in shop currency.
originalUnitPriceSet		MoneyBag	The variant unit price without discounts applied, in shop and presentment currencies.
product?		Maybe<Product>	(Optional) The Product object associated with this line item’s variant.
quantity		Scalars[‘Int’][‘output’]	The number of variant units ordered.
refundableQuantity		Scalars[‘Int’][‘output’]	The line item’s quantity, minus the removed quantity.
requiresShipping		Scalars[‘Boolean’][‘output’]	Whether physical shipping is required for the variant.
restockable		Scalars[‘Boolean’][‘output’]	Whether the line item can be restocked.
sku?		Maybe<Scalars[‘String’][‘output’]>	(Optional) The variant SKU number.
staffMember?		Maybe<StaffMember>	(Optional) Staff attributed to the line item.
taxable		Scalars[‘Boolean’][‘output’]	Whether the variant is taxable.
taxLines		Array<TaxLine>	The TaxLine object connected to this line item.
title		Scalars[‘String’][‘output’]	The title of the product.
totalDiscount		Scalars[‘Money’][‘output’]	The total amount of the discount allocated to the line item in the shop currency. This field must be explicitly set using draft orders, Shopify scripts, or the API. Instead of using this field, Shopify recommends using discountAllocations, which provides the same information.
totalDiscountSet		MoneyBag	The total amount of the discount allocated to the line item in the presentment currency. This field must be explicitly set using draft orders, Shopify scripts, or the API. Instead of using this field, Shopify recommends using discountAllocations, which provides the same information.
unfulfilledDiscountedTotal		Scalars[‘Money’][‘output’]	The total discounted value of unfulfilled units, in shop currency.
unfulfilledDiscountedTotalSet		MoneyBag	The total discounted value of unfulfilled units, in shop and presentment currencies.
unfulfilledOriginalTotal		Scalars[‘Money’][‘output’]	The total price without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop currency.
unfulfilledOriginalTotalSet		MoneyBag	The total price without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop and presentment currencies.
unfulfilledQuantity		Scalars[‘Int’][‘output’]	The number of units not yet fulfilled.
variant?		Maybe<ProductVariant>	(Optional) The Variant object associated with this line item.
variantTitle?		Maybe<Scalars[‘String’][‘output’]>	(Optional) The name of the variant.
vendor?		Maybe<Scalars[‘String’][‘output’]>	(Optional) The name of the vendor who made the variant.