Retailer Search - Criteo Docs

Introduction

A retailer offers a selection of products from multiple brands.

Retailers act as publishers, providing advertising inventory for brands to promote their products. An account can have access to one or more retailers, with this access typically managed by Criteo. A retailer typically allows multiples types of pages to be targeted. A page is an inventory that can be targeted by Campaigns and Line Items with specific configurations.

Endpoints

Retailer Attributes

Retailer Campaign Availability Attributes

Field Definitions

• Writeable (Y/N): Indicates if the field can be modified in requests.
• Nullable (Y/N): Indicates if the field can accept null/empty values.
• Primary Key: A unique, immutable identifier of the entity, generated internally by Criteo. Primary keys are typically ID fields (e.g., retailerId, campaignId, lineItemId) and are usually required in the URL path.

Search for Retailers

This endpoint searches for retailers associated with the respective account and retrieves a set of retail media capabilities, allowing the user to set up campaigns accordingly. Results are paginated using offset and limit query parameters; if omitted, defaults to 0 and 5, respectively. See API Response.

If the limit above is not respected, a dedicated error 400 with Model validation error will return.

Search Attributes

Sample Request

cURL

curl -X POST "https://api.criteo.com/{version}/retail-media/accounts/18446744073709551616/retailers/search?offset=0&limit=5" \
  -H 'Accept: application/json' \ 
  -H "Authorization: Bearer <MY_ACCESS_TOKEN>" \ 
  -H 'Content-Type: application/json' \ 
  -d '{
          "data": {
              "attributes": {
                  "retailerIdFilter": [\ 
                      12345\ 
                  ]
              }
          }
     }'

Sample Response

{
    "metadata": {
        "count": 1,
        "offset": 0,
        "limit": 5
    },
    "data": [
        {
            "id": "299",
            "type": "RetailerResult",
            "attributes": {
                "name": "Retailer 1234",
                "campaignAvailabilities": [
                    {
                        "campaignType": "onsiteDisplay",
                        "buyType": "auction",
                        "isAvailable": true,
                        "budgetModel": "retailerBilled",
                        "validCombinations": [
                            {
                                "pageType": "home",
                                "pageEnvironmentType": "web"
                            },
                            {
                                "pageType": "home",
                                "pageEnvironmentType": "ios"
                            },
                            {
                                "pageType": "search",
                                "pageEnvironmentType": "web"
                            },
                            {
                                "pageType": "category",
                                "pageEnvironmentType": "web"
                            },
                            {
                                "pageType": "productDetail",
                                "pageEnvironmentType": "web"
                            }
                        ]
                    }
                ]
            }
        }
    ],
    "warnings": [],
    "errors": []
}

Responses