DraftOrderAppliedDiscount

Version 2019-04 (latest)

The order-level discount applied to a draft order.

Required access

read_draft_orders access scope

Show definition
"""
The order-level discount applied to a draft order.
"""
type DraftOrderAppliedDiscount {
  """
  Amount of the order-level discount that is applied to the draft order.
  """
  amount: Money!
  """
  Amount of money discounted.
  """
  amountV2: MoneyV2!
  """
  Description of the order-level discount.
  """
  description: String!
  """
  Name of the order-level discount.
  """
  title: String
  """
  Amount of the order level discount (when value_type is percentage,
  the value in this field is the percentage discount).
  """
  value: Float!
  """
  Type of the order-level discount.
  """
  valueType: DraftOrderAppliedDiscountType!
}

Fields

amountV2 (MoneyV2!)

Amount of money discounted.

description (String!)

Description of the order-level discount.

title (String)

Name of the order-level discount.

value (Float!)

Amount of the order level discount (when value_type is percentage, the value in this field is the percentage discount).

valueType (DraftOrderAppliedDiscountType!)

Type of the order-level discount.

Deprecated fields

Show/Hide
amount (Money!) deprecated

Amount of the order-level discount that is applied to the draft order.

Deprecation warning

Use amountV2 instead

Sign up for a Partner account to get started.

Sign up