Skip to main content

CreatePromotionInput

Input for creating a new promotion

input CreatePromotionInput {
name: String!
active: Boolean
promotionType: PromotionType!
subject: PromotionSubject
discountValue: Float
creditValue: Float
rules: [CreateRuleInput!]
redemptionCodeFormat: String
startDate: Date
endDate: Date
redemptionCodeCount: Int
tremendous: CreateTremendousPromotionInput
connectedServiceType: ConnectedServiceType
channels: [PromotionChannel!]
merchantUuid: String
destinations: [AddPromotionDestinationInput!]
}

Fields

CreatePromotionInput.name ● String! non-null scalar

The name of the promotion

CreatePromotionInput.active ● Boolean scalar

Set the promotion to active or inactive upon creation

CreatePromotionInput.promotionType ● PromotionType! non-null enum

The type of promotion

CreatePromotionInput.subject ● PromotionSubject enum

The subject of the promotion

CreatePromotionInput.discountValue ● Float scalar

Discount value

CreatePromotionInput.creditValue ● Float scalar

Credit value

CreatePromotionInput.rules ● [CreateRuleInput!] list input

Rules for the promotion

CreatePromotionInput.redemptionCodeFormat ● String scalar

Redemption Code Format

CreatePromotionInput.startDate ● Date scalar

The date and time when the promotion starts

CreatePromotionInput.endDate ● Date scalar

The date and time when the promotion ends

CreatePromotionInput.redemptionCodeCount ● Int scalar

Number of redemption codes to generate when creating the promotion, maximum of 999

CreatePromotionInput.tremendous ● CreateTremendousPromotionInput input

Additional configuration for Tremendous promotions

CreatePromotionInput.connectedServiceType ● ConnectedServiceType enum

The connected service type for the promotion

CreatePromotionInput.channels ● [PromotionChannel!] list enum

Channels where this promotion should be distributed

CreatePromotionInput.merchantUuid ● String scalar

UUID of the merchant to associate with this promotion

CreatePromotionInput.destinations ● [AddPromotionDestinationInput!] list input

Destination services for this promotion

Member Of

createPromotion mutation