/feeds/merchants/restrictions | Kelkoo Group Help Center

The /feeds/merchants/restrictions endpoint lists restrictions against merchants you have access to through KelkooGroup network. It contains excluded referrers which are source of traffic (URLs) from which the merchant must not be promoted.

You must take into account these exclusions as Kelkoo will not pay for traffic coming from these sources.

Endpoint

/feeds/merchants/restrictions

See Request builder

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

Name	Type	Domain	Default	Description	Example
`country`*	string			Country filter	`country=fr`
`format`	string	{`json`, `xml`, `csv`}	`json`	Output format. Can be specified in the headers.	`format=xml`

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'}		Output format. Can be specified in the parameters. The http parameters wins.	`Accept: application/json`

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'}

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

Accept: application/json

Merchant restrictions fields

Here are the fields available in a merchant restrictions entity.

The merchantId field is the identifier of a merchant in KelkooGroup systems and can be used with other resources. For instance, this identifier must be used when retrieving an offers feed to filter by a merchant.

Models

Merchant Restrictions

Field	Type	Description	Example
`merchantId`	Number	Merchant identifier in KelkooGroup APIs	123456789
`excludedReferrers`	Array of Strings	List of referrers urls that the merchant forbid	"http://forbidden-site.com"

Response

JSON format

When I call KelkooGroup API with a valid JWT on https://api.kelkoogroup.net/publisher/shopping/v2/feeds/merchants/restrictions?format=json&country=fr
Then I get a response with status 200
And I get a response with filename merchantsrestrictions-fr.json
And I get following json body response

JSON

[
  {
    "merchantId": 100480111,
    "excludedReferrers": [
      "http://forbidden-site.com",
      "http://www.another-one.com"
    ]
  },
  {
    "merchantId": 100480222,
    "excludedReferrers": [
      "http://forbidden-site.com"
    ]
  }
]

XML format

When I call KelkooGroup API with a valid JWT on https://api.kelkoogroup.net/publisher/shopping/v2/feeds/merchants/restrictions?format=xml&country=fr
Then I get a response with status 200
And I get a response with filename merchantsrestrictions-fr.xml
And I get a response containing the following xml content

XML

<?xml version='1.0' encoding='UTF-8'?>
<MerchantsRestrictions>
<Merchant id="100480111">
<ExcludedReferrers>
  <ExcludedReferrer>http://forbidden-site.com</ExcludedReferrer>
  <ExcludedReferrer>http://www.another-one.com</ExcludedReferrer>
</ExcludedReferrers>
</Merchant>
<Merchant id="100480222">
<ExcludedReferrers>
  <ExcludedReferrer>http://forbidden-site.com</ExcludedReferrer>
</ExcludedReferrers>
</Merchant>
</MerchantsRestrictions>

CSV format

When I call KelkooGroup API with a valid JWT on https://api.kelkoogroup.net/publisher/shopping/v2/feeds/merchants/restrictions?format=csv&country=fr
Then I get a response with status 200
And I get a response with filename merchantsrestrictions-fr.csv
And I get a response containing the following csv content

"merchant_id","excluded_referrers"
"100480111","http://forbidden-site.com\thttp://www.another-one.com"
"100480222","http://forbidden-site.com"