Skip to main content

OrderDiscount Object

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! @deprecated
total: Money!
}

Fields

id ● ID!

The ID of discount applied.

type ● OrderDiscountType!

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

name ● String

The name of applied discount.

translatedName ● String

Translated name of the applied discount.

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 the MANAGE_ORDERSpermission.

total ● Money!

The amount of discount applied to the order.

Added in Saleor 3.21
Show deprecated

Interfaces

Node

An object with an ID

Member Of

Order object