Get list of merchants

Use this endpoint to receive the list of merchants available in Takeads catalog.

A merchant is a company that sells its products or services through one or more advertisers. For example, as a merchant, Nike distributes products through the following advertisers: nike.com, nike.eu, nike.de, etc.

When querying a list of merchants, details about each merchant from the list are also provided in the response.

If you receive an empty list of merchants, but the next value in the response is not null — request the following page of the merchants list, using the next query parameter with the next value from the received response.

If no query parameters are specified, the list with up to 100 first merchants is returned.

You can test this API endpoint and inspect the possible responses using Swagger UI.

Request

URL: https://api.takeads.com/v1/product/monetize-api/v2/merchant

Method: GET

Request headers

Query Parameters

You can use query parameters to get information on specific merchants, or paginate the response.

This endpoint has no required parameters. If no query parameters are specified, the list of the first 500 merchants is returned.

You can get a list of merchants, information about which was last updated during the specified period. To specify the period, use updatedAtFrom parameter. It allows you to limit the list of merchants only to those who were updated after the specified date.

Use offset and limit parameters to paginate the response.

The following table describes query parameters that you can use in the request.

Request examples

• 
  curl --request GET \
  
    --url 'https://api.takeads.com/v1/product/monetize-api/v2/merchant?next=1&updatedAtFrom=2024-01-01&limit=100&isActive=true' \
    --header 'Authorization: Bearer <Public Key>'\
    --header 'Content-Type: application/json'
  
  
  

• fetch("https://api.takeads.com/v1/product/monetize-api/v2/merchant?next=1&updatedAtFrom=2024-01-01&limit=100&isActive=true", {
  
    "method": "GET",
  
    "headers": {
  
      "Authorization": "Bearer <Public Key>",
  
      "Content-Type": "application/json"
  
    }
  
  })
  
  .then(response => {
  
    console.log(response);
  
  })
  
  .catch(err => {
  
    console.error(err);
  
  });
  

• <?php
  
   
  $curl = curl_init();
  
   
  curl_setopt_array($curl, [
  
    CURLOPT_PORT => "6110",
  
    CURLOPT_URL => "https://api.takeads.com/v1/product/monetize-api/v2/merchant?next=1&updatedAtFrom=2024-01-01&limit=100&isActive=true",
  
    CURLOPT_RETURNTRANSFER => true,
  
    CURLOPT_ENCODING => "",
  
    CURLOPT_MAXREDIRS => 10,
  
    CURLOPT_TIMEOUT => 30,
  
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  
    CURLOPT_CUSTOMREQUEST => "GET",
  
    CURLOPT_POSTFIELDS => "",
  
    CURLOPT_HTTPHEADER => [
  
      "Authorization: Bearer <Public Key>",
  
      "Content-Type: application/json"
  
    ],
  
  ]);
  
   
  $response = curl_exec($curl);
  
  $err = curl_error($curl);
  
   
  curl_close($curl);
  
   
  if ($err) {
  
    echo "cURL Error #:" . $err;
  
  } else {
  
    echo $response;
  
  }
  
  

• import http.client
   
  conn = http.client.HTTPSConnection("https://api.takeads.com")
   
  payload = ""
   
  headers = {
  
      'Authorization': "Bearer <Public Key>",
  
      'Content-Type': "application/json"
  
      }
   
  conn.request("GET", "/v1/product/monetize-api/v2/merchant?next=1&updatedAtFrom=2024-01-01&limit=100&isActive=true", payload, headers)
   
  res = conn.getresponse()
  
  data = res.read()
   
  print(data.decode("utf-8"))
   
  
  

Response

If the request was successfully processed by the server, the HTTP response with 200 status code and the list of available merchants is returned.

The response payload is a JSON object that contains a meta object with metadata and a data array with the merchants' details. Each item of the array is an object with the details about the merchants retrieved according to request.

The following table describes the response metadata.

The following table describes the response properties from the data array.

Example value

{
"meta": {
"next": 1234
},
"data": [
{
"merchantId": 12345,
"name": "ACME",
"imageUri": "https://sitesample.com/image.svg",
"defaultDomain": "sitesample.com",
"description": "Some description",
"categoryId": 12,
"domains": [
"sitesample.com"
],
"currencyCode": "EUR",
"isActive": true,
"countryCodes": [
"DE"
],
"averageBasketValue": 120.45,
"averageCommission": 4.45,
"averageConfirmationTime": 39,
"averageCancellationRate": 0.45,
"minimumCommission": 0,
"maximumCommission": 0,
"commissionRates": [
{
"fixedCommission": 1.4,
"percentageCommission": 5.4
}
],
"trackingLink": "https://tatrck.com/h/q1w2e3r4t5y6",
"createdAt": "2023-01-30T08:07:12.166Z",
"updatedAt": "2023-01-30T08:07:12.166Z"
}
]
}

To view possible error responses, refer to the Error responses article.