DraftOrderAppliedDiscount object

The order-level discount applied to a draft order.

Required access

read_draft_orders access scope.

On this page

Fields

  • amountV2 ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Amount of money discounted.
  • description ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Description of the order-level discount.
  • title ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Name of the order-level discount.
  • value ([Float!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#float-2021-01))
    Amount of the order level discount (when value_type is percentage, the value in this field is the percentage discount).
  • valueType ([DraftOrderAppliedDiscountType!](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorderapplieddiscounttype))
    Type of the order-level discount.

Types that return DraftOrderAppliedDiscount

  • [CalculatedDraftOrder.appliedDiscount](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculateddraftorder#applieddiscount-2021-01)
  • [CalculatedDraftOrderLineItem.appliedDiscount](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculateddraftorderlineitem#applieddiscount-2021-01)
  • [DraftOrder.appliedDiscount](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorder#applieddiscount-2021-01)
  • [DraftOrderLineItem.appliedDiscount](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorderlineitem#applieddiscount-2021-01)

Deprecated fields

Show/Hide

  • amount ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01)) DEPRECATED
    Amount of the order-level discount that is applied to the draft order.
    Deprecation warning
    Use amountV2 instead