Skip to content

AdStatus

The numeric values of the statuses are defined as powers of two to enable concatenation (bitwise OR) of the values when filtering by status. However, a single ad can never have multiples statuses. See the progression of statuses section below.

Status Enum Value Description
Undefined 0 No ad will have this status
New 1 The ad is new and not served
Served 2 The ad is served
Activated 4 The ad has been activated
Processing 8 The ad is processing, meaning the customer has made a redeeming transaction but the actual redemption hasn't been processed yet
Redeemed 16 The ad has been FULLY redeemed and no more redemption are possible, either because the ad has expired or the maximum number of redemptions have been made
Expired 32 The ad has expired and no redemptions were ever made for it

Info

Note that new ad statuses may be added in the future but the meanings of existing bits will not change


Progression of Ad Statuses

Ad statuses will transition in the following order and they are mutually exclusive each others:

  1. New
  2. Served
  3. Activated
  4. Processing
    • Only when RTM is enabled and an auth transaction is present that would redeem this offer once processed.
    • Ads in this state should still be considered activated
  5. Redeemed
  6. Expired

Rule Definition for Ad Statuses

New

  • Ad does not fall in the Expired, Redeemed, Processing, Activated, or Served category
  • Ad had not yet been marked as served

Served

  • Ad does not fall in the Expired, Redeemed, Processing, or Activated category
  • Ad first served other date or summary date is not null

Activated

  • Ad does not fall in the Expired, Redeemed, or Processing category
  • Ad activated date is not null

Processing

  • Ad does not fall in the Expired or Redeemed category
  • Ad shopped date is not null
  • Ad shopped date has not expired

Redeemed

  • Ad is fully redeemed

Expired

  • Ad days remaining is equal or less than 0

Info

For multi-redemption offers where redemptions have not hit the cap (not fully redeemed), the status will be 'expired'.