Skip to main content
Log inSign up
Anchor to DraftOrderPlatformDiscount

DraftOrderPlatformDiscount

object

Requires read_draft_orders access scope.

The platform discounts applied to the draft order.

•

Price reduction allocations across the draft order's lines.

•
Boolean!non-null

Whether the discount is an automatic discount.

•
Boolean!non-null

Whether the discount is a buy x get y discount.

•

If a code-based discount, the code used to add the discount.

•

The discount node for the platform discount.

•

The ID of the discount.

•
String!non-null

Whether the discount is line, order or shipping level.

•
String!non-null

The short summary of the discount.

•
String!non-null

The summary of the discount.

•
String!non-null

The name of the discount.

•
MoneyV2!non-null

The discount total amount in shop currency.

•
MoneyBag!non-null

The amount of money discounted, with values shown in both shop currency and presentment currency.

•
DiscountClass!non-nullDeprecated

The discount class. Use discountClasses instead.


Was this section helpful?