PromotionRule Object

Represents the promotion rule that specifies the conditions that must be met to apply the promotion discount.

type PromotionRule implements Node {
  id: ID!
  name: String
  description: JSON
  promotion: Promotion
  channels: [Channel!]
  rewardValue: PositiveDecimal
  rewardValueType: RewardValueTypeEnum
  predicateType: PromotionTypeEnum
  cataloguePredicate: JSON
  orderPredicate: JSON
  rewardType: RewardTypeEnum
  translation(languageCode: LanguageCodeEnum!): PromotionRuleTranslation
  giftIds: [ID!]
  giftsLimit: Int
}

Interfaces

Node

Fields

id

id · ID!

name

name · String

Name of the promotion rule.

description

description · JSON

Description of the promotion rule.

promotion

promotion · Promotion

Promotion to which the rule belongs.

channels

channels · [Channel!]

List of channels where the rule applies.

rewardValue

rewardValue · PositiveDecimal

The reward value of the promotion rule. Defines the discount value applied when the rule conditions are met.

rewardValueType

rewardValueType · RewardValueTypeEnum

The type of reward value of the promotion rule.

predicateType

predicateType · PromotionTypeEnum

The type of the predicate that must be met to apply the reward.

cataloguePredicate

cataloguePredicate · JSON

The catalogue predicate that must be met to apply the rule reward.

orderPredicate

orderPredicate · JSON

The checkout/order predicate that must be met to apply the rule reward.

rewardType

rewardType · RewardTypeEnum

The reward type of the promotion rule.

translation

translation · PromotionRuleTranslation

Returns translated promotion rule fields for the given language code.

languageCode

languageCode · LanguageCodeEnum!

A language code to return the translation for promotion rule.

giftIds

giftIds · [ID!]

Product variant IDs available as a gift to choose.

giftsLimit

giftsLimit · Int

Defines the maximum number of gifts to choose from the gifts list.

Used by

• Promotion (objects)
• PromotionRuleCreate (objects)
• PromotionRuleCreated (objects)
• PromotionRuleDelete (objects)
• PromotionRuleDeleted (objects)
• PromotionRuleTranslate (objects)
• PromotionRuleUpdate (objects)
• PromotionRuleUpdated (objects)

Schema: Saleor 3.23.43. Download SDL.