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

DraftOrderLineItemInput input object

Version unstable

The input fields used to create a line item for a draft order.

Input fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    Discount which will be applied to the line item.

  • customAttributes ([AttributeInput!])

    Represents a generic custom attribute using a key value pair.

  • grams (Int)

    Ignored when variant ID is provided. This argument is deprecated: Use weight instead.

  • originalUnitPrice (Money)

    Ignored when variant ID is provided.

  • quantity (Int!) Required

    The number of products that were purchased.

  • requiresShipping (Boolean)

    Ignored when variant ID is provided.

  • sku (String)

    Ignored when variant ID is provided.

  • taxable (Boolean)

    Ignored when variant ID is provided.

  • title (String)

    Ignored when variant ID is provided.

  • variantId (ID)

    The ID of the product variant corresponding to the line item. Null if custom line item. Required if product variant line item.

  • weight (WeightInput)

    Specifies the weight unit and value inputs. Ignored when variant ID is provided.

Version 2021-07 (Release candidate)

The input fields used to create a line item for a draft order.

Input fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    Discount which will be applied to the line item.

  • customAttributes ([AttributeInput!])

    Represents a generic custom attribute using a key value pair.

  • grams (Int)

    Ignored when variant ID is provided. This argument is deprecated: Use weight instead.

  • originalUnitPrice (Money)

    Ignored when variant ID is provided.

  • quantity (Int!) Required

    The number of products that were purchased.

  • requiresShipping (Boolean)

    Ignored when variant ID is provided.

  • sku (String)

    Ignored when variant ID is provided.

  • taxable (Boolean)

    Ignored when variant ID is provided.

  • title (String)

    Ignored when variant ID is provided.

  • variantId (ID)

    The ID of the product variant corresponding to the line item. Null if custom line item. Required if product variant line item.

  • weight (WeightInput)

    Specifies the weight unit and value inputs. Ignored when variant ID is provided.

Version 2021-04 (Latest)

The input fields used to create a line item for a draft order.

Input fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    Discount which will be applied to the line item.

  • customAttributes ([AttributeInput!])

    Represents a generic custom attribute using a key value pair.

  • grams (Int)

    Ignored when variant ID is provided. This argument is deprecated: Use weight instead.

  • originalUnitPrice (Money)

    Ignored when variant ID is provided.

  • quantity (Int!) Required

    The number of products that were purchased.

  • requiresShipping (Boolean)

    Ignored when variant ID is provided.

  • sku (String)

    Ignored when variant ID is provided.

  • taxable (Boolean)

    Ignored when variant ID is provided.

  • title (String)

    Ignored when variant ID is provided.

  • variantId (ID)

    The ID of the product variant corresponding to the line item. Null if custom line item. Required if product variant line item.

  • weight (WeightInput)

    Specifies the weight unit and value inputs. Ignored when variant ID is provided.

Version 2021-01

The input fields used to create a line item for a draft order.

Input fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    Discount which will be applied to the line item.

  • customAttributes ([AttributeInput!])

    Represents a generic custom attribute using a key value pair.

  • grams (Int)

    Ignored when variant ID is provided. This argument is deprecated: Use weight instead.

  • originalUnitPrice (Money)

    Ignored when variant ID is provided.

  • quantity (Int!) Required

    The number of products that were purchased.

  • requiresShipping (Boolean)

    Ignored when variant ID is provided.

  • sku (String)

    Ignored when variant ID is provided.

  • taxable (Boolean)

    Ignored when variant ID is provided.

  • title (String)

    Ignored when variant ID is provided.

  • variantId (ID)

    The ID of the product variant corresponding to the line item. Null if custom line item. Required if product variant line item.

  • weight (WeightInput)

    Specifies the weight unit and value inputs. Ignored when variant ID is provided.

Version 2020-10

The input fields used to create a line item for a draft order.

Input fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    Discount which will be applied to the line item.

  • customAttributes ([AttributeInput!])

    Represents a generic custom attribute using a key value pair.

  • grams (Int)

    Ignored when variant ID is provided. This argument is deprecated: Use weight instead.

  • originalUnitPrice (Money)

    Ignored when variant ID is provided.

  • quantity (Int!) Required

    The number of products that were purchased.

  • requiresShipping (Boolean)

    Ignored when variant ID is provided.

  • sku (String)

    Ignored when variant ID is provided.

  • taxable (Boolean)

    Ignored when variant ID is provided.

  • title (String)

    Ignored when variant ID is provided.

  • variantId (ID)

    The ID of the product variant corresponding to the line item. Null if custom line item. Required if product variant line item.

  • weight (WeightInput)

    Specifies the weight unit and value inputs. Ignored when variant ID is provided.

Version 2020-07

The input fields used to create a line item for a draft order.

Input fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    Discount which will be applied to the line item.

  • customAttributes ([AttributeInput!])

    Represents a generic custom attribute using a key value pair.

  • grams (Int)

    Ignored when variant ID is provided. This argument is deprecated: Use weight instead.

  • originalUnitPrice (Money)

    Ignored when variant ID is provided.

  • quantity (Int!) Required

    The number of products that were purchased.

  • requiresShipping (Boolean)

    Ignored when variant ID is provided.

  • sku (String)

    Ignored when variant ID is provided.

  • taxable (Boolean)

    Ignored when variant ID is provided.

  • title (String)

    Ignored when variant ID is provided.

  • variantId (ID)

    The ID of the product variant corresponding to the line item. Null if custom line item. Required if product variant line item.

  • weight (WeightInput)

    Specifies the weight unit and value inputs. Ignored when variant ID is provided.

Version 2020-04

The input fields used to create a line item for a draft order.

Input fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    Discount which will be applied to the line item.

  • customAttributes ([AttributeInput!])

    Represents a generic custom attribute using a key value pair.

  • grams (Int)

    Ignored when variant ID is provided. This argument is deprecated: Use weight instead.

  • originalUnitPrice (Money)

    Ignored when variant ID is provided.

  • quantity (Int!) Required

    The number of products that were purchased.

  • requiresShipping (Boolean)

    Ignored when variant ID is provided.

  • sku (String)

    Ignored when variant ID is provided.

  • taxable (Boolean)

    Ignored when variant ID is provided.

  • title (String)

    Ignored when variant ID is provided.

  • variantId (ID)

    The ID of the product variant corresponding to the line item. Null if custom line item. Required if product variant line item.

  • weight (WeightInput)

    Specifies the weight unit and value inputs. Ignored when variant ID is provided.

Version 2020-01 (Unsupported)

The input fields used to create a line item for a draft order.

Input fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    Discount which will be applied to the line item.

  • customAttributes ([AttributeInput!])

    Represents a generic custom attribute using a key value pair.

  • grams (Int)

    Ignored when variant ID is provided. This argument is deprecated: Use weight instead.

  • originalUnitPrice (Money)

    Ignored when variant ID is provided.

  • quantity (Int!) Required

    The number of products that were purchased.

  • requiresShipping (Boolean)

    Ignored when variant ID is provided.

  • sku (String)

    Ignored when variant ID is provided.

  • taxable (Boolean)

    Ignored when variant ID is provided.

  • title (String)

    Ignored when variant ID is provided.

  • variantId (ID)

    The ID of the product variant corresponding to the line item. Null if custom line item. Required if product variant line item.

  • weight (WeightInput)

    Specifies the weight unit and value inputs. Ignored when variant ID is provided.

Version 2019-10 (Unsupported)

The input fields used to create a line item for a draft order.

Input fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    Discount which will be applied to the line item.

  • customAttributes ([AttributeInput!])

    Represents a generic custom attribute using a key value pair.

  • grams (Int)

    Ignored when variant ID is provided. This argument is deprecated: Use weight instead.

  • originalUnitPrice (Money)

    Ignored when variant ID is provided.

  • quantity (Int!) Required

    The number of products that were purchased.

  • requiresShipping (Boolean)

    Ignored when variant ID is provided.

  • sku (String)

    Ignored when variant ID is provided.

  • taxable (Boolean)

    Ignored when variant ID is provided.

  • title (String)

    Ignored when variant ID is provided.

  • variantId (ID)

    The ID of the product variant corresponding to the line item. Null if custom line item. Required if product variant line item.

  • weight (WeightInput)

    Specifies the weight unit and value inputs. Ignored when variant ID is provided.

Version 2019-07 (Unsupported)

The input fields used to create a line item for a draft order.

Input fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    Discount which will be applied to the line item.

  • customAttributes ([AttributeInput!])

    Represents a generic custom attribute using a key value pair.

  • grams (Int)

    Ignored when variant ID is provided. This argument is deprecated: Use weight instead.

  • originalUnitPrice (Money)

    Ignored when variant ID is provided.

  • quantity (Int!) Required

    The number of products that were purchased.

  • requiresShipping (Boolean)

    Ignored when variant ID is provided.

  • sku (String)

    Ignored when variant ID is provided.

  • taxable (Boolean)

    Ignored when variant ID is provided.

  • title (String)

    Ignored when variant ID is provided.

  • variantId (ID)

    The ID of the product variant corresponding to the line item. Null if custom line item. Required if product variant line item.

  • weight (WeightInput)

    Specifies the weight unit and value inputs. Ignored when variant ID is provided.

Version 2019-04 (Unsupported)

The input fields used to create a line item for a draft order.

Input fields

  • appliedDiscount (DraftOrderAppliedDiscountInput)

    Discount which will be applied to the line item.

  • customAttributes ([AttributeInput!])

    Represents a generic custom attribute using a key value pair.

  • grams (Int)

    Ignored when variant ID is provided. This argument is deprecated: Use weight instead.

  • originalUnitPrice (Money)

    Ignored when variant ID is provided.

  • quantity (Int!) Required

    The number of products that were purchased.

  • requiresShipping (Boolean)

    Ignored when variant ID is provided.

  • sku (String)

    Ignored when variant ID is provided.

  • taxable (Boolean)

    Ignored when variant ID is provided.

  • title (String)

    Ignored when variant ID is provided.

  • variantId (ID)

    The ID of the product variant corresponding to the line item. Null if custom line item. Required if product variant line item.

  • weight (WeightInput)

    Specifies the weight unit and value inputs. Ignored when variant ID is provided.