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!
}

Fields

OrderDiscount.id ● ID! non-null scalar miscellaneous

The ID of discount applied.

OrderDiscount.type ● OrderDiscountType! non-null enum discounts

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

OrderDiscount.name ● String scalar miscellaneous

The name of applied discount.

OrderDiscount.translatedName ● String scalar miscellaneous

Translated name of the applied discount.

OrderDiscount.valueType ● DiscountValueTypeEnum! non-null enum discounts

Type of the discount: fixed or percent

OrderDiscount.value ● PositiveDecimal! non-null scalar miscellaneous

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

OrderDiscount.reason ● String scalar miscellaneous

Explanation for the applied discount.

Requires MANAGE_ORDERSpermission.

OrderDiscount.amount ● Money! non-null object miscellaneous

Returns amount of discount.

Interfaces

Node interface miscellaneous

An object with an ID

Member Of

Order object