Draft
Requires access scope.
The line item for a draft order.
Anchor to FieldsFields
- Anchor to appliedDiscountapplied•Draft
Discount Order Applied Discount The custom applied discount.
- Anchor to approximateDiscountedUnitPriceSetapproximate•Money
Discounted Unit Price Set Bag!non-null The
divided byquantity, 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•[Draft
Order Line Item!]!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 customAttributescustom•[Attribute!]!non-null
Attributes A list of attributes that represent custom features or special requests.
- Anchor to customAttributesV2custom•[Typed
Attributes V2 Attribute!]!non-null The list of additional information (metafields) with the associated types.
- Anchor to discountedTotalSetdiscounted•Money
Total Set Bag!non-null The total price with discounts applied.
- Anchor to fulfillmentServicefulfillment•Fulfillment
Service Service 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.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
The image of the product variant.
- Anchor to isGiftCardis•Boolean!non-null
Gift Card Whether the line item represents the purchase of a gift card.
- Anchor to namename•String!non-null
The name of the product.
- Anchor to originalTotalSetoriginal•Money
Total Set Bag!non-null The total price excluding discounts, equal to the original unit price multiplied by quantity.
- Anchor to originalUnitPriceSetoriginal•Money
Unit Price Set Bag!non-null The price without any discounts applied.
- Anchor to originalUnitPriceWithCurrencyoriginal•Money
Unit Price With Currency V2 The original custom line item input price.
- Anchor to priceOverrideprice•Money
Override V2 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 requiresShippingrequires•Boolean!non-null
Shipping Whether physical shipping is required for the variant.
- •String
The SKU number of the product variant.
- Anchor to taxabletaxable•Boolean!non-null
Whether the variant is taxable.
- Anchor to taxLinestax•[Tax
Lines Line!]!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 totalDiscountSettotal•Money
Discount Set Bag!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•Product
Variant The product variant for the line item.
- Anchor to variantTitlevariant•String
Title 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 bundleComponentsbundle•[Draft
Components Order Line Item!]!non-nullDeprecated - Anchor to discountedTotaldiscounted•Money!non-nullDeprecated
Total - Anchor to discountedUnitPricediscounted•Money!non-nullDeprecated
Unit Price - Anchor to discountedUnitPriceSetdiscounted•Money
Unit Price Set Bag!non-nullDeprecated - Anchor to gramsgrams•IntDeprecated
- Anchor to originalTotaloriginal•Money!non-nullDeprecated
Total - Anchor to originalUnitPriceoriginal•Money!non-nullDeprecated
Unit Price - Anchor to totalDiscounttotal•Money!non-nullDeprecated
Discount