Line
Requires access scope or access scope.
The 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 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•Subscription
Contract The subscription contract associated with this line item.
- Anchor to currentQuantitycurrent•Int!non-null
Quantity The number of units ordered, excluding refunded and removed units.
- Anchor to customAttributescustom•[Attribute!]!non-null
Attributes A list of attributes that represent custom features or special requests.
- Anchor to discountAllocationsdiscount•[Discount
Allocations Allocation!]!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 discountedTotalSetdiscounted•Money
Total Set Bag!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 discountedUnitPriceAfterAllDiscountsSetdiscounted•Money
Unit Price After All Discounts Set Bag!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 discountedUnitPriceSetdiscounted•Money
Unit Price Set Bag!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.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
The image associated to the line item's variant.
- Anchor to isGiftCardis•Boolean!non-null
Gift Card Whether the line item represents the purchase of a gift card.
- Anchor to lineItemGroupline•Line
Item Group Item Group The line item group associated to the line item.
- Anchor to merchantEditablemerchant•Boolean!non-null
Editable 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 nonFulfillableQuantitynon•Int!non-null
Fulfillable Quantity 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 originalTotalSetoriginal•Money
Total Set Bag!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 originalUnitPriceSetoriginal•Money
Unit Price Set Bag!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 refundableQuantityrefundable•Int!non-null
Quantity The number of units ordered, excluding refunded units and removed units.
- Anchor to requiresShippingrequires•Boolean!non-null
Shipping Whether physical shipping is required for the variant.
- Anchor to restockablerestockable•Boolean!non-null
Whether the line item can be restocked.
- Anchor to sellingPlanselling•Line
Plan Item Selling Plan The selling plan details associated with the line item.
- •String
The variant SKU number.
- Anchor to staffMemberstaff•Staff
Member Member Staff attributed to the line item.
- Anchor to taxabletaxable•Boolean!non-null
Whether the variant is taxable.
- Anchor to taxLinestax•[Tax
Lines Line!]!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 totalDiscountSettotal•Money
Discount Set Bag!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 unfulfilledDiscountedTotalSetunfulfilled•Money
Discounted Total Set Bag!non-null In shop and presentment currencies, the total discounted price of the unfulfilled quantity for the line item.
- Anchor to unfulfilledOriginalTotalSetunfulfilled•Money
Original Total Set Bag!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 unfulfilledQuantityunfulfilled•Int!non-null
Quantity The number of units not yet fulfilled.
- Anchor to variantvariant•Product
Variant The Variant object associated with this line item.
- Anchor to variantTitlevariant•String
Title 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 canRestockcan•Boolean!non-nullDeprecated
Restock - Anchor to discountedTotaldiscounted•Money!non-nullDeprecated
Total - Anchor to discountedUnitPricediscounted•Money!non-nullDeprecated
Unit Price - Anchor to fulfillableQuantityfulfillable•Int!non-nullDeprecated
Quantity - Anchor to fulfillmentServicefulfillment•Fulfillment
Service ServiceDeprecated - Anchor to fulfillmentStatusfulfillment•String!non-nullDeprecated
Status - Anchor to originalTotaloriginal•Money!non-nullDeprecated
Total - Anchor to originalUnitPriceoriginal•Money!non-nullDeprecated
Unit Price - Anchor to totalDiscounttotal•Money!non-nullDeprecated
Discount - Anchor to unfulfilledDiscountedTotalunfulfilled•Money!non-nullDeprecated
Discounted Total - Anchor to unfulfilledOriginalTotalunfulfilled•Money!non-nullDeprecated
Original Total