Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 3.36 KB

CouponDeletionFilters.md

File metadata and controls

35 lines (22 loc) · 3.36 KB
Raw

TalonOne.CouponDeletionFilters

Properties

Name Type Description Notes
createdBefore Date 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 Date 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 Date 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 Date 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 Boolean - `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 Boolean - `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 Boolean 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 Number 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 Date 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 Date 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]

Enum: ValidEnum

  • expired (value: "expired")

  • validNow (value: "validNow")

  • validFuture (value: "validFuture")