Home > @infiniteobjects/shopify-data-manager > AdminTypes > LineItem
Represents individual products and quantities purchased in the associated order.
Signature:
export interface LineItem extends Node
Extends: Node
| Property | Modifiers | Type | Description |
|---|---|---|---|
| canRestock | Scalars[‘Boolean’][‘output’] | Whether the line item can be restocked. | |
| contract? | Maybe<SubscriptionContract> | (Optional) The subscription contract associated with this line item. | |
| currentQuantity | Scalars[‘Int’][‘output’] | The line item’s quantity, minus the removed quantity. | |
| 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, not including order edits and refunds. | |
| 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. | |
| discountedUnitPriceAfterAllDiscountsSet | MoneyBag | The approximate split price of the line item, including any discounts that apply 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. | |
| duties | Array<Duty> | The duties associated with the line item. | |
| fulfillableQuantity | Scalars[‘Int’][‘output’] | The total number of units to fulfill. | |
| fulfillmentService? | Maybe<FulfillmentService> | <p>(Optional) The fulfillment service that stocks the product variant belonging to a line item.</p><p>This is a third-party fulfillment service in the following scenarios:</p><p>**Scenario 1** - The product variant is stocked by a single fulfillment service. - The [FulfillmentService](/api/admin-graphql/latest/objects/FulfillmentService) is a third-party fulfillment service. Third-party fulfillment services don’t have a handle with the value manual.</p><p>**Scenario 2** - Multiple fulfillment services stock the product variant. - The last time that the line item was unfulfilled, it was awaiting fulfillment by a third-party fulfillment service. Third-party fulfillment services don’t have a handle with the value manual.</p><p>If none of the above conditions are met, then the fulfillment service has the manual handle.</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. | |
| lineItemGroup? | Maybe<LineItemGroup> | (Optional) The line item group associated to the line item. | |
| merchantEditable | Scalars[‘Boolean’][‘output’] | Whether the line item can be edited or not. | |
| name | Scalars[‘String’][‘output’] | The title of the product, optionally appended with the title of the variant (if applicable). | |
| nonFulfillableQuantity | Scalars[‘Int’][‘output’] | The total number of units that can’t be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object for more fulfillment details. | |
| originalTotal | Scalars[‘Money’][‘output’] | The total price without 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. | |
| sellingPlan? | Maybe<LineItemSellingPlan> | (Optional) The selling plan details associated with the line item. | |
| 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 taxes charged for this line item. | |
| title | Scalars[‘String’][‘output’] | The title of the product at time of order creation. | |
| totalDiscount | Scalars[‘Money’][‘output’] | The total amount of the discount allocated to the line item in the shop currency. | |
| totalDiscountSet | MoneyBag | The total amount of the discount that’s allocated to the line item, in the shop and presentment currencies. This field must be explicitly set using draft orders, Shopify scripts, or the API. | |
| 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 title of the variant at time of order creation. | |
| vendor? | Maybe<Scalars[‘String’][‘output’]> | (Optional) The name of the vendor who made the variant. |