Breadcrumbs

Offers feeds - Request

Endpoint: /feeds/offers: retrieve offers with a stream.

Authentication

See JWT details

Compressed data

Please note that you should ask for compressed data, otherwise you will receive an error 406 Not Acceptable.

Most HTTP client libraries offer a setting to transparently activate compression when configuring the client. See below in the HTTP Headers section how to do it manually.

Query parameters

Filters

Name

Type

Domain

Default

Description

Example

country*

string



Country filter

country=fr

part (3)

int

1 to numberOfParts


Part to download

part=2

numberOfParts (3)

int

2, 4, 8


Total number of parts to split

numberOfParts=8

merchantId(1)

int



Merchant filter

merchantId=1354321

categoryId(1)(2)

int



Category filter. Categories that are descendants of the specified category are implicitly included

categoryId=124901

topOffers

long



Returns at most topOffers offers sorted according to their performance score in descending order

topOffers=200

(1) Most of the time you will want a breakdown either by category or by merchant to retrieve all available offers. Note that the list of merchants and categories vary over time, thus you must refresh it every time you intend to download an offer feed.

(2) Please read the offers by category guide.

(3) Please read the offers by parts guide.

Format

Name

Type

Domain

Default

Description

Example

format

string

{'json', 'xml', 'csv', 'tsv'}

json

Define the output format

format=xml

Fields

Name

Type

Domain

Default

Description

Example

fieldsAlias

string

{'none','minimal','all'}

'minimal'

Pre defined list of fields. If not defined, the most useful fields will be provided: the fields behind the alias 'minimal'.

fieldsAlias=minimal

additionalFields

string

fields list


List of fields that should be returned in addition to the fields selected by fieldsAlias. The field names are expected in camelCase. See all the field names

additionalFields=brandId,featureType

Tip: use the fieldsAlias minimal and add only the extra fields you need with additionalFields. It's not recommended to use fieldsAlias all unless you really need all fields: taking only the fields you need will speed up the process on our side and yours as well.

See examples

HTTP headers

Name

Type

Domain

Default

Description

Example

Accept-Encoding

string

{'gzip'}


You have to request compressed data. This is the way to do it.

Accept-Encoding: gzip

Accept

string

{'application/json', 'application/xml', 'text/csv', 'text/tab-separated-values'}


Output format. Can be specified in the parameters. The http parameters wins.

Accept: application/json

Endpoint

See Request builder