Choose a version:

LineItemMutable

object

Requires read_orders access scope.

Represents a single line item on an order.

Anchor to FieldsFields

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 onto the line item by discount applications.
Anchor to discountedTotalSetdiscountedTotalSet •MoneyBag! non-null: The total line price after discounts are applied, in shop and presentment currencies.
Anchor to discountedUnitPriceSetdiscountedUnitPriceSet •MoneyBag! non-null: 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.
Anchor to fulfillableQuantityfulfillableQuantity •Int! non-null: The total number of units to fulfill.
Anchor to fulfillmentServicefulfillmentService •FulfillmentService: The service provider that fulfills the line item.

Deleted fulfillment services will return null.
Anchor to fulfillmentStatusfulfillmentStatus •String! non-null: The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise.
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 merchantEditablemerchantEditable •Boolean! non-null: Whether the line item can be edited or not.
Anchor to namename •String! non-null: The name of the product.
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 isn't something that can be fulfilled, like a tip.
Anchor to originalTotalSetoriginalTotalSet •MoneyBag! non-null: The total price in shop and presentment currencies, without discounts applied. This value is based on the unit price of the variant x quantity.
Anchor to originalUnitPriceSetoriginalUnitPriceSet •MoneyBag! non-null: The variant unit price without discounts applied, in shop and presentment currencies.
Anchor to productproduct •Product: The Product object associated with this line item's variant.
Anchor to quantityquantity •Int! non-null: The number of variant units ordered.
Anchor to refundableQuantityrefundableQuantity •Int! non-null: The line item's quantity, minus the refunded quantity.
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 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 TaxLine object connected to this line item.
Anchor to titletitle •String! non-null: The title of the product.
Anchor to totalDiscountSettotalDiscountSet •MoneyBag! non-null: The total amount of the discount allocated to the line item in the presentment currency. This field must be explicitly set using draft orders, Shopify scripts, or the API. Instead of using this field, Shopify recommends using discountAllocations, which provides the same information.
Anchor to unfulfilledDiscountedTotalSetunfulfilledDiscountedTotalSet •MoneyBag! non-null: The total discounted value of unfulfilled units, in shop and presentment currencies.
Anchor to unfulfilledOriginalTotalSetunfulfilledOriginalTotalSet •MoneyBag! non-null: 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.
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 name of the variant.
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 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?