Choose a version:

LineItem

object

Requires read_orders access scope or read_marketplace_orders access scope.

The LineItem object represents a single product or service that a customer purchased in an order. Each line item is associated with a product variant and can have multiple discount allocations. Line items contain details about what was purchased, including the product variant, quantity, pricing, and fulfillment status.

Use the LineItem object to manage the following processes:

Track the quantity of items ordered, fulfilled, and unfulfilled.
Calculate prices, including discounts and taxes.
Manage fulfillment through fulfillment services.
Manage returns and exchanges.
Handle subscriptions and recurring orders.

Line items can also include custom attributes and properties, allowing merchants to add specific details about each item in an order. Learn more about managing orders and fulfillment.

Anchor to FieldsFields

Anchor to contractcontract •SubscriptionContract: The subscription contract associated with this line item.
Anchor to currentQuantitycurrentQuantity •Int! non-null: The number of units ordered, excluding refunded and removed units.
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: A list of attributes that represent custom features or special requests.
Anchor to discountAllocationsdiscountAllocations •[DiscountAllocation!]! non-null: The discounts that have been allocated to the line item by discount applications, including discounts allocated to refunded and removed quantities.
Anchor to discountedTotalSetdiscountedTotalSet •MoneyBag! non-null: 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.
Anchor to discountedUnitPriceAfterAllDiscountsSetdiscountedUnitPriceAfterAllDiscountsSet •MoneyBag! non-null: The approximate unit price of the line item in shop and presentment currencies. This value includes discounts applied to refunded and removed quantities.
Anchor to discountedUnitPriceSetdiscountedUnitPriceSet •MoneyBag! non-null: 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.
Anchor to dutiesduties •[Duty!]! non-null: The duties associated with the line item.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image: The image associated to the line item's variant.
Anchor to isGiftCardisGiftCard •Boolean! non-null: Whether the line item represents the purchase of a gift card.
Anchor to lineItemGrouplineItemGroup •LineItemGroup: The line item group associated to the line item.
Anchor to merchantEditablemerchantEditable •Boolean! non-null: Whether the line item can be edited or not.
Anchor to namename •String! non-null: The title of the product, optionally appended with the title of the variant (if applicable).
Anchor to nonFulfillableQuantitynonFulfillableQuantity •Int! non-null: 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 object for more fulfillment details.
Anchor to originalTotalSetoriginalTotalSet •MoneyBag! non-null: In shop and presentment currencies, the total price of the line item when the order was created. This value doesn't include discounts.
Anchor to originalUnitPriceSetoriginalUnitPriceSet •MoneyBag! non-null: In shop and presentment currencies, the unit price of the line item when the order was created. This value doesn't include discounts.
Anchor to productproduct •Product: The Product object associated with this line item's variant.
Anchor to quantityquantity •Int! non-null: The number of units ordered, including refunded and removed units.
Anchor to refundableQuantityrefundableQuantity •Int! non-null: The number of units ordered, excluding refunded units and removed units.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether physical shipping is required for the variant.
Anchor to restockablerestockable •Boolean! non-null: Whether the line item can be restocked.
Anchor to sellingPlansellingPlan •LineItemSellingPlan: The selling plan details associated with the line item.
Anchor to skusku •String: The variant SKU number.
Anchor to staffMemberstaffMember •StaffMember: Staff attributed to the line item.
Anchor to taxabletaxable •Boolean! non-null: Whether the variant is taxable.
Anchor to taxLinestaxLines •[TaxLine!]! non-null: The taxes charged for the line item, including taxes charged for refunded and removed quantities.
Anchor to titletitle •String! non-null: The title of the product at time of order creation.
Anchor to totalDiscountSettotalDiscountSet •MoneyBag! non-null: 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.
Anchor to unfulfilledDiscountedTotalSetunfulfilledDiscountedTotalSet •MoneyBag! non-null: In shop and presentment currencies, the total discounted price of the unfulfilled quantity for the line item.
Anchor to unfulfilledOriginalTotalSetunfulfilledOriginalTotalSet •MoneyBag! non-null: In shop and presentment currencies, the total price of the unfulfilled quantity for the line item. This value doesn't include discounts.
Anchor to unfulfilledQuantityunfulfilledQuantity •Int! non-null: The number of units not yet fulfilled.
Anchor to variantvariant •ProductVariant: The Variant object associated with this line item.
Anchor to variantTitlevariantTitle •String: The title of the variant at time of order creation.
Anchor to vendorvendor •String: The name of the vendor who made the variant.

Deprecated fields

Anchor to canRestockcanRestock •Boolean! non-nullDeprecated
Anchor to discountedTotaldiscountedTotal •Money! non-nullDeprecated
Anchor to discountedUnitPricediscountedUnitPrice •Money! non-nullDeprecated
Anchor to fulfillableQuantityfulfillableQuantity •Int! non-nullDeprecated
Anchor to fulfillmentServicefulfillmentService •FulfillmentService Deprecated
Anchor to fulfillmentStatusfulfillmentStatus •String! non-nullDeprecated
Anchor to originalTotaloriginalTotal •Money! non-nullDeprecated
Anchor to originalUnitPriceoriginalUnitPrice •Money! non-nullDeprecated
Anchor to totalDiscounttotalDiscount •Money! non-nullDeprecated
Anchor to unfulfilledDiscountedTotalunfulfilledDiscountedTotal •Money! non-nullDeprecated
Anchor to unfulfilledOriginalTotalunfulfilledOriginalTotal •Money! non-nullDeprecated

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?