Get coupons

The Take API returns a list of all coupons, applying filters, if any.

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

Request

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

Method: GET

Request headers

Query Parameters

You can use query parameters to get information on specific coupons.

This endpoint has no required parameters. If no query parameters are specified, you will receive the first page with 100 coupons in our data feed (100 is the default setting).

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

Request examples

• curl --location 'https://api.takeads.com/v1/product/monetize-api/v1/coupon/' \
  --header 'Authorization: Bearer <Public Key>'

• const myHeaders = new Headers();
  myHeaders.append("Authorization", "Bearer <Public Key>");
  
  const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
  };
  
  fetch("https://api.takeads.com/v1/product/monetize-api/v1/coupon/", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

• $curl = curl_init();
  
  curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.takeads.com/v1/product/monetize-api/v1/coupon/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
  'Authorization: Bearer <Public Key>'
  ),
  ));
  
  $response = curl_exec($curl);
  
  curl_close($curl);
  echo $response;

• import http.client
  
  conn = http.client.HTTPSConnection("api.takeads.com")
  payload = ''
  headers = {
  'Authorization': 'Bearer <Public Key>'
  }
  conn.request("GET", "/v1/product/monetize-api/v1/coupon/", 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 a status code of 200 and a list of available coupons is returned.

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

The following table describes the response metadata.

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

Example value

{
  "meta": {
    "next": "V1StGXR8_Z5jdHi6B-myT"
  },
  "data": [
    {
      "couponId": "V1StGXR8_Z5jdHi6B-myT",
      "isActive": true,
      "trackingLink": "https://tatrck.com/h/0Hu30w1D0KX9?url=https://aliexpress.com/item/1005003993360501.html&s=subid",
      "name": "ACME",
      "code": "10OFF",
      "merchantId": 12345,
      "imageUri": "https://sitesample.com/image.svg",
      "languageCodes": [
        "en",
        "de"
      ],
      "startDate": "2023-01-30T08:07:12.166Z",
      "endDate": "2023-01-30T08:07:12.166Z",
      "description": "string",
      "countryCodes": [
        "US",
        "DE",
        "FR"
      ],
      "categoryIds": [
        12
      ],
      "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.