v1

latestOpenAPI 3.0.02026-07-1498163181.9 KB

Coupons

List of coupons

Returns the list of coupons

get/api/v1/coupons

Query parameters

pagenumber

Page number. Starts from 1

limitnumber

Number of items per page

isnullboolean

Returns null values

notnullboolean

Returns not null values

gtstring date-time

Returns values greater than the given date

gtestring date-time

Returns values greater than or equal to the given date

ltstring date-time

Returns values less than the given date

ltestring date-time

Returns values less than or equal to the given date

idsstring[]

Filter by id. Returns items with given ids

isEnableboolean

If true, only active coupons will be returned

isArchivedboolean

If true, only archived coupons will be returned

searchTextstring

Response

pagenumber required

Page number. Starts from 1

limitnumber required

Number of items per page

countnumber required

hasMoreboolean required

Example response

{
  "page": 1,
  "limit": 10,
  "count": 1,
  "query": {
    "page": 1,
    "limit": 10
  },
  "data": [
    {
      "percentOff": 1,
      "maxRedemptions": 1,
      "promotionCodes": [
        {
          "maxRedemptions": 1
        }
      ],
      "timesRedeemed": 1
    }
  ]
}