Brands

Introduction

A brand is a collection of products marketed and sold under a unified name.

The brands associated with an account define the products that the account can promote on retailer sites.

An account can have access to one or more brands, and this access is typically managed by Criteo.

Brand attributes are standardized across retailers to ensure consistency.

Endpoint

Method	Endpoint	Description
POST	`/brands/search`	Search for Brands by name in Retailer(s) Catalogs,

For other related endpoints, check our stable version in Brands

Brand Attributes

Attribute	Data Type	Description
`id`	string	Brand ID Accepted values: int64 Writeable? N / Nullable? N
`name`	string	Brand name, keyword to use as filter in the search (case-insensitive) or returned as final brand name available Accepted values: string Writeable? N / Nullable? N
`retailerIds`*	list	List of Retailer IDs, to use as filter in the search or returned as containing the specific brand Accepted values: int32 Writeable? N / Nullable? N
`brandType`	enum	Type of brands, to consider in the search or returned as attribute of the specific brand * `all`: all brands * `retailer`: brands specific to the retailer * `uc`: brands referenced to our Universal Catalog Accepted values: `all`, `retailer`, `uc` (case-insensitive) Default: `all` Writeable? N / Nullable? N

* Required

Search for Brands by name

This endpoint searches for Brands, by name term, across one or multiple retailers. Results are paginated.

https://api.criteo.com/preview/retail-media/brands/search?offset=0&limit=25

Sample Request

curl -L -X POST 'https://api.criteo.com/preview/retail-media/brands/search?offset=0&limit=25' \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <MY_ACCESS_TOKEN>' \
    -d '{
            "data": {
                "type": "<string>",
                "attributes": {
                    "retailerIds": [
                        "123",
                        "456"
                    ],
                    "name": "brand abc",
                    "brandType": "all"
                }
            }
        }'

import requests
import json

url = "https://api.criteo.com/preview/retail-media/brands/search?offset=0&limit=25"

payload = json.dumps({
    "data": {
        "type": "<string>",
        "attributes": {
            "retailerIds": [
                "123",
                "456"
            ],
            "name": "brand abc",
            "brandType": "all"
        }
    }
})
headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer <MY_ACCESS_TOKEN>'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();

MediaType mediaType = MediaType.parse("application/json");

RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"type\":\"<string>\",\"attributes\":{\"retailerIds\":[\"123\",\"456\"],\"name\":\"brand abc\",\"brandType\":\"all\"}}}");

Request request = new Request.Builder()
  .url("https://api.criteo.com/preview/retail-media/brands/search?offset=0&limit=25")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Bearer <MY_ACCESS_TOKEN>")
  .build();

Response response = client.newCall(request).execute();

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api.criteo.com/preview/retail-media/brands/search?offset=0&limit=25');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
    'follow_redirects' => TRUE
));
$request->setHeader(array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <MY_ACCESS_TOKEN>'
));
$request->setBody('{"data":{"type":"<string>","attributes":{"retailerIds":["123","456"],"name":"brand abc","brandType":"all"}}}');
try {
    $response = $request->send();
    if ($response->getStatus() == 200) {
        echo $response->getBody();
    }
    else {
        echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
        $response->getReasonPhrase();
    }
}
catch(HTTP_Request2_Exception $e) {
    echo 'Error: ' . $e->getMessage();
}

Sample Response

{
    "metadata": {
        "count": 2,
        "offset": 0,
        "limit": 25
    },
    "data": [
        {
            "id": "2149023412134133",
            "type": "BrandIdSearchResult",
            "attributes": {
                "id": "2149023412134133",
                "name": "brand abcdef",
                "brandType": "Retailer",
                "retailerIds": [
                    123
                ]
            }
        },
        {
            "id": "62342",
            "type": "BrandIdSearchResult",
            "attributes": {
                "id": "62342",
                "name": "Brand ABC",
                "brandType": "UC",
                "retailerIds": [
                    123,
                    456
                ]
            }
        }
    ],
    "warnings": [],
    "errors": []
}

Responses

Response	Error	Message	Description
🟢 `200`			Call completed successfully
🔴 `400`	Validation Error	`One or more validation errors occurred.`	One of the parameters provided in the request does not match the format accepted. Check the error details and the parameters informed in the call
🔴 `403`	Authorization Error	`Resource access forbidden: does not have permissions`	API user does not have the authorization to make requests to the account ID. For an authorization request, follow the authorization request steps