List Offers

Returns offers list.

Query Parameters

Parameter	Type	Default	Description
scope	enum	`standard`	Determines the scope the API operates on. See Offers scoping
per_page	integer	100	Number of results to be returned per request (100 is the maximum)
page_no	integer	1	Number of results page
include_pagination_info	boolean	false	When true, pagination info (containing info like total records count, next page) will be returned
order_by	string	"name"	See `order_by` param
collection_ids	integer[]	null	When present, only offers belonging to least one of given collections will be returned
stores	string[]	null	When present, only offers having at least one of given stores will be returned
store_ids	integer[]	null	When present, only offers having at least one of given stores will be returned
ids	integer[]	null	When present, only offers with this id will be returned
type	string	null	When present, only offers of this type will be returned
campaign_id	integer[]	null	When present, only offers with this campaign_id will be returned
search	string	null	When present, only offers that match the query string will be returned
usable	boolean	false	When true, only offers that are usable will be returned
liked	boolean	false	When true, only offers that have been liked by member

All parameters are optional.

Offers list may be sorted by order_by param, which has similar syntax as ORDER BY keyword in SQL statements.

For example order_by=usable ASC, created_at DESC will return offers sorted by their usability, then by their creation date.

Following offer attributes may be used for sorting in general:

name

usable_since

usable_until

created_at

Only in member context (does not work with /guest/ context:

usable

uses_left

liked

Also, when querying offers by single collection_id, the list may also be sorted by:

collection_position

Key	Type	Optional?	Description
offers	Offer[]	no (may be empty)	See Offer model
pagination_info	PaginationInfo	yes	See Pagination info model

When successful, returns a list of offers and pagination info. See Offer model and Offer model

{
  "offers": [
    {
      // (...) - see Offer model
    }
  ],
  "pagination_info": {
      // (...) - see Pagination info model
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby