PromotionsBogoPromotion
- typeenumconst:BogoPromotionrequired
Returns one of the following: Bogo OrderReduction Coupon GiftCard Combo
Possible values:
None= 0Bogo= 1OrderReduction= 2Coupon= 3GiftCard= 4Combo= 5Max= 6
- allowType: boolean
Later Order Reductions True if other promotions and discounts can be applied to orders that already have this promotion applied, False if not
- allowType: boolean
Prior Item Promotions True if this promotion can be applied to items that already have a promotion applied, False if not
- allowType: boolean
Prior Modifier Promotions True if this promotion can be applied to modifiers that already have a promotion applied, False if not
- allowType: boolean
Prior Order Reductions True if this promotion can be applied to orders that already have a promotion or discount applied, False if not
- alternateType: null | string
Id AlternateId for this promotion provided for customer integration
- amountType: null | number | stringFormat: double
Amount of this Promotion
- automaticallyType: boolean
Apply True if automatically apply the Promotion when qualifying items are ordered, False if not
- barType: null | string
Code Bar code value that can be scanned to apply the promotion when not using single use codes
- canType: boolean
Span Multiple Seats True if an automatically-applied Promotion should look at all items in an order, False if only for items for a specific seat before being applied
- codeType: null | string
Code that can be manually entered to apply the promotion when not using single use codes
- customType:
Fields Properties: 3Dictionary of User Defined key value pair.
- daysType: nullable
Returns a byte describing the days this Promotion is available: 0 = None 1 = Sunday 2 = Monday 4 = Tuesday 8 = Wednesday 16 = Thursday 32 = Friday 64 = Saturday If multiple days are selected, binary addition is used in determining this value.
Possible values:
None= 0Sunday= 1Monday= 2Tuesday= 4Wednesday= 8Thursday= 16Friday= 32Saturday= 64
- discountedType: integer | stringFormat: int32
Item Group Id Id of the Item group containing the items that qualify for the Promotion
- discountedType:
Item Ids Properties: 2Eligible Items in this Promotion
- endType: null | stringFormat: date-time
Date End date of this Promotion
- endType: null | string
Time End time for this Promotion
- enforceType: boolean
Date Range True if StartDate and EndDate are enforced, False if not
- enforceType: boolean
Days True if Days are enforced, False if not
- enforceType: boolean
Maximum Amount True if Maximum Amount for a order is enforced, False if not
- enforceType: boolean
Maximum Per Order True if Maximum number of promotions that can be applied for a order is enforced, False if not
- enforceType: boolean
Time Range True if StartTime and EndTime are enforced, False if not
- freeType: nullable
Item Type Possible values:
GreatestPrice= 0LowestPrice= 1
- idType: integer | stringFormat: int32
Signed 32-bit integers (commonly used integer type).
- isType: boolean
Active True if this Promotion is active, False if inactive
- isType: boolean
Approval Needed True if this Promotion can only be applied by an authorized employee, False if not
- isType: boolean
Code Required True if Promotion can only be applied be entering or scanning a code, False if not
- limitType: boolean
Destinations True if Promotion is to be applied for a specific destination, False if not
- limitType: boolean
Sections True if Promotion is to be applied for a specific section, False if not
- limitType: boolean
Terminals True if Promotion is to be applied for a specific terminal, False if not
- marketingType: null | integer | stringFormat: int32
Campaign Id Id of Marketing campaign to assign to the order
- maximumType: null | number | stringFormat: double
Amount Maximum total dollar value of the promotion per order
- maximumType: null | integer | stringFormat: int32
Per Order Maximum number of times the promotion can be applied to a single order
- nameType: null | string
- pricingType:
Method Possible values:
Free= 0DiscountedPrice= 1PercentDiscount= 2DollarDiscount= 3
- printedType: null | string
Name Name to be printed on the order receipt
- priorityType: integer | stringFormat: uint16
Sort priority of this Promotion
- Properties: 5qualificationsType:
- qualifyType: boolean
True if additional items must be ordered before the qualifying item can be discounted, False if not
- requireType: boolean
Single Use Code True if Promotion can only be applied by using a single use promotion code, False if not
- startType: null | stringFormat: date-time
Date Start date of this Promotion
- startType: null | string
Time Start time of this Promotion
- validType:
Destinations Properties: 1Destinations to which this Promotion must be applied
- validType:
Sections Properties: 1Sections to which this Promotion must be applied
- validType:
Terminal Types Returns one of the following: None Register CustomerPortal Kiosk CustomerPortalMobile WebService MobileApp
Possible values:
None= 0Register= 1CustomerPortal= 2CustomerPortalMobile= 8WebService= 16MobileApp= 32
