What's New in 2024-01
This page lists all endpoint changes related to the v2024.01 release
Version Schedule
Version 2024.01 of the Criteo retail media API is live as of January 23rd, 2024. This version will be supported until July 31st, 2024.
Following this new version release, version 2023.01 will lose support starting January 30th, 2024
This version introduces new capabilities to Criteo Retail Media API and changes to existing endpoints. This page aims at listing all changes that happened endpoint per endpoint. Only endpoints with changes are listed here.
New Base URL
With the introduction of this new version, the base URL will now change from the
Old base URL
https://api.criteo.com/2023-10/retail-media/{endpoint}
to
New base URL
https://api.criteo.com/2024-01/retail-media/{endpoint}
What's New
In version 2024.01, we've introduced two new sets of endpoints. One that allows you to retrieve and edit campaign budget overrides. The other allows you to create and download a revenue report to understand where your retail media revenue is coming from, providing visibility across all advertisers, media, and direct/indirect sales channels. Note, the revenue report is only available for supply account owners (retailers).
Updated Endpoints Includes
Budget Overrides
Verb | Endpoint | Description |
---|---|---|
GET | campaigns/{campaignId}/campaign-budget-overrides | Retrieves all existing budget overrides at the campaign level. |
PUT | campaigns/{campaignId}/campaign-budget-overrides | Replaces all existing campaign budget override settings. Use this endpoint to add/remove or update existing budget overrides. |
GET | line-items/{lineItemId}/line-item-budget-overrides | Retrieves all existing budget overrides at the line-item level. |
SSP Revenue Report
Verb | Endpoint | Description |
---|---|---|
POST | /retail-media/reports/revenue | Generate a retailer revenue report |
GET | /reports/{reportId}/output | Download Output of a Specific Report |
GET | /reports/{reportId}/status | Get Status of a Specific Report |
Updated 10 months ago