API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

DraftOrderLineItem object

Version unstable

Represents a line item included in a draft order.

Required access

read_draft_orders access scope.

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Discount which will be applied to the line item or the overall order.

  • custom (Boolean!)

    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!]!)

    List of additional information (metafields) about the line item.

  • discountedTotal (Money!)

    Line item price after discounts are applied.

  • discountedUnitPrice (Money!)

    The discountedTotal divided by quantity, resulting in the value of the discount per unit.

  • fulfillmentService (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!)

    Globally unique identifier.

  • image (Image)

    Image associated with the draft order line item.

    Argument Description
    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • isGiftCard (Boolean!)

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

  • name (String!)

    Name of the product.

  • originalTotal (Money!)

    Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.

  • originalUnitPrice (Money!)

    Variant price without any discounts applied.

  • product (Product)

    The product corresponding to the line item’s product variant.

  • quantity (Int!)

    Number of variant items requested in the draft order.

  • requiresShipping (Boolean!)

    Whether physical shipping is required for the variant.

  • sku (String)

    Variant SKU number.

  • taxLines ([TaxLine!]!)

    A list of tax line objects, each of which details the total taxes applicable to the order.

  • taxable (Boolean!)

    Whether the variant is taxable.

  • title (String!)

    Title of the product or variant (this field only applies to custom line items).

  • totalDiscount (Money!)

    Total value of the discount applied to the line item.

  • variant (ProductVariant)

    Associated variant for the line item.

  • variantTitle (String)

    Name of the variant.

  • vendor (String)

    Name of the vendor who made the variant.

  • weight (Weight)

    Weight unit and value for a draft order line item.

Types that return DraftOrderLineItem

Implements

Deprecated fields

  • grams (Int) deprecated

    Weight in grams. Can only be specified if this is a custom line item.

    Deprecation warning

    Use weight instead

Version unstable

An auto-generated type for paginating through multiple DraftOrderLineItems.

Fields

Types that return DraftOrderLineItem

Version unstable

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

Fields

Types that return DraftOrderLineItem

Version 2021-04 (Release candidate)

Represents a line item included in a draft order.

Required access

read_draft_orders access scope.

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Discount which will be applied to the line item or the overall order.

  • custom (Boolean!)

    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!]!)

    List of additional information (metafields) about the line item.

  • discountedTotal (Money!)

    Line item price after discounts are applied.

  • discountedUnitPrice (Money!)

    The discountedTotal divided by quantity, resulting in the value of the discount per unit.

  • fulfillmentService (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!)

    Globally unique identifier.

  • image (Image)

    Image associated with the draft order line item.

    Argument Description
    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • isGiftCard (Boolean!)

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

  • name (String!)

    Name of the product.

  • originalTotal (Money!)

    Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.

  • originalUnitPrice (Money!)

    Variant price without any discounts applied.

  • product (Product)

    The product corresponding to the line item’s product variant.

  • quantity (Int!)

    Number of variant items requested in the draft order.

  • requiresShipping (Boolean!)

    Whether physical shipping is required for the variant.

  • sku (String)

    Variant SKU number.

  • taxLines ([TaxLine!]!)

    A list of tax line objects, each of which details the total taxes applicable to the order.

  • taxable (Boolean!)

    Whether the variant is taxable.

  • title (String!)

    Title of the product or variant (this field only applies to custom line items).

  • totalDiscount (Money!)

    Total value of the discount applied to the line item.

  • variant (ProductVariant)

    Associated variant for the line item.

  • variantTitle (String)

    Name of the variant.

  • vendor (String)

    Name of the vendor who made the variant.

  • weight (Weight)

    Weight unit and value for a draft order line item.

Types that return DraftOrderLineItem

Implements

Deprecated fields

  • grams (Int) deprecated

    Weight in grams. Can only be specified if this is a custom line item.

    Deprecation warning

    Use weight instead

Version 2021-04 (Release candidate)

An auto-generated type for paginating through multiple DraftOrderLineItems.

On this page

Fields

Version 2021-04 (Release candidate)

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

Fields

Types that return DraftOrderLineItemEdge

Version 2021-01 (Latest)

Represents a line item included in a draft order.

Required access

read_draft_orders access scope.

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Discount which will be applied to the line item or the overall order.

  • custom (Boolean!)

    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!]!)

    List of additional information (metafields) about the line item.

  • discountedTotal (Money!)

    Line item price after discounts are applied.

  • discountedUnitPrice (Money!)

    The discountedTotal divided by quantity, resulting in the value of the discount per unit.

  • fulfillmentService (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!)

    Globally unique identifier.

  • image (Image)

    Image associated with the draft order line item.

    Argument Description
    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • isGiftCard (Boolean!)

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

  • name (String!)

    Name of the product.

  • originalTotal (Money!)

    Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.

  • originalUnitPrice (Money!)

    Variant price without any discounts applied.

  • product (Product)

    The product corresponding to the line item’s product variant.

  • quantity (Int!)

    Number of variant items requested in the draft order.

  • requiresShipping (Boolean!)

    Whether physical shipping is required for the variant.

  • sku (String)

    Variant SKU number.

  • taxLines ([TaxLine!]!)

    A list of tax line objects, each of which details the total taxes applicable to the order.

  • taxable (Boolean!)

    Whether the variant is taxable.

  • title (String!)

    Title of the product or variant (this field only applies to custom line items).

  • totalDiscount (Money!)

    Total value of the discount applied to the line item.

  • variant (ProductVariant)

    Associated variant for the line item.

  • variantTitle (String)

    Name of the variant.

  • vendor (String)

    Name of the vendor who made the variant.

  • weight (Weight)

    Weight unit and value for a draft order line item.

Types that return DraftOrderLineItem

Implements

Deprecated fields

  • grams (Int) deprecated

    Weight in grams. Can only be specified if this is a custom line item.

    Deprecation warning

    Use weight instead

Version 2021-01 (Latest)

An auto-generated type for paginating through multiple DraftOrderLineItems.

On this page

Fields

Version 2021-01 (Latest)

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

Fields

Types that return DraftOrderLineItemEdge

Version 2020-10

Represents a line item included in a draft order.

Required access

read_draft_orders access scope.

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Discount which will be applied to the line item or the overall order.

  • custom (Boolean!)

    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!]!)

    List of additional information (metafields) about the line item.

  • discountedTotal (Money!)

    Line item price after discounts are applied.

  • discountedUnitPrice (Money!)

    The discountedTotal divided by quantity, resulting in the value of the discount per unit.

  • fulfillmentService (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!)

    Globally unique identifier.

  • image (Image)

    Image associated with the draft order line item.

    Argument Description
    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • isGiftCard (Boolean!)

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

  • name (String!)

    Name of the product.

  • originalTotal (Money!)

    Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.

  • originalUnitPrice (Money!)

    Variant price without any discounts applied.

  • product (Product)

    The product corresponding to the line item’s product variant.

  • quantity (Int!)

    Number of variant items requested in the draft order.

  • requiresShipping (Boolean!)

    Whether physical shipping is required for the variant.

  • sku (String)

    Variant SKU number.

  • taxLines ([TaxLine!]!)

    A list of tax line objects, each of which details the total taxes applicable to the order.

  • taxable (Boolean!)

    Whether the variant is taxable.

  • title (String!)

    Title of the product or variant (this field only applies to custom line items).

  • totalDiscount (Money!)

    Total value of the discount applied to the line item.

  • variant (ProductVariant)

    Associated variant for the line item.

  • variantTitle (String)

    Name of the variant.

  • vendor (String)

    Name of the vendor who made the variant.

  • weight (Weight)

    Weight unit and value for a draft order line item.

Types that return DraftOrderLineItem

Implements

Deprecated fields

  • grams (Int) deprecated

    Weight in grams. Can only be specified if this is a custom line item.

    Deprecation warning

    Use weight instead

Version 2020-10

An auto-generated type for paginating through multiple DraftOrderLineItems.

On this page

Fields

Version 2020-10

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

Fields

Types that return DraftOrderLineItemEdge

Version 2020-07

Represents a line item included in a draft order.

Required access

read_draft_orders access scope.

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Discount which will be applied to the line item or the overall order.

  • custom (Boolean!)

    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!]!)

    List of additional information (metafields) about the line item.

  • discountedTotal (Money!)

    Line item price after discounts are applied.

  • discountedUnitPrice (Money!)

    The discountedTotal divided by quantity, resulting in the value of the discount per unit.

  • fulfillmentService (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!)

    Globally unique identifier.

  • image (Image)

    Image associated with the draft order line item.

    Argument Description
    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • isGiftCard (Boolean!)

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

  • name (String!)

    Name of the product.

  • originalTotal (Money!)

    Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.

  • originalUnitPrice (Money!)

    Variant price without any discounts applied.

  • product (Product)

    The product corresponding to the line item’s product variant.

  • quantity (Int!)

    Number of variant items requested in the draft order.

  • requiresShipping (Boolean!)

    Whether physical shipping is required for the variant.

  • sku (String)

    Variant SKU number.

  • taxLines ([TaxLine!]!)

    A list of tax line objects, each of which details the total taxes applicable to the order.

  • taxable (Boolean!)

    Whether the variant is taxable.

  • title (String!)

    Title of the product or variant (this field only applies to custom line items).

  • totalDiscount (Money!)

    Total value of the discount applied to the line item.

  • variant (ProductVariant)

    Associated variant for the line item.

  • variantTitle (String)

    Name of the variant.

  • vendor (String)

    Name of the vendor who made the variant.

  • weight (Weight)

    Weight unit and value for a draft order line item.

Types that return DraftOrderLineItem

Implements

Deprecated fields

  • grams (Int) deprecated

    Weight in grams. Can only be specified if this is a custom line item.

    Deprecation warning

    Use weight instead

Version 2020-07

An auto-generated type for paginating through multiple DraftOrderLineItems.

On this page

Fields

Version 2020-07

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

Fields

Types that return DraftOrderLineItemEdge

Version 2020-04

Represents a line item included in a draft order.

Required access

read_draft_orders access scope.

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Discount which will be applied to the line item or the overall order.

  • custom (Boolean!)

    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!]!)

    List of additional information (metafields) about the line item.

  • discountedTotal (Money!)

    Line item price after discounts are applied.

  • discountedUnitPrice (Money!)

    The discountedTotal divided by quantity, resulting in the value of the discount per unit.

  • fulfillmentService (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!)

    Globally unique identifier.

  • image (Image)

    Image associated with the draft order line item.

    Argument Description
    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • isGiftCard (Boolean!)

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

  • name (String!)

    Name of the product.

  • originalTotal (Money!)

    Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.

  • originalUnitPrice (Money!)

    Variant price without any discounts applied.

  • product (Product)

    The product corresponding to the line item’s product variant.

  • quantity (Int!)

    Number of variant items requested in the draft order.

  • requiresShipping (Boolean!)

    Whether physical shipping is required for the variant.

  • sku (String)

    Variant SKU number.

  • taxLines ([TaxLine!]!)

    A list of tax line objects, each of which details the total taxes applicable to the order.

  • taxable (Boolean!)

    Whether the variant is taxable.

  • title (String!)

    Title of the product or variant (this field only applies to custom line items).

  • totalDiscount (Money!)

    Total value of the discount applied to the line item.

  • variant (ProductVariant)

    Associated variant for the line item.

  • variantTitle (String)

    Name of the variant.

  • vendor (String)

    Name of the vendor who made the variant.

  • weight (Weight)

    Weight unit and value for a draft order line item.

Types that return DraftOrderLineItem

Implements

Deprecated fields

  • grams (Int) deprecated

    Weight in grams. Can only be specified if this is a custom line item.

    Deprecation warning

    Use weight instead

Version 2020-04

An auto-generated type for paginating through multiple DraftOrderLineItems.

On this page

Fields

Version 2020-04

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

Fields

Types that return DraftOrderLineItemEdge

Version 2020-01 (Unsupported)

Represents a line item included in a draft order.

Required access

read_draft_orders access scope.

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Discount which will be applied to the line item or the overall order.

  • custom (Boolean!)

    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!]!)

    List of additional information (metafields) about the line item.

  • discountedTotal (Money!)

    Line item price after discounts are applied.

  • discountedUnitPrice (Money!)

    The discountedTotal divided by quantity, resulting in the value of the discount per unit.

  • fulfillmentService (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!)

    Globally unique identifier.

  • image (Image)

    Image associated with the draft order line item.

    Argument Description
    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • isGiftCard (Boolean!)

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

  • name (String!)

    Name of the product.

  • originalTotal (Money!)

    Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.

  • originalUnitPrice (Money!)

    Variant price without any discounts applied.

  • product (Product)

    The product corresponding to the line item’s product variant.

  • quantity (Int!)

    Number of variant items requested in the draft order.

  • requiresShipping (Boolean!)

    Whether physical shipping is required for the variant.

  • sku (String)

    Variant SKU number.

  • taxLines ([TaxLine!]!)

    A list of tax line objects, each of which details the total taxes applicable to the order.

  • taxable (Boolean!)

    Whether the variant is taxable.

  • title (String!)

    Title of the product or variant (this field only applies to custom line items).

  • totalDiscount (Money!)

    Total value of the discount applied to the line item.

  • variant (ProductVariant)

    Associated variant for the line item.

  • variantTitle (String)

    Name of the variant.

  • vendor (String)

    Name of the vendor who made the variant.

  • weight (Weight)

    Weight unit and value for a draft order line item.

Types that return DraftOrderLineItem

Implements

Deprecated fields

  • grams (Int) deprecated

    Weight in grams. Can only be specified if this is a custom line item.

    Deprecation warning

    Use weight instead

Version 2020-01 (Unsupported)

An auto-generated type for paginating through multiple DraftOrderLineItems.

On this page

Fields

Version 2020-01 (Unsupported)

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

Fields

Types that return DraftOrderLineItemEdge

Version 2019-10 (Unsupported)

Represents a line item included in a draft order.

Required access

read_draft_orders access scope.

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Discount which will be applied to the line item or the overall order.

  • custom (Boolean!)

    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!]!)

    List of additional information (metafields) about the line item.

  • discountedTotal (Money!)

    Line item price after discounts are applied.

  • discountedUnitPrice (Money!)

    The discountedTotal divided by quantity, resulting in the value of the discount per unit.

  • fulfillmentService (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!)

    Globally unique identifier.

  • image (Image)

    Image associated with the draft order line item.

    Argument Description
    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • isGiftCard (Boolean!)

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

  • name (String!)

    Name of the product.

  • originalTotal (Money!)

    Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.

  • originalUnitPrice (Money!)

    Variant price without any discounts applied.

  • product (Product)

    The product corresponding to the line item’s product variant.

  • quantity (Int!)

    Number of variant items requested in the draft order.

  • requiresShipping (Boolean!)

    Whether physical shipping is required for the variant.

  • sku (String)

    Variant SKU number.

  • taxLines ([TaxLine!]!)

    A list of tax line objects, each of which details the total taxes applicable to the order.

  • taxable (Boolean!)

    Whether the variant is taxable.

  • title (String!)

    Title of the product or variant (this field only applies to custom line items).

  • totalDiscount (Money!)

    Total value of the discount applied to the line item.

  • variant (ProductVariant)

    Associated variant for the line item.

  • variantTitle (String)

    Name of the variant.

  • vendor (String)

    Name of the vendor who made the variant.

  • weight (Weight)

    Weight unit and value for a draft order line item.

Types that return DraftOrderLineItem

Implements

Deprecated fields

  • grams (Int) deprecated

    Weight in grams. Can only be specified if this is a custom line item.

    Deprecation warning

    Use weight instead

Version 2019-10 (Unsupported)

An auto-generated type for paginating through multiple DraftOrderLineItems.

On this page

Fields

Version 2019-10 (Unsupported)

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

Fields

Types that return DraftOrderLineItemEdge

Version 2019-07 (Unsupported)

Represents a line item included in a draft order.

Required access

read_draft_orders access scope.

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Discount which will be applied to the line item or the overall order.

  • custom (Boolean!)

    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!]!)

    List of additional information (metafields) about the line item.

  • discountedTotal (Money!)

    Line item price after discounts are applied.

  • discountedUnitPrice (Money!)

    The discountedTotal divided by quantity, resulting in the value of the discount per unit.

  • fulfillmentService (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!)

    Globally unique identifier.

  • image (Image)

    Image associated with the draft order line item.

    Argument Description
    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • isGiftCard (Boolean!)

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

  • name (String!)

    Name of the product.

  • originalTotal (Money!)

    Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.

  • originalUnitPrice (Money!)

    Variant price without any discounts applied.

  • product (Product)

    The product corresponding to the line item’s product variant.

  • quantity (Int!)

    Number of variant items requested in the draft order.

  • requiresShipping (Boolean!)

    Whether physical shipping is required for the variant.

  • sku (String)

    Variant SKU number.

  • taxLines ([TaxLine!]!)

    A list of tax line objects, each of which details the total taxes applicable to the order.

  • taxable (Boolean!)

    Whether the variant is taxable.

  • title (String!)

    Title of the product or variant (this field only applies to custom line items).

  • totalDiscount (Money!)

    Total value of the discount applied to the line item.

  • variant (ProductVariant)

    Associated variant for the line item.

  • variantTitle (String)

    Name of the variant.

  • vendor (String)

    Name of the vendor who made the variant.

  • weight (Weight)

    Weight unit and value for a draft order line item.

Types that return DraftOrderLineItem

Implements

Deprecated fields

  • grams (Int) deprecated

    Weight in grams. Can only be specified if this is a custom line item.

    Deprecation warning

    Use weight instead

Version 2019-07 (Unsupported)

An auto-generated type for paginating through multiple DraftOrderLineItems.

On this page

Fields

Version 2019-07 (Unsupported)

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

Fields

Types that return DraftOrderLineItemEdge

Version 2019-04 (Unsupported)

Represents a line item included in a draft order.

Required access

read_draft_orders access scope.

Fields

  • appliedDiscount (DraftOrderAppliedDiscount)

    Discount which will be applied to the line item or the overall order.

  • custom (Boolean!)

    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!]!)

    List of additional information (metafields) about the line item.

  • discountedTotal (Money!)

    Line item price after discounts are applied.

  • discountedUnitPrice (Money!)

    The discountedTotal divided by quantity, resulting in the value of the discount per unit.

  • fulfillmentService (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!)

    Globally unique identifier.

  • image (Image)

    Image associated with the draft order line item.

    Argument Description
    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

  • isGiftCard (Boolean!)

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

  • name (String!)

    Name of the product.

  • originalTotal (Money!)

    Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.

  • originalUnitPrice (Money!)

    Variant price without any discounts applied.

  • product (Product)

    The product corresponding to the line item’s product variant.

  • quantity (Int!)

    Number of variant items requested in the draft order.

  • requiresShipping (Boolean!)

    Whether physical shipping is required for the variant.

  • sku (String)

    Variant SKU number.

  • taxLines ([TaxLine!]!)

    A list of tax line objects, each of which details the total taxes applicable to the order.

  • taxable (Boolean!)

    Whether the variant is taxable.

  • title (String!)

    Title of the product or variant (this field only applies to custom line items).

  • totalDiscount (Money!)

    Total value of the discount applied to the line item.

  • variant (ProductVariant)

    Associated variant for the line item.

  • variantTitle (String)

    Name of the variant.

  • vendor (String)

    Name of the vendor who made the variant.

  • weight (Weight)

    Weight unit and value for a draft order line item.

Types that return DraftOrderLineItem

Implements

Deprecated fields

  • grams (Int) deprecated

    Weight in grams. Can only be specified if this is a custom line item.

    Deprecation warning

    Use weight instead

Version 2019-04 (Unsupported)

An auto-generated type for paginating through multiple DraftOrderLineItems.

On this page

Fields

Version 2019-04 (Unsupported)

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

Fields

Types that return DraftOrderLineItemEdge

Samples