CalculatedDiscountCodeApplication object

Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.

Required access

read_order_edits access scope.

On this page

Fields

  • allocationMethod ([DiscountApplicationAllocationMethod!](https://shopify.dev/docs/admin-api/graphql/reference/orders/discountapplicationallocationmethod))
    The method by which the discount’s value is allocated to its entitled items.
  • appliedTo ([DiscountApplicationLevel!](https://shopify.dev/docs/admin-api/graphql/reference/orders/discountapplicationlevel))
    The level at which the discount was applied.
  • code ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The string identifying the discount code that was used at the time of application.
  • description ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The description of discount application. Indicates the reason why the discount was applied.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • targetSelection ([DiscountApplicationTargetSelection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/discountapplicationtargetselection))
    How the discount amount is distributed on the discounted lines.
  • targetType ([DiscountApplicationTargetType!](https://shopify.dev/docs/admin-api/graphql/reference/orders/discountapplicationtargettype))
    Whether the discount is applied on line items or shipping lines.
  • value ([PricingValue!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/pricingvalue))
    The value of the discount application.

Implements

  • [CalculatedDiscountApplication](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculateddiscountapplication)