List Offers

Returns offers list.

Query Parameters

Parameter	Type	Default	Description
scope	enum	`standard`	When present, only offers from given scope will be returned
types	string[]	null	When present, only offers of given types will be returned
per_page	integer	100	Number of results to be returned per request (100 is the maximum)
page_no	integer	1	Number of results page
sort_by	string	"name"	What attribute should results be sorted by? Supported attributes are: `["name", "usable_since", "usable_until", "visible_since", "visible_until", "created_at", "updated_at", "archived_at"]`
sort_direction	string	"asc"	Direction of sorting: "asc" or "desc"
collection_ids	integer[]	null	When present, only offers belonging to at least one of given collections will be returned
store_ids	integer[]	null	When present, only offers belonging to at at least one of given store_id will be returned
status	enum	null	When present, only offers with this status will be returned. See: statuses
campaign_id	integer	null	When present, only offers with this campaign_id will be returned
audience_id	integer	null	When present, only offers with this audience_id will be returned
search	string	null	When present, only offers that match the query string will be returned
extras	object	null	When present, only offers that match given values will be returned. See: below
ids	integer[]	null	When present, only offers having one of provided IDs will be returned
without_collection	boolean	false	When present, only offers without collections will be returned
without_audience_id	boolean	false	When present, only offers without audiences will be returned
without_campaign_id	boolean	false	When present, only offers without campaigns will be returned
without_store	boolean	false	When present, only offers without store will be returned
with_archived	boolean	false	When present, also archived offers will be returned
only_archived	boolean	false	When present, only archived offers will be returned
visible_since_after	datetime	null	When present, only offers with greater visible_since will be returned
visible_since_before	datetime	null	When present, only offers with lesser visible_since will be returned
visible_until_after	datetime	null	When present, only offers with greater visible_until will be returned
visible_until_before	datetime	null	When present, only offers with lesser visible_until will be returned
usable_since_after	datetime	null	When present, only offers with greater usable_since will be returned
usable_since_before	datetime	null	When present, only offers with lesser usable_since will be returned
usable_until_before	datetime	null	When present, only offers with lesser usable_until will be returned

All parameters are optional.

Filtering by `extras`

It is possible to filter offers by their extra attribute(s).

Syntax: ?extras[<attribute>]=(!)<value>

Values are always compared as strings

"!" may be used as a value prefix to achieve negative filtering

Multiple attributes may be filtered simultaneously

Example 1: ?extras[category]=Food

It will return offers that have extras["category"].toString() = 'Food'.

Example 2: ?extras[category_id]=!3&extras[type]=external

It will return offers that have extras["category_id"].toString() != '3' && extras["type"].toString() == 'external'.

Response Body

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

Example

When successful, returns a list of offers and
Pagination Info

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

Request

Path Params

loyalty_club_slug

string

required

Example:

infinity-mall

Query Params

publication_status

enum<string>

optional

When present, only records of given publication status will be returned

Allowed values:

publishedunpublisheddraftscheduledexpired

Example:

published

excluded_publication_status

string

optional

When present, only records with publication status different than given will be returned

Example:

expired

cms_tag_ids[]

array[integer]

optional

When present, only records having one of specified tag ids will be returned

Example:

["7","10"]

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Query Parameters#

Filtering by extras#

Response Body#

Example#

Request

Request samples

Responses

Query Parameters

Filtering by `extras`

Response Body

Example