/changes/merchant-visibility | Kelkoo Group Help Center

The /changes/merchant-visibility endpoint lists all merchants you have access to, who have been activated/deactivated in requested period.

Endpoint

/changes/merchant-visibility

See Request builder

Authentication

See JWT details

Query parameters

Name	Type	Domain	Default	Description	Example
`country`	string			Country filter	`country=fr`
`format`	string	{'json'}	'json'	Output format. Can be specified in the headers.	`format=json`
`from`	string			Start time of the period (ISO 8601 instant).	`from=2021-05-02T09:45:00Z`
`to`	string		now minus few seconds	End time of the period (ISO 8601 instant).	`to=2021-05-02T14:12:30Z`

Value from must be before to
from and to value should be URL encoded (: replaced by %3A), eg: 2021-05-02T14%3A12%3A30Z

HTTP headers

Name	Type	Domain	Default	Description	Example
`Accept`	string	{'application/json'}		Output format. Can be specified in the parameters. The http parameters wins.	`Accept: application/json`

Merchant visibility changes fields

Here are the fields available.

The id 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.

Merchant visibility changes

Field	Type	Description	Example
`activatedMerchants`	Array of merchants	List of merchants which have been activated during the period
`deactivatedMerchants`	Array of merchants	List of merchants which have been deactivated during the period

Merchant

Field	Type	Description	Example
`id`	Number	Identifier in KelkooGroup APIs	123456789
`name`	String	Name	Some merchant name

Response

The response is in json.

JSON

Merchant visibility changes

Given I have following merchant changes for the profileId 321 in the country fr

offersTrafficComIdsAdded	offersTrafficComIdsRemoved
100480666,100480111	100480777

When I perform a GET with defined headers on following URL /api/public/changes/merchant-visibility?format=json&country=fr&from=2021-05-02T09:00:00Z
Then I get a response with status 200
And I get following json body response

JSON

{
  "offersTraffic": {
    "activatedMerchants": [
      {
        "id": 100480666,
        "name": "Boulanger",
        "isNew": true
      },
      {
        "id": 100480111,
        "name": "Fnac",
        "isNew": false
      }
    ],
    "deactivatedMerchants": [
      {
        "id": 100480777,
        "name": "Geant"
      }
    ]
  }
}

Merchant visibility changes with inactive merchants

Given I have following merchant changes for the profileId 321 in the country fr

offersTrafficComIdsAdded	offersTrafficComIdsRemoved
100480666,100480111	100480777,100480999

And I have the merchant 100480999 called Inactifitude
When I perform a GET with defined headers on following URL /api/public/changes/merchant-visibility?format=json&country=fr&from=2021-05-02T09:00:00Z
Then I get a response with status 200
And I get following json body response

JSON

{
  "offersTraffic": {
    "activatedMerchants": [
      {
        "id": 100480666,
        "name": "Boulanger",
        "isNew": true
      },
      {
        "id": 100480111,
        "name": "Fnac",
        "isNew": false
      }
    ],
    "deactivatedMerchants": [
      {
        "id": 100480777,
        "name": "Geant"
      },
      {
        "id": 100480999,
        "name": "Inactifitude"
      }
    ]
  }
}