DraftOrderPlatformDiscount - admin-graphql - OBJECT
Version: 2025-01
Description:
The platform discounts applied to the draft order.
Access Scopes
`read_draft_orders` access scope.
Fields
-
allocations:
DraftOrderPlatformDiscountAllocation! -
Price reduction allocations across the draft order's lines.
-
automaticDiscount:
Boolean! -
Whether the discount is an automatic discount.
-
bxgyDiscount:
Boolean! -
Whether the discount is a buy x get y discount.
-
code:
String -
If a code-based discount, the code used to add the discount.
-
discountClass:
DiscountClass! -
The discount class.
-
discountNode:
DiscountNode -
The discount node for the platform discount.
-
id:
ID -
The ID of the discount.
-
presentationLevel:
String! -
Whether the discount is line, order or shipping level.
-
shortSummary:
String! -
The short summary of the discount.
-
summary:
String! -
The summary of the discount.
-
title:
String! -
The name of the discount.
-
totalAmount:
MoneyV2! -
The discount total amount in shop currency.
-
totalAmountPriceSet:
MoneyBag! -
The amount of money discounted, with values shown in both shop currency and presentment currency.
Connections
Related queries
Related mutations
Related Unions
Examples
