DraftOrderLineItem object

Represents a line item included in a draft order.

Required access

read_draft_orders access scope.

On this page

• Fields
• Types that return DraftOrderLineItem
• Implements
• Deprecated fields
• Samples

Fields

• appliedDiscount ([DraftOrderAppliedDiscount](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorderapplieddiscount))
  Discount which will be applied to the line item or the overall order.
• custom ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether this is a product variant line item, or a custom line item. If set to true indicates a custom line item. If set to false indicates a product variant line item.
• customAttributes ([[Attribute!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/attribute))
  List of additional information (metafields) about the line item.
• discountedTotal ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01))
  Line item price after discounts are applied.
• discountedUnitPrice ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01))
  The discountedTotal divided by quantity, resulting in the value of the discount per unit.
• fulfillmentService ([FulfillmentService!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/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.
• id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  Globally unique identifier.
• image ([Image](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/image))
  Image associated with the draft order line item.

• isGiftCard ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the line item represents the puchase of a gift card.
• name ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Name of the product.
• originalTotal ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01))
  Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.
• originalUnitPrice ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01))
  Variant price without any discounts applied.
• product ([Product](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
  The product corresponding to the line item’s product variant.
• quantity ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  Number of variant items requested in the draft order.
• requiresShipping ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether physical shipping is required for the variant.
• sku ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Variant SKU number.
• taxLines ([[TaxLine!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/taxline))
  A list of tax line objects, each of which details the total taxes applicable to the order.
• taxable ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the variant is taxable.
• title ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Title of the product or variant (this field only applies to custom line items).
• totalDiscount ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01))
  Total value of the discount applied to the line item.
• variant ([ProductVariant](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariant))
  Associated variant for the line item.
• variantTitle ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Name of the variant.
• vendor ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Name of the vendor who made the variant.
• weight ([Weight](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/weight))
  Weight unit and value for a draft order line item.

Types that return DraftOrderLineItem

• [DraftOrder.lineItems](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorder#lineitems-2021-01)

Implements

• [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

Show/Hide

• grams ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)) DEPRECATED
  Weight in grams. Can only be specified if this is a custom line item.
  Deprecation warning
  Use weight instead

An auto-generated type for paginating through multiple DraftOrderLineItems.

On this page

• Fields

Fields

• edges ([[DraftOrderLineItemEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorderlineitem))
  A list of edges.
• pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
  Information to aid in pagination.

An auto-generated type which holds one DraftOrderLineItem and a cursor during pagination.

On this page

• Fields
• Types that return DraftOrderLineItemEdge

Fields

• cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A cursor for use in pagination.
• node ([DraftOrderLineItem!](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorderlineitem))
  The item at the end of DraftOrderLineItemEdge.

Types that return DraftOrderLineItemEdge

• [DraftOrderLineItemConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorderlineitem#edges-2021-01)