OrderDiscount

Contains all details related to the applied discount to the order.

type OrderDiscount implements Node {
  id: ID!
  type: OrderDiscountType!
  name: String
  translatedName: String
  valueType: DiscountValueTypeEnum!
  value: PositiveDecimal!
  reason: String
  amount: Money!
}

Fields

OrderDiscount.id ● ID! non-null scalar

The ID of discount applied.

OrderDiscount.type ● OrderDiscountType! non-null enum

The type of applied discount: Sale, Voucher or Manual.

OrderDiscount.name ● String scalar

The name of applied discount.

OrderDiscount.translatedName ● String scalar

Translated name of the applied discount.

OrderDiscount.valueType ● DiscountValueTypeEnum! non-null enum

Type of the discount: fixed or percent

OrderDiscount.value ● PositiveDecimal! non-null scalar

Value of the discount. Can store fixed value or percent value

OrderDiscount.reason ● String scalar

Explanation for the applied discount.

Requires MANAGE_ORDERSpermission.

OrderDiscount.amount ● Money! non-null object

Returns amount of discount.

Interfaces

Node interface

An object with an ID

Member of

Order object