LineItem
Requires access scope or access scope.
Represents individual products and quantities purchased in the associated order.
Anchor to FieldsFields
- Anchor to contractcontract•
The subscription contract associated with this line item.
- Anchor to currentQuantitycurrent•
Quantity Int!non-null The number of units ordered, excluding refunded and removed units.
- Anchor to customAttributescustom•
Attributes [Attribute!]!non-null A list of attributes that represent custom features or special requests.
- Anchor to discountAllocationsdiscount•
Allocations [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 discountedTotalSetdiscounted•
Total Set 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 discountedUnitPriceAfterAllDiscountsSetdiscounted•
Unit Price After All Discounts Set 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 discountedUnitPriceSetdiscounted•
Unit Price Set 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.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•
The image associated to the line item's variant.
- Anchor to isGiftCardis•
Gift Card Boolean!non-null Whether the line item represents the purchase of a gift card.
- Anchor to lineItemGroupline•
Item Group The line item group associated to the line item.
- Anchor to merchantEditablemerchant•
Editable 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 nonFulfillableQuantitynon•
Fulfillable Quantity 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 originalTotalSetoriginal•
Total Set 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 originalUnitPriceSetoriginal•
Unit Price Set 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•
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•
Quantity Int!non-null The number of units ordered, excluding refunded units.
- Anchor to requiresShippingrequires•
Shipping 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 sellingPlanselling•
Plan The selling plan details associated with the line item.
- •
The variant SKU number.
- Anchor to staffMemberstaff•
Member Staff attributed to the line item.
- Anchor to taxabletaxable•Boolean!non-null
Whether the variant is taxable.
- Anchor to taxLinestax•
Lines [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 totalDiscountSettotal•
Discount Set 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 unfulfilledDiscountedTotalSetunfulfilled•
Discounted Total Set MoneyBag! non-null In shop and presentment currencies, the total discounted price of the unfulfilled quantity for the line item.
- Anchor to unfulfilledOriginalTotalSetunfulfilled•
Original Total Set 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 unfulfilledQuantityunfulfilled•
Quantity Int!non-null The number of units not yet fulfilled.
- Anchor to variantvariant•
The Variant object associated with this line item.
- Anchor to variantTitlevariant•
Title The title of the variant at time of order creation.
- Anchor to vendorvendor•
The name of the vendor who made the variant.
Deprecated fields
- Anchor to canRestockcan•
Restock Whether the line item can be restocked. Use
restockableinstead.- Anchor to discountedTotaldiscounted•
Total The total discounted price of the line item in shop currency, including refunded and removed quantities. This value doesn't include order-level discounts. Use
instead.- Anchor to discountedUnitPricediscounted•
Unit Price 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. Use
instead.- Anchor to fulfillableQuantityfulfillable•
Quantity The total number of units to fulfill. Use FulfillmentOrderLineItem#remainingQuantity instead.
- Anchor to fulfillmentServicefulfillment•
Service FulfillmentService Deprecated 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 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
manualhandle. The relationship between a product variant and a fulfillment service was changed in the2022-07API version. A ProductVariant can be stocked by multiple fulfillment services. As a result, we recommend that you use the inventoryItem field if you need to determine where a product variant is stocked.If you need to determine whether a product is a gift card, then you should continue to use this field until an alternative is available.
Altering the locations which stock a product variant won't change the value of this field for existing orders.
Learn about managing inventory quantities and states.
- Anchor to fulfillmentStatusfulfillment•
Status The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. Use FulfillmentOrderLineItem#remainingQuantity instead
- Anchor to originalTotaloriginal•
Total In shop currency, the total price of the line item when the order was created. This value doesn't include discounts. Use
instead.- Anchor to originalUnitPriceoriginal•
Unit Price In shop currency, the unit price of the line item when the order was created. This value doesn't include discounts. Use
instead.- Anchor to totalDiscounttotal•
Discount 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. Use
instead.- Anchor to unfulfilledDiscountedTotalunfulfilled•
Discounted Total In shop currency, the total discounted price of the unfulfilled quantity for the line item. Use
instead.- Anchor to unfulfilledOriginalTotalunfulfilled•
Original Total In shop currency, the total price of the unfulfilled quantity for the line item. This value doesn't include discounts. Use
instead.