Show Offers Meta

Returns offers metadata which consists of:

aggregated lists of records currently associated with offers (stores, collections)

Loyalty Club configuration

Query Parameters

Parameter	Type	Required?	Default	Description
scope	enum	no	`standard`	Determines the scope the API operates on. See Offers scoping

Response Body

Key	Type	Optional?	Description
stores	string[]	no (may be empty)	List of unique stores assigned to offers
collections	Collection[]	no (may be empty)	List of unique collections assigned to offers - see Collection model
activated_seconds_time	integer	no	Number of seconds the offers stays active after member uses it

Example

When successful, returns JSON structured like this:

{
    "stores": ["M&H", "Doo Doo"],
    "collections": [
        {
            "id": 1000016,
            "title": "Collection #1",
            "description": null,
            "offers_order": [1000115, 1000112, 1000114],
            "files": [
                {
                    "url": "https://offers-api.s3.eu-central-1.amazonaws.com/collection-1000016-collection_cover_default-original.jpg",
                    "width": 600,
                    "height": 300,
                    "kind": "collection_cover_default",
                    "size_type": "original"
                },
                {
                    "url": "https://offers-api.s3.eu-central-1.amazonaws.com/collection-1000016-collection_cover_default-thumbnail.jpg",
                    "width": 300,
                    "height": 150,
                    "kind": "collection_cover_default",
                    "size_type": "thumbnail"
                },
                {
                    "url": "https://offers-api.s3.eu-central-1.amazonaws.com/collection-1000016-collection_cover_default-base.jpg",
                    "width": 600,
                    "height": 300,
                    "kind": "collection_cover_default",
                    "size_type": "base"
                }
            ]
        }
    ],
    "activated_seconds_time": 35
}

Request

Path Params

loyalty_club_slug

string

required

Example:

infinity-mall

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#

Response Body#

Example#

Request

Request samples

Responses

Query Parameters

Response Body

Example