Choose a version:

DraftOrderPlatformDiscount

object

Requires read_draft_orders access scope.

The platform discounts applied to the draft order.

Anchor to FieldsFields

Anchor to allocationsallocations •[DraftOrderPlatformDiscountAllocation!]! non-null: Price reduction allocations across the draft order's lines.
Anchor to automaticDiscountautomaticDiscount •Boolean! non-null: Whether the discount is an automatic discount.
Anchor to bxgyDiscountbxgyDiscount •Boolean! non-null: Whether the discount is a buy x get y discount.
Anchor to codecode •String: If a code-based discount, the code used to add the discount.
Anchor to discountNodediscountNode •DiscountNode: The discount node for the platform discount.
Anchor to idid •ID: The ID of the discount.
Anchor to presentationLevelpresentationLevel •String! non-null: Whether the discount is line, order or shipping level.
Anchor to shortSummaryshortSummary •String! non-null: The short summary of the discount.
Anchor to summarysummary •String! non-null: The summary of the discount.
Anchor to titletitle •String! non-null: The name of the discount.
Anchor to totalAmounttotalAmount •MoneyV2! non-null: The discount total amount in shop currency.
Anchor to totalAmountPriceSettotalAmountPriceSet •MoneyBag! non-null: The amount of money discounted, with values shown in both shop currency and presentment currency.
Anchor to discountClassdiscountClass •DiscountClass! non-nullDeprecated

Was this section helpful?