LineItem - admin-graphql - OBJECT
Version: 2024-10
Description:
Represents individual products and quantities purchased in the associated order.
Access Scopes
`read_orders` access scope or `read_marketplace_orders` access scope.
Fields
-
canRestock:
Boolean! -
Whether the line item can be restocked.
-
contract:
SubscriptionContract -
The subscription contract associated with this line item.
-
currentQuantity:
Int! -
The number of units ordered, excluding refunded and removed units.
-
customAttributes:
Attribute! -
A list of attributes that represent custom features or special requests.
-
discountAllocations:
DiscountAllocation! -
The discounts that have been allocated to the line item by discount applications, including discounts allocated to refunded and removed quantities.
-
discountedTotal:
Money! -
The total discounted price of the line item in shop currency, including refunded and removed quantities. This value doesn't include order-level discounts.
-
discountedTotalSet:
MoneyBag! -
The total discounted price of the line item in shop and presentment currencies, including refunded and removed quantities. This value doesn't include order-level discounts. Code-based discounts aren't included by default.
-
discountedUnitPrice:
Money! -
The approximate unit price of the line item in shop currency. This value includes line-level discounts and discounts applied to refunded and removed quantities. It doesn't include order-level or code-based discounts.
-
discountedUnitPriceAfterAllDiscountsSet:
MoneyBag! -
The approximate unit price of the line item in shop and presentment currencies. This value includes discounts applied to refunded and removed quantities.
-
discountedUnitPriceSet:
MoneyBag! -
The approximate unit price of the line item in shop and presentment currencies. This value includes line-level discounts and discounts applied to refunded and removed quantities. It doesn't include order-level or code-based discounts.
-
duties:
Duty! -
The duties associated with the line item.
-
fulfillableQuantity:
Int! -
The total number of units to fulfill.
-
fulfillmentService:
FulfillmentService -
The fulfillment service that stocks the product variant belonging to a line item.
This is a third-party fulfillment service in the following scenarios:
**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`.
**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`.
If none of the above conditions are met, then the fulfillment service has the `manual` handle.
-
fulfillmentStatus:
String! -
The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity,
'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise.
-
id:
ID! -
A globally-unique ID.
-
image:
Image -
The image associated to the line item's variant.
-
isGiftCard:
Boolean! -
Whether the line item represents the purchase of a gift card.
-
lineItemGroup:
LineItemGroup -
The line item group associated to the line item.
-
merchantEditable:
Boolean! -
Whether the line item can be edited or not.
-
name:
String! -
The title of the product, optionally appended with the title of the variant (if applicable).
-
nonFulfillableQuantity:
Int! -
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:
Money! -
In shop currency, the total price of the line item when the order was created.
This value doesn't include discounts.
-
originalTotalSet:
MoneyBag! -
In shop and presentment currencies, the total price of the line item when the order was created.
This value doesn't include discounts.
-
originalUnitPrice:
Money! -
In shop currency, the unit price of the line item when the order was created. This value doesn't include discounts.
-
originalUnitPriceSet:
MoneyBag! -
In shop and presentment currencies, the unit price of the line item when the order was created. This value doesn't include discounts.
-
product:
Product -
The Product object associated with this line item's variant.
-
quantity:
Int! -
The number of units ordered, including refunded and removed units.
-
refundableQuantity:
Int! -
The number of units ordered, excluding refunded units.
-
requiresShipping:
Boolean! -
Whether physical shipping is required for the variant.
-
restockable:
Boolean! -
Whether the line item can be restocked.
-
sellingPlan:
LineItemSellingPlan -
The selling plan details associated with the line item.
-
sku:
String -
The variant SKU number.
-
staffMember:
StaffMember -
Staff attributed to the line item.
-
taxLines:
TaxLine! -
The taxes charged for the line item, including taxes charged for refunded and removed quantities.
-
taxable:
Boolean! -
Whether the variant is taxable.
-
title:
String! -
The title of the product at time of order creation.
-
totalDiscount:
Money! -
The total discount allocated to the line item in shop currency, including the total allocated to refunded and removed quantities. This value doesn't include order-level discounts.
-
totalDiscountSet:
MoneyBag! -
The total discount allocated to the line item in shop and presentment currencies, including the total allocated to refunded and removed quantities. This value doesn't include order-level discounts.
-
unfulfilledDiscountedTotal:
Money! -
In shop currency, the total discounted price of the unfulfilled quantity for the line item.
-
unfulfilledDiscountedTotalSet:
MoneyBag! -
In shop and presentment currencies, the total discounted price of the unfulfilled quantity for the line item.
-
unfulfilledOriginalTotal:
Money! -
In shop currency, the total price of the unfulfilled quantity for the line item. This value doesn't include discounts.
-
unfulfilledOriginalTotalSet:
MoneyBag! -
In shop and presentment currencies, the total price of the unfulfilled quantity for the line item. This value doesn't include discounts.
-
unfulfilledQuantity:
Int! -
The number of units not yet fulfilled.
-
variant:
ProductVariant -
The Variant object associated with this line item.
-
variantTitle:
String -
The title of the variant at time of order creation.
-
vendor:
String -
The name of the vendor who made the variant.
Connections
Related queries
Related mutations
Related Unions
Examples