Skip to main content

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​

OrderLineDiscount.id ● ID! non-null scalar miscellaneous​

The ID of discount applied.

OrderLineDiscount.type ● OrderDiscountType! non-null enum discounts​

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

OrderLineDiscount.name ● String scalar miscellaneous​

The name of applied discount.

OrderLineDiscount.translatedName ● String scalar miscellaneous​

Translated name of the applied discount.

OrderLineDiscount.valueType ● DiscountValueTypeEnum! non-null enum discounts​

Type of the discount: fixed or percent

OrderLineDiscount.value ● PositiveDecimal! non-null scalar miscellaneous​

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

OrderLineDiscount.reason ● String scalar miscellaneous​

Explanation for the applied discount.

Requires MANAGE_ORDERSpermission.

OrderLineDiscount.total ● Money! non-null object miscellaneous​

The discount amount applied to the line item.

OrderLineDiscount.unit ● Money! non-null object miscellaneous​

The discount amount applied to the single line unit.

Member Of​

OrderLine object