Skip to main content
Version: 3.x

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

id (ID!)

type (OrderDiscountType!)

name (String)

translatedName (String)

valueType (DiscountValueTypeEnum!)

Type of the discount: fixed or percent

value (PositiveDecimal!)

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

reason (String)

Explanation for the applied discount.

Requires one of the following permissions: MANAGE_ORDERS.

amount (Money!)

Returns amount of discount.

Interfaces

Node

An object with an ID