Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 3.48 KB

CouponDeletionFilters.md

File metadata and controls

24 lines (19 loc) · 3.48 KB
Raw

# CouponDeletionFilters

Properties

Name Type Description Notes
createdBefore \DateTime Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. [optional]
createdAfter \DateTime Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. [optional]
startsAfter \DateTime Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. [optional]
startsBefore \DateTime Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. [optional]
valid string - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which the start date is null or in the past and the expiration date is null or in the future. - `validFuture`: Matches coupons in which the start date is set and in the future. [optional]
usable bool - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. [optional]
redeemed bool - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. Note: This field cannot be used in conjunction with the `usable` query parameter. [optional]
recipientIntegrationId string Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. [optional]
exactMatch bool Filter results to an exact case-insensitive matching against the coupon code [optional] [default to false]
value string Filter results by the coupon code [optional] [default to 'false']
batchId string Filter results by batches of coupons [optional]
referralId int Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. [optional]
expiresAfter \DateTime Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. [optional]
expiresBefore \DateTime Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. [optional]

[Back to Model list] [Back to API list] [Back to README]