We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

DraftOrderLineItemInput

Version 2019-04

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

Show definition
"""
The input fields used to create a line item for a draft order.
"""
input DraftOrderLineItemInput {
  """
  Discount which will be applied to the line item.
  """
  appliedDiscount: DraftOrderAppliedDiscountInput
  """
  Represents a generic custom attribute using a key value pair.
  """
  customAttributes: [AttributeInput!]
  """
  Ignored when variant ID is provided. This argument is deprecated: Use `weight` instead.
  """
  grams: Int
  """
  Ignored when variant ID is provided.
  """
  originalUnitPrice: Money
  """
  The number of products that were purchased.
  """
  quantity: Int!
  """
  Ignored when variant ID is provided.
  """
  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
  """
  The ID of the product variant corresponding to the line item.
  Null if custom line item. Required if product variant line item.
  """
  variantId: ID
  """
  Specifies the weight unit and value inputs.
  Ignored when variant ID or product ID are provided.
  """
  weight: WeightInput
}

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 or product ID are provided.

Version 2019-07 (Latest)

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

Show definition
"""
The input fields used to create a line item for a draft order.
"""
input DraftOrderLineItemInput {
  """
  Discount which will be applied to the line item.
  """
  appliedDiscount: DraftOrderAppliedDiscountInput
  """
  Represents a generic custom attribute using a key value pair.
  """
  customAttributes: [AttributeInput!]
  """
  Ignored when variant ID is provided. This argument is deprecated: Use weight instead.
  """
  grams: Int
  """
  Ignored when variant ID is provided.
  """
  originalUnitPrice: Money
  """
  The number of products that were purchased.
  """
  quantity: Int!
  """
  Ignored when variant ID is provided.
  """
  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
  """
  The ID of the product variant corresponding to the line item.
  Null if custom line item. Required if product variant line item.
  """
  variantId: ID
  """
  Specifies the weight unit and value inputs.
  Ignored when variant ID or product ID are provided.
  """
  weight: WeightInput
}

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 or product ID are provided.

Version 2019-10 (Release candidate)

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

Show definition
"""
The input fields used to create a line item for a draft order.
"""
input DraftOrderLineItemInput {
  """
  Discount which will be applied to the line item.
  """
  appliedDiscount: DraftOrderAppliedDiscountInput
  """
  Represents a generic custom attribute using a key value pair.
  """
  customAttributes: [AttributeInput!]
  """
  Ignored when variant ID is provided. This argument is deprecated: Use weight instead.
  """
  grams: Int
  """
  Ignored when variant ID is provided.
  """
  originalUnitPrice: Money
  """
  The number of products that were purchased.
  """
  quantity: Int!
  """
  Ignored when variant ID is provided.
  """
  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
  """
  The ID of the product variant corresponding to the line item.
  Null if custom line item. Required if product variant line item.
  """
  variantId: ID
  """
  Specifies the weight unit and value inputs.
  Ignored when variant ID or product ID are provided.
  """
  weight: WeightInput
}

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 or product ID are provided.

Sign up for a Partner account to get started.

Sign up