Skip to main content
Log inSign up
object

Requires read_orders access scope or read_marketplace_orders access scope.

Represents individual products and quantities purchased in the associated order.

•

The subscription contract associated with this line item.

•
Int!non-null

The number of units ordered, excluding refunded and removed units.

•

A list of attributes that represent custom features or special requests.

•

The discounts that have been allocated to the line item by discount applications, including discounts allocated to refunded and removed quantities.

•
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.

•
[Duty!]!non-null

The duties associated with the line item.

•
ID!non-null

A globally-unique ID.

•

The image associated to the line item's variant.

•
Boolean!non-null

Whether the line item represents the purchase of a gift card.

•

The line item group associated to the line item.

•
Boolean!non-null

Whether the line item can be edited or not.

•
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.

•
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.

•

The Product object associated with this line item's variant.

•
Int!non-null

The number of units ordered, including refunded and removed units.

•
Int!non-null

The number of units ordered, excluding refunded units.

•
Boolean!non-null

Whether physical shipping is required for the variant.

•
Boolean!non-null

Whether the line item can be restocked.

•

The selling plan details associated with the line item.

•

The variant SKU number.

•

Staff attributed to the line item.

•
Boolean!non-null

Whether the variant is taxable.

•
[TaxLine!]!non-null

The taxes charged for the line item, including taxes charged for refunded and removed quantities.

•
String!non-null

The title of the product at time of order creation.

•
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.

•
Int!non-null

The number of units not yet fulfilled.

•

The Variant object associated with this line item.

•

The title of the variant at time of order creation.

•

The name of the vendor who made the variant.

Show
deprecated fields Deprecated
•
Boolean!non-nullDeprecated

Whether the line item can be restocked. Use restockable instead.

•
Money!non-nullDeprecated

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 discountedTotalSet instead.

•
Money!non-nullDeprecated

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 discountedUnitPriceSet instead.

•
Int!non-nullDeprecated

The total number of units to fulfill. Use FulfillmentOrderLineItem#remainingQuantity instead.

•

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 manual handle. The relationship between a product variant and a fulfillment service was changed in the 2022-07 API 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.

•
String!non-nullDeprecated

The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. Use FulfillmentOrderLineItem#remainingQuantity instead

•
Money!non-nullDeprecated

In shop currency, the total price of the line item when the order was created. This value doesn't include discounts. Use originalTotalSet instead.

•
Money!non-nullDeprecated

In shop currency, the unit price of the line item when the order was created. This value doesn't include discounts. Use originalUnitPriceSet instead.

•
Money!non-nullDeprecated

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 totalDiscountSet instead.

Anchor to unfulfilledDiscountedTotalunfulfilledDiscountedTotal
•
Money!non-nullDeprecated

In shop currency, the total discounted price of the unfulfilled quantity for the line item. Use unfulfilledDiscountedTotalSet instead.

Anchor to unfulfilledOriginalTotalunfulfilledOriginalTotal
•
Money!non-nullDeprecated

In shop currency, the total price of the unfulfilled quantity for the line item. This value doesn't include discounts. Use unfulfilledOriginalTotalSet instead.


Was this section helpful?

•
interface

Was this section helpful?