Skip to content

Latest commit

 

History

History
43 lines (36 loc) · 3.25 KB

NewCoupons.md

File metadata and controls

43 lines (36 loc) · 3.25 KB
Raw

TalonOne::NewCoupons

Properties

Name Type Description Notes
usage_limit Integer The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
discount_limit Float The total discount value that the code can give. Typically used to represent a gift card value. [optional]
reservation_limit Integer The number of reservations that can be made with this coupon code. [optional]
start_date DateTime Timestamp at which point the coupon becomes valid. [optional]
expiry_date DateTime Expiration date of the coupon. Coupon never expires if this is omitted. [optional]
limits Array<LimitConfig> Limits configuration for a coupon. These limits will override the limits set from the campaign. Note: Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. [optional]
number_of_coupons Integer The number of new coupon codes to generate for the campaign. Must be at least 1.
unique_prefix String DEPRECATED To create more than 20,000 coupons in one request, use Create coupons asynchronously endpoint. [optional]
attributes Object Arbitrary properties associated with this item. [optional]
recipient_integration_id String The integration ID for this coupon's beneficiary's profile. [optional]
valid_characters Array<String> List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. [optional]
coupon_pattern String The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. [optional]
is_reservation_mandatory Boolean An indication of whether the code can be redeemed only if it has been reserved first. [optional] [default to false]
implicitly_reserved Boolean An indication of whether the coupon is implicitly reserved for all customers. [optional]

Code Sample

require 'TalonOne'

instance = TalonOne::NewCoupons.new(usage_limit: 100,
                                 discount_limit: 30.0,
                                 reservation_limit: 45,
                                 start_date: 2020-01-24T14:15:22Z,
                                 expiry_date: 2023-08-24T14:15:22Z,
                                 limits: null,
                                 number_of_coupons: 1,
                                 unique_prefix: ,
                                 attributes: {&quot;venueId&quot;:12},
                                 recipient_integration_id: URNGV8294NV,
                                 valid_characters: [A, B, G, Y],
                                 coupon_pattern: SUMMER-#####,
                                 is_reservation_mandatory: false,
                                 implicitly_reserved: false)