Skip to main content

BusinessRuleCreateInput

Input data for creating a new business rule with basic configuration and metadata

input BusinessRuleCreateInput {
  name: [LocalizedStringInput!]!
  type: BusinessRuleType!
  channelIds: [Int!]
  active: Boolean
  validFrom: DateTime
  validUntil: DateTime
  description: [LocalizedStringInput!]
}

Fields​

BusinessRuleCreateInput.name ● [LocalizedStringInput!]! non-null input​

Localized names for the business rule supporting multiple languages for international use

BusinessRuleCreateInput.type ● BusinessRuleType! non-null enum​

Classification of the business rule determining its domain context and application scope

BusinessRuleCreateInput.channelIds ● [Int!] list scalar​

Channel ids this rule applies to. Omit or pass an empty list to apply the rule to every channel in the tenant.

BusinessRuleCreateInput.active ● Boolean scalar​

Whether the rule is applied. An inactive rule stays stored and editable but is skipped when rules are executed. Omit to create an active rule; null is rejected.

BusinessRuleCreateInput.validFrom ● DateTime scalar​

Start of the period in which the rule is applied, inclusive, as a UTC instant. Must not be later than validUntil. Omit or pass null for no start.

BusinessRuleCreateInput.validUntil ● DateTime scalar​

End of the period in which the rule is applied, inclusive, as a UTC instant. Must not be earlier than validFrom. Omit or pass null for no end.

BusinessRuleCreateInput.description ● [LocalizedStringInput!] list input​

Localized description of the business rule, one entry per language, at most 50 entries of at most 2000 characters. Omit or pass null for no description.

Member Of​

businessRuleCreate mutation ● incentiveRuleCreate mutation