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.

DraftOrderAppliedDiscountInput

Version 2019-04

The input fields for applying an order-level discount to a draft order.

Show definition
"""
The input fields for applying an order-level discount to a draft order.
"""
input DraftOrderAppliedDiscountInput {
  """
  The applied amount of the discount.
  """
  amount: Money!
  """
  Reason for the discount.
  """
  description: String
  """
  Title of the discount.
  """
  title: String
  """
  The value of the discount.
  If the type of the discount is fixed amount, then this is a fixed dollar amount.
  If the type is percentage, then this is the percentage.
  """
  value: Float!
  """
  The type of discount.
  """
  valueType: DraftOrderAppliedDiscountType!
}

Input Fields

amount (Money!) Required

The applied amount of the discount.

description (String)

Reason for the discount.

title (String)

Title of the discount.

value (Float!) Required

The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

valueType (DraftOrderAppliedDiscountType!) Required

The type of discount.

Version 2019-07 (Latest)

The input fields for applying an order-level discount to a draft order.

Show definition
"""
The input fields for applying an order-level discount to a draft order.
"""
input DraftOrderAppliedDiscountInput {
  """
  The applied amount of the discount.
  """
  amount: Money!
  """
  Reason for the discount.
  """
  description: String
  """
  Title of the discount.
  """
  title: String
  """
  The value of the discount.
  If the type of the discount is fixed amount, then this is a fixed dollar amount.
  If the type is percentage, then this is the percentage.
  """
  value: Float!
  """
  The type of discount.
  """
  valueType: DraftOrderAppliedDiscountType!
}

Input Fields

amount (Money!) Required

The applied amount of the discount.

description (String)

Reason for the discount.

title (String)

Title of the discount.

value (Float!) Required

The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

valueType (DraftOrderAppliedDiscountType!) Required

The type of discount.

Version 2019-10 (Release candidate)

The input fields for applying an order-level discount to a draft order.

Show definition
"""
The input fields for applying an order-level discount to a draft order.
"""
input DraftOrderAppliedDiscountInput {
  """
  The applied amount of the discount.
  """
  amount: Money!
  """
  Reason for the discount.
  """
  description: String
  """
  Title of the discount.
  """
  title: String
  """
  The value of the discount.
  If the type of the discount is fixed amount, then this is a fixed dollar amount.
  If the type is percentage, then this is the percentage.
  """
  value: Float!
  """
  The type of discount.
  """
  valueType: DraftOrderAppliedDiscountType!
}

Input Fields

amount (Money!) Required

The applied amount of the discount.

description (String)

Reason for the discount.

title (String)

Title of the discount.

value (Float!) Required

The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

valueType (DraftOrderAppliedDiscountType!) Required

The type of discount.

Sign up for a Partner account to get started.

Sign up