Skip to main content
View Markdown

OrderLineDiscount Object

Represent the discount applied to order line.

type OrderLineDiscount {
  id: ID!
  type: OrderDiscountType!
  name: String
  translatedName: String
  valueType: DiscountValueTypeEnum!
  value: PositiveDecimal!
  reason: String
  total: Money!
  unit: 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 discount amount applied to the line item.

unit ● Money!​

The discount amount applied to the single line unit.

Member Of​

OrderLine object