Promotion

Promotion / Discount

type Promotion {
  uuid: String!
  name: String!
  active: Boolean!
  status: PromotionStatus!
  pausedReason: String
  pausedUpdatedAt: Date
  createdAt: Date!
  updatedAt: Date!
  subject: PromotionSubject!
  promotionType: PromotionType!
  redemptionValidPeriodHours: Int
  redemptionCodeCount: Int
  creditValue: Float
  discountAmount: DiscountAmount
  startDate: Date
  endDate: Date
  redemptionCodeFormat: String
  redemptionCodeLength: Int
  rules: [Rule!]
  deliveryMethod: RedemptionChannelDeliveryMethod
  tremendousCampaign: TremendousCampaign
  redemptionCodes(
    code: String
    redeemed: Boolean
    recipientEmail: String
    recipientPhone: String
  ): [RedemptionCode!]
  connectedService: ConnectedService
  sourceUrl: String
  merchant: Merchant
  destinations: [PromotionDestination!]!
}

Fields

Promotion.uuid ● String! non-null scalar

UUID of a Promotion

Promotion.name ● String! non-null scalar

The name of the Promotion

Promotion.active ● Boolean! non-null scalar

Active status of the Promotion

Promotion.status ● PromotionStatus! non-null enum

Lifecycle status of the Promotion

Promotion.pausedReason ● String scalar

Reason the promotion was paused

Promotion.pausedUpdatedAt ● Date scalar

When the promotion pause state last changed

Promotion.createdAt ● Date! non-null scalar

The creation date of the Promotion

Promotion.updatedAt ● Date! non-null scalar

The updated date of the Promotion

Promotion.subject ● PromotionSubject! non-null enum

The subject of the Promotion

Promotion.promotionType ● PromotionType! non-null enum

The type of the promotion

Promotion.redemptionValidPeriodHours ● Int scalar

In hours, period is started from the time of redemption code creation.

Promotion.redemptionCodeCount ● Int scalar

How many discount codes associated with the Promotion

Promotion.creditValue ● Float scalar

E.g. number of points or dollar amount

Promotion.discountAmount ● DiscountAmount union

The value of the Promotion discount

Promotion.startDate ● Date scalar

The date and time when the Promotion starts

Promotion.endDate ● Date scalar

The date and time when the Promotion ends

Promotion.redemptionCodeFormat ● String scalar

The format of the redemption code

Promotion.redemptionCodeLength ● Int scalar

The length of the redemption code after the prefix

Promotion.rules ● [Rule!] list object

The rules of the Promotion. All rules must be met for the Promotion to be applied.

Promotion.deliveryMethod ● RedemptionChannelDeliveryMethod enum

Default delivery method for reward issuance (used by Tremendous)

Promotion.tremendousCampaign ● TremendousCampaign object

The Tremendous campaign linked to this promotion, if applicable

Promotion.redemptionCodes ● [RedemptionCode!] list object

The Redemption Codes associated to a Promotion

Promotion.redemptionCodes.code ● String scalar

Filter by exact redemption code value

Promotion.redemptionCodes.redeemed ● Boolean scalar

Filter by redeemed status

Promotion.redemptionCodes.recipientEmail ● String scalar

Filter by recipient email

Promotion.redemptionCodes.recipientPhone ● String scalar

Filter by recipient phone

Promotion.connectedService ● ConnectedService object

Connected Service

Promotion.sourceUrl ● String scalar

Direct URL to the source of the promotion

Promotion.merchant ● Merchant object

Merchant associated with this promotion

Promotion.destinations ● [PromotionDestination!]! non-null object

Destination services for this promotion

Returned By

togglePromotionActivation mutation

Member Of

Account object ● CreatePromotionResult object ● PausePromotionResult object ● UpdatePromotionResult object