Choose a version:

DraftOrderLineItem

object

Requires read_draft_orders access scope.

The line item for a draft order.

Anchor to FieldsFields

Anchor to appliedDiscountappliedDiscount •DraftOrderAppliedDiscount: The custom applied discount.
Anchor to approximateDiscountedUnitPriceSetapproximateDiscountedUnitPriceSet •MoneyBag! non-null: The discountedTotal divided by quantity, equal to the average value of the line item price per unit after discounts are applied. This value doesn't include discounts applied to the entire draft order.
Anchor to componentscomponents •[DraftOrderLineItem!]! non-null: The components of the draft order line item.
Anchor to customcustom •Boolean! non-null: Whether the line item is custom (true) or contains a product variant (false).
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: A list of attributes that represent custom features or special requests.
Anchor to customAttributesV2customAttributesV2 •[TypedAttribute!]! non-null: The list of additional information (metafields) with the associated types.
Anchor to discountedTotalSetdiscountedTotalSet •MoneyBag! non-null: The total price with discounts applied.
Anchor to fulfillmentServicefulfillmentService •FulfillmentService: Name of the service provider who fulfilled the order.

Valid values are either manual or the name of the provider. For example, amazon, shipwire.

Deleted fulfillment services will return null.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image: The image of the product variant.
Anchor to isGiftCardisGiftCard •Boolean! non-null: Whether the line item represents the purchase of a gift card.
Anchor to merchandiseSourcemerchandiseSource •DraftOrderLineItemMerchandiseSourceType! non-null: The source of the line item's merchandise information.
Anchor to namename •String! non-null: The name of the product.
Anchor to originalTotalSetoriginalTotalSet •MoneyBag! non-null: The total price excluding discounts, equal to the original unit price multiplied by quantity.
Anchor to originalUnitPriceSetoriginalUnitPriceSet •MoneyBag! non-null: The price without any discounts applied.
Anchor to originalUnitPriceWithCurrencyoriginalUnitPriceWithCurrency •MoneyV2: The original custom line item input price.
Anchor to priceOverridepriceOverride •MoneyV2: The price override for the line item.
Anchor to productproduct •Product: The product for the line item.
Anchor to quantityquantity •Int! non-null: The quantity of items. For a bundle item, this is the quantity of bundles, not the quantity of items contained in the bundles themselves.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether physical shipping is required for the variant.
Anchor to skusku •String: The SKU number of the product variant.
Anchor to taxabletaxable •Boolean! non-null: Whether the variant is taxable.
Anchor to taxLinestaxLines •[TaxLine!]! non-null: A list of tax lines.
Anchor to titletitle •String! non-null: The title of the product or variant. This field only applies to custom line items.
Anchor to totalDiscountSettotalDiscountSet •MoneyBag! non-null: The total discount amount.
Anchor to uuiduuid •String! non-null: The UUID of the draft order line item. Must be unique and consistent across requests. This field is mandatory in order to manipulate drafts with bundles.
Anchor to variantvariant •ProductVariant: The product variant for the line item.
Anchor to variantIdvariantId •ID: The ID of the variant associated with the line item. Will still be returned even if the variant has been deleted since the draft was created or last updated.
Anchor to variantTitlevariantTitle •String: The name of the variant.
Anchor to vendorvendor •String: The name of the vendor who created the product variant.
Anchor to weightweight •Weight: The weight unit and value.

Deprecated fields

Anchor to bundleComponentsbundleComponents •[DraftOrderLineItem!]! non-nullDeprecated
Anchor to discountedTotaldiscountedTotal •Money! non-nullDeprecated
Anchor to discountedUnitPricediscountedUnitPrice •Money! non-nullDeprecated
Anchor to discountedUnitPriceSetdiscountedUnitPriceSet •MoneyBag! non-nullDeprecated
Anchor to gramsgrams •Int Deprecated
Anchor to originalTotaloriginalTotal •Money! non-nullDeprecated
Anchor to originalUnitPriceoriginalUnitPrice •Money! non-nullDeprecated
Anchor to totalDiscounttotalDiscount •Money! non-nullDeprecated

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?