HomeGuidesChangelog
Log In
Guides

API responses

Suggest Edits

Response format

  • JSON format: The API response is in JSON format.
  • Response content: The response will contain:
    • placements: Information about where ads should be placed.
    • list of products: A list of products to be shown.
    • beacon URLs: URLs for tracking events, detailed in Beacon URLs.
  • Display formats: For display formats, the response may include extra information such as rendering details and links to image or video files. Refer to Ad Formats for examples for each format.
  • API response structure: For a detailed description of the API response structure with examples, visit API Response Examples.

Breaking down the API response

Let's take a closer look at the structure of the API response, breaking it down into its components:

{
  "status": "OK",
  "placements": [
    {
      "viewHome_API_desktop-InGrid": [
        {
          "format": "sponsored_products",
          "products": [
            {
              "ProductId": "14567",
              "ParentSKU": "14567P",
              "OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=wIGSZXHwMFfCseG77HQd7SOaa5ItlchfEV7FsVRFvOvgCGeZNp4PqqdyMqxupiThhgJKvudYpqpi2qQjLshpQLDUSU91x_Cjx5XcX8nh40S5kaxVRk3hme-iiwO9yA8xoZpGo_6NMh4Hik96Dp6KGLSB7V1peSCN34LwnicW-3lpd6HrCirUltMP6KDMNCASCJAC2QCCoygwvbX34niecaFID9gsFPkj3gV4dZRDGjZM9GtQbWp7U-E-k4aKjRZy4prcGaQZCUcSY_e1F9yjchB_zrZMeGiNbBiA2eJ-UonqowH6CYjLdqBlO7aHpC9igyDOTh4eb1G1PX_8tBeKJFKi5JRXEALqnXns4_OD9XRqPwJY0mHLkgDDVCopXr9ecWAC_X0UyBy_GfJd79U2hVl6WZKdmXgIhNjeh3eanlk&ev=4",
              "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=bay40713qtFIdj5P3YUhlfmJUf3bROAa3nby5U-aG8oJFEZO97wjWJ636jKfXNwwvPJxrgYvdcz3zEz2evMvaHNA0H4JriwRyTbqtFHXX1LtPCIQBibPujZpj-3s_yU9kP8SK0Th-KP9_nGXZI2b7QljQaSx8O0-xDdchB59AIBWKq3QSWcnF9Vewy-QfXUDio8q-3w1xgNHXWvPk_uhZGkaY9VTVMQINJBCT8bvxW0GMaYu0vAoIlaac1dKEC580Jzfw35iE3-LtX7w5CLlRaThsZxpWkDcmF0gxACGQg9lQCmGYevs5ePQ79dqB3ZuMIpWjXVTSwJTTvDc81hgnui1GoCN-8IjAt3zKKE3YZp7hDyxgV277J2IjQwWOhE8sBnl6B-ctSmPnp3HEzFFnqPiG5-9Iu-jy3Z9aeE5UF8kRAG1OBmfoH79xUPytz_n&ev=4",
              "OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=HvNOO3VNgpKc4t6hdzi5OAX7aDUv4sYuvdcTL5pUPE-XcJvJKB9WA6U8cq-1VS2XYZo86Pcxj3SErB8R0eIwlLCYDIF2CZziNqca05mYyzZS9x4fRJRQgsOP0kbde6nLQ0S6z0Ea5tiL_4IlFcZ5hB6MNE1QCvmQdYS03i8Gku5Z74pxdw02QTywvhNvHZx8kJM4bwxL_KodVHjUQPXdwVzqdmUL2zeR4psWq3sLxym3Ep0ggsC89yD0yaVfZq4TDe1E59aDSszAWF3D7DgLlNJn2lhSSbhKpAJ_CnRWuW85vdtlyKzkAjf4Uqifp5CeGv9ea7B07SmGrR5d_-U7s9nOgphrLbTr91MvhCWSp0kuDEr8x9g3J6LmGzuLcM8Kbhx0LqaQkFDue1O1X-7LY9ducQKiaL7OLmkdIKX9urZBZeqSVyeqyqrs6D8PgcnObN80v6Lyo9xxsBsB5IMFig&ev=4",
              "OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=wa79g8gomUj1xr_Krt1d4PNDKNe7Z9UMNndzrp1fMOR0zM_mowG2NiTkL6RtRYtcTaTULrRn9Uooy5rgED3l6Pf3X8gQTx2-YkPD3H0j8yvzbR4xg7SUTjSiEf_rebYfDCAHm39wt_WI6Q2yzJ8BxKdeCJBLXqA7nC4j4EqQZMbZbJ8RFSapMc0WrzQQwoPHZOCWN0KBvGTw3xC-cKjFE_7hdThHUlfIpGnuBjoGZxyQEbVjrcKKpIGkgO8gSrY-oR0KF5kvr2KroG1RFjthJtrJmRwL6cSlCk9E0HZb7wB-kjEHkXmHGtshpIOs2TIar4qbO49tGbCvxMezm7aSYEChwxAn1nHzqyDvzQUNvesnD6yymkV8wiqzj_X55uJD5dgB2otncgc-tqClKWjDUTi3g5uWPskEuZsRkcGU8sN3oMsdDhBmYf-rt6nVWUiAGLvlaumN-vcikE-KGurgHg&ev=4",
              "OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=yqlwecnAoAcbFsxAXvx18BXQIwjUPEXgk98r3SFucMNY_RgF8izSxEJ34yjJV8EmU6j6IdXvV97At15ctkGsZ2UyUb_B4nBd9V5TTSMLYsleiVAUDa7xZmv4gnpjRBD9AZWaICw0AVOd_uBMVNN_jqenDBVcqeQw6nYARfP3T_C1jt-MkEPjKJx2PXDsWjfUFsMu0DSVoHxp17KMH4BsOOXObYVDTRrle3VogbXiQDaQ84M5Xk0QQC05z2Wp58ntk5Y44eXn7WBlLKor9QbCxSe-ESzzOP2tK5UOCkowZXI2vd2uLdTTuoBMMSkuiYlVjeLqZ7-LxO2hyT6QHJ3kQhhunCPi5t1oVmxASV1UHD94TOCUso4CbPjlT7-TDomzIgnOkXQgvjNxrV4OiSqCEZxltZlM-KUHzlfUAW6ucNNSqmdaaP9dFHNT9Pcziicui79ymAtYSzidQcE3y10xew&ev=4"
            }
          ],
          "rendering": "",
          "OnLoadBeacon": "//b.us5.us.criteo.com/rm?fid=1205&hl_qs_cmp=5uA4RAAyB4_gprioo3H-TBRN1xWe0MfgzXEjDuXPJRxh43LMFIqbvqmUpWL-X1QaLZsBnjLZmQOO8VDv8AygNKeBIrAOdc3BAt58fPXXmvpZ1X6RIwlB9ABNmCB43n9uUhqdEWeaVl03KA3L6Erk36jfiK4dJH6JwLEeIj5rUmr77DYYcqwDazIQ_-rVIABST9nVzoqvJ4spgBJ1sx0H6r_IrbD2m2GquySbzP5gA1TaSn1ZshWlpVU_N0-VwQYGIVVDlORAMWV-WUV0IBWDciC92ygwabmVl2VQrZirzdEAXDR3Y8mgd8DDtwmEbSdgf0AhF65RIhr06ZfgFMSQtXGJPLhoXibnWaj9UKxnUuCLQtjxeMBaT4Wj_qSTy13Cnzy5b7hU36GPd0nt4O44L2sC4BcoyUlZGwoM-iSCDQekIsiWyQINJERV-mzvx9lnCzThW6g85leDyWRy-ypa19Qykz_jP8lWFgB_QLit5jrW7jNDUZGN3QJwFIsBlur7VQueQ4D4CY_b9WNm4tNT9poaGyfas7X9bALmCGStKFSEcGfyEQsuivryHobe7zhNHYSSew_erOiS_gjRffOUHw&ev=4&criteopartnerid=108341&action=page&origc=A&pid=a0396133-15e5-4d8d-a0d7-7e636a0c9629&rn=96592&rm_e=0sSztFiVbHNTsuwnq1PB8pqDUAnR6K4NdhFvWiYIq46QV070UizTxdway_uMmQbJGIHCAk0ZsvRTcBKEPcv6hGrkQC0PfFdL7rRy-ESWSHrMsZn7-9KuKYThNMCgkbDzP1pKiEBh_MrkPbvTaPZBKm9KqW3zIzVDp4v8DgIiAe0-5fhKlVsNPATbNaBedHtDfZhzNyCRnVisUpFQUifH9NRcIAxn7xfaFM7ZzvDheiI2S3Eq4cfBzRDRAXU_aCA0DLOq9pRvyLuzT-QFDpmI3A",
          "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=nZujoEOA40DwXsc-kV2o_ygnxWqQwguOzRYIKHC7LJ4Nj1jBk8k5rgTQ3b8GtfylnH6eB7y4ggvPyWft8SlXxwWH08y4GhwC-1rsq0fWbLx9F_LjVF3gdtaa_UQ5PvpjyWCLyPL5kJaj9Mbud8aXX9_7HgVjBlO6lAvEkiElMoTUzfUhRLzlBdSxYePuAOBilAFMtJ3abkHgmowMLKaK1a4tVBoK0YHexHMZ0zONVqOXjwYqx19-hgRcUyFQ6uCulio9LRmFSlflBkEWiNRQ-AHOB2vVwkkE5xOgKcEN8XWRLz1b-hYfn5ECK1Gff0D9JM6eLD1EOOSNB0jt8LPxPSG5u48q4CLAIK59MYDJXIkEJ3nS9b_OYpJ8GoDFfuB5&ev=4",
          "OnClickBeacon": ""
        }
      ]
    }
  ]
  "page-uid": "7f0b8394-f87f-438f-bf4a-b2aeae1e3144"
}

Response Components

  1. status

    • Type: string
    • Values: OK (for successful responses) or an error type.
    • Example: "status": "OK"

  2. placements

    • Type: array
    • Description: An array of placement objects, each representing a specific ad placement on the page.

  3. page-uid

    • Type: string
    • Description: A GUID value identifier for each ad request.
    • Example: "page-uid": "7f0b8394-f87f-438f-bf4a-b2aeae1e3144"

Placement Object

Each placement object contains the placement Name as the single key for the object, e.g., viewCategory_API_desktop-inGrid.

Inside each placement, we have:

  • Format
    • Type: string
    • Description: The type of ad, e.g., sponsored_products.
  • Products
    • Type: array
    • Description: An array of product objects.
  • Rendering
    • Type: string
    • Description: rendering details used for commerce display ads.
  • OnLoadBeacon
    • Type: string
    • Description: URL to be called when the whole placement is loaded.
    • Example: "OnLoadBeacon": "//b.us5.us.criteo.com/rm?fid=1205&hl_qs_cmp=&ev=4&criteopartnerid=108341&action=page&origc=A&pid=a0396133-15e5-4d8d-a0d7-7e636a0c9629&rn=96592&rm_e=abc123def4"
  • OnViewBeacon
    • Type: string
    • Description: URL to be called when the placement is viewed according to IAB guidelines.
    • Example: "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=abc123def4&ev=4"
  • OnClickBeacon
    • Type: string
    • Description: URL to be called when the placement is clicked. This is only used on commerce display ads, and it is typically triggered on clicks on the ad's image as opposed to the product inside the ad.
    • Example: "OnClickBeacon": ""

Product Object

Each product object contains:

  • ProductId

    • Type: string
    • Example: "ProductId": "14567"

  • ParentSKU

    • Type: string
    • Example: "ParentSKU": "14567P"

  • Beacons

    • OnLoadBeacon

      • Type: string
      • Description: URL to be called when the product is loaded.
      • Example: "OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=abc123def4&ev=4"

    • OnViewBeacon

      • Type: string
      • Description: URL to be called when the product is viewed according to IAB guidelines.
      • Example: "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=abc123def4&ev=4"

    • OnClickBeacon

      • Type: string
      • Description: URL to be called when the product is clicked.
      • Example: "OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=abc123def4&ev=4"

  • OnBasketChangeBeacon

    • Type: string
    • Description: URL to be called when the product is added to the basket.
    • Example: "OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=abc123def4&ev=4"

  • OnWishlistBeacon

    • Type: string
    • Description: URL to be called when the product is added to the wishlist.
    • Example: "OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=abc123def4&ev=4"

Product array verbosity levels

Criteo supports two verbosity levels:

  • Minimum verbosity

    • Contains: ProductId, ParentSKU, beacons (OnLoadBeacon, OnViewBeacon, OnClickBeacon, OnBasketChangeBeacon, OnWishlistBeacon).

  • Full verbosity

    • Contains: All information from minimum verbosity plus additional details necessary to render the ad. All details are reflected from the product feed parameters.

Here is an example of a product object in full verbosity:

 {
   "ProductName": "Product 16823",
   "ProductId": "16823",
   "ProductPage": "//b.us5.us.criteo.com/rm?dest=https%3a%2f%2ftilt-dummy-retailer.preprod.crto.in%2fpdp%2f%3fid%3d16823&sig=1-OxTyYEct2uXeVQw334Q7rhli3hjJSfL-t1eGN0YS-2A&rm_e=uel8HURJNMmUz12YtgzGAeSR-psXmQFLCnVtykXin5b5LlMOlwR9k1w4PnZ93nTwLSLRM8h_OVK_nPLkK84uY4wBFzIx8x9AxzThTINQ0fpTsiJt_tTMuHfyLNG47gWwg5f6dDZons5DMKmZEjVsNAGmsiLF7YpZb8lFAmqaKyx8B9qIZJatI7ApL7VCCO1NAv6bvz6EQ1tvPDcZc6kY7cw5uLT5egrtd3Nupj5vJ6R_PQy-jmS5rEcmViA_Yf5AcP-teeD_wY3x59nlISoZP-sLqIksWuUr0QRfF8Z6DnR3ZQzunCi5PONmLtM1zSgOCHFj4fyf-A3GbbLe1kJdNyQtS7PZAsR04DDYAg5QEMzJoGcZGS7VVH_h5bLnF4dArQuIUamTFePufu7tmYxQvA&ev=4",
   "Image": "https://static.criteo.net/images/dummyretailer/glob_prod_img.png",
   "Rating": "-1",
   "Price": "69.00",
   "ComparePrice": "69.00",
   "Shipping": "0",
   "ParentSKU": "16823",
   "ClientAdvertiserId": "1205",
   "AdvertiserId": "17902833",
   "RenderingAttributes": "{\"brand\":\"retailer brand 1\",\"issellersku\":\"0\",\"mapViolation\":\"0\",\"numberOfReviews\":\"0\",\"promolabel\":\"Promo Badage blackFriday\",\"rating\":\"2\",\"shippingCost\":\"0\",\"taxonomy_text\":\"fresh foods>fruits>bananas\"}",
   "OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=qfD_DnfhuYEwJlj-_k6q9vq3rdUT2fgm1U5Srs1XDjS_39fWoZiJx37WMTlWfHNA-8GlrIi71W1MM4_cU_3kzxoNYzoPKWR0mFaKYJE-p5owUCOIv4-MBbjlAWCV2SlSN3xE3C7MMhZQ8IX6w1OrYPBowzevmAB0Wx3NvcvhrIILIeDQllspyDbSWlOkR-yCQ4wML_zpcAGS5AK2g-UhJrHp_eSfNK6FE92cd2W7tXnAvOr0S_TJES6-osdVfqAcaGyWFlZ7R9Wj5YJQEQizkbg8KQBBTVpaqyI0VjuQJWGtKve9i525uiAW5DVQqIqnh-M6e7zwbP_A3A8IW3rDBE1mkNoYG6bC3em7viLzrTqMKvxBItREk7tkBvj835iu-7fXjayMkHvGXxwbHLdbwQ&ev=4",
   "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=09rCkvAHsrPsZb5M3XQAkVv3Eyk5EZgzcBZuD-SQRT12HynrMYmKnN4bcb5cN2xyWxO8SWnn8HiTEyO5m4xtCorqbG137zd8yPbvztI6ZbUwmwoU2injhkF4LDwMMFMSD8Y93F3dU6wwQlSdeaoeorNat4ka1mnNFLfNgHhREArA5cinPg-MExTIFeJ9BDUg6eKUH6dklezn_j-l-46554KUvaGVLWMoryzy-3tuXDDRFNA-JuUUMzwr-P3EvFw3WECVLDd5YqiQQIV3I3_IQhzSbk0g3L7bJP_rOBQv204U_3X_HYsoMyartqLJMSZ4zP4h_7zZB7fpPODoxVS_vGFNvYN71XeIIMxy0jFJDjvstu2CLo-K4aRVXLKaRR0iCm-ET61GpLPhsOsG_zrAhA&ev=4",
   "OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=MZkmRRi7n5KyhcMFLsf13Qbhf0EwjnF4fERMLUS7N12_OCRXcfTXb2oQJxgIbW0UaFzHpiGR-hZ6w7yXToa9F9KnvlQ1RUhpVsVTHx0WgbtM3RVkw-XRheFJQWPqZZlLTpu0wFd_4L75iVhpzLpuCD9ZJKOJ2bawqjexZd2GmejGMtUtOUmZqxPD-SlXNAJ5lHAOi3hQ4Y4i6aDSFjA03pNXw-f9G4Pg9IQqNMzeN7rC4_gU0gTrpwmq3GvVSlp-6CtZEgZ5zGSbiRULe0hJyGcXXtlVb-y2VoDhTRa6tCb5_4XK3H7vZGYhFYBdMIort7ocWJNfL6SxKXrsGVMAfd4uakLn5M7luXowhnKKfGIzDPIw1K1FKp6XmWxd19QBMPFWLFzBladVoAgDmysFJg&ev=4",
   "OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=iOGO2y360EsftIgtVtiVHh-SDsf3eE54JVltobiLr4M-sHkWrkErFbvMzvfe41lA2thRTR2kWl0mI4boIKb5sV27rUgDUNsKbhhEaDSVlVVRgayPm7M2jqiYW8fP1f7vTDKLqVCamHeHVkqCVoqGdZoQs_9IsoKLeNbjDS0EE-kl3UK8V1i6hD3zvTQJq9_jACnUttSmO6HN2M_i149DacstUZlOt7_U1JJ7W45b88PFQtYJAqkIX8Sq2t6k9qCaYNlPA1Jg3IIMLq5iRs8IaJw9Mk5dGz6mQAo9fiPPKLIQvZF0OJdIQAEiJ-RA4M-6OYRiMiRv8LvzqQPQlrrKyuAyF3ymPOuX_19vkLmWjpcthAmHGV4lbyjTJ0isZMhSP3v5yyBZ0A_zBTvXmJgevA&ev=4",
   "OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=HbZtVCkIeMSvyPh6LXzeA9Cm-e1MGxY13Oi40WSQp5B3Qy_w7EmqQO9garQ0gLHdKN99Zr-pfHZXR6TwlupMYeJ5ALP6UoT2hElxZP5dbXPmZqxiyWbap2IP-18rzkSLAeBnF1vey4jsFTqFGj50A2nDUpEmt9XvYgKBdwUrPvzchXZAMW1aLSz9uz6oycliNYR7Ca866dNd8vA9VzFiU-UNHXgWhRyjyhgiwUeVom4GrzzI95e6R--PzF5PURGaJ3CDWKcVQTKrN8_lx4G3DBTSq0WQEiAKhP4b_Z1-QDrFjbWEwaAOzPh3V5OXQLOzF1zkJ21w_LEmjLaywfoDviS0YaPUoHJsOwp0JX489avZEhy11cW5YuhS3D09AudNqmarl2G3Mg6gYpiOqpDqow&ev=4"
 }

The default verbosity level can be set up by your technical account manager, but it can be changed at anytime using the verbosity parameter in the API calls with values min or full. See the API parameters page for more details.

Beacon endpoints

The beacon endpoint will point to different datacenters determined by an automatic load balancer. This will typically be reflected on its subdomain.

  • Format: b.[datacenter].[region].criteo.com/rm
  • Examples:
    • Europe: b.fr3.eu.criteo.com/rm?rm_e=[unique-token]&ev=4
    • Americas: b.us5.us.criteo.com/rm?rm_e=[unique-token]&ev=4

API error responses

If an API call is malformed or unable to send a valid response, the API will return a 200 HTTP status with an error message. For requests with incorrect or missing parameters, the response will include 'status': 'Error' with an array of 'errors'.

Example error response

{
  "status": "Error",
  "placements": [],
  "errors": [
    "Missing required param page-id",
    "Missing required param event-type",
    "Missing required param criteo-partner-id",
    "Could not convert parameter criteo-partner-id to an integer",
    "Could not determine a valid event type from the event-type parameter"
  ],
  "page-uid": null
}

The following list, while not exhaustive, covers most error messages you may encounter. Tracking these is recommended to identify potential implementation errors.

Possible error messages

Expected one or many numerical values greater than [or equal to] 0

Sample call:

curl -X GET "https://d.us.criteo.com/delivery/retailmedia" \
--data-urlencode "criteo-partner-id=123" \
--data-urlencode "event-type=trackTransaction" \
--data-urlencode "retailer-visitor-id=123" \
--data-urlencode "customer-id=456" \
--data-urlencode "page-id=trackTransaction" \
--data-urlencode "item=abc|def|ghi" \
--data-urlencode "price=249.99|200|400" \
--data-urlencode "quantity=a|b|c" \
--data-urlencode "transaction-id=123458abc" \
--data-urlencode "nolog=1" \
-H "Referer: www.criteo.com" \
-H "X-Forwarded-For: 123.456.789.012" \
-H "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"

Error: The parameter quantity has non-numeric values.

Sample response:

{
  "status": "Error",
  "placements": [],
  "errors": [
    "quantity: Expected one or many integer values greater than 0"
  ],
  "page-uid": null
}

Expected array parameters to contain the same number of items

Sample call:

curl -X GET "https://d.us.criteo.com/delivery/retailmedia" \
--data-urlencode "criteo-partner-id=123" \
--data-urlencode "event-type=trackTransaction" \
--data-urlencode "retailer-visitor-id=123" \
--data-urlencode "customer-id=456" \
--data-urlencode "page-id=trackTransaction_API_mobile" \
--data-urlencode "item=abc|def|ghi" \
--data-urlencode "price=249.99|200|400" \
--data-urlencode "quantity=3|1" \
--data-urlencode "transaction-id=123458abc" \
--data-urlencode "nolog=1" \
-H "Referer: www.criteo.com" \
-H "X-Forwarded-For: 123.456.789.012" \
-H "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"

Error: The number of elements in item and quantity do not match.

Sample response:

{
  "status": "Error",
  "placements": [],
  "errors": [
    "Expected array parameters to contain the same number of items"
  ],
  "page-uid": null
}

Required parameter [parameter name] was not of the expected format: [error]

Sample call:

curl -X GET "https://d.us.criteo.com/delivery/retailmedia" \
--data-urlencode "criteo-partner-id=123" \
--data-urlencode "event-type=viewItem" \
--data-urlencode "retailer-visitor-id=123" \
--data-urlencode "customer-id=456" \
--data-urlencode "page-id=viewItem_API_mobile" \
--data-urlencode "item=abc" \
--data-urlencode "price=299,00" \
--data-urlencode "availability=1" \
--data-urlencode "nolog=1" \
-H "Referer: www.criteo.com" \
-H "X-Forwarded-For: 123.456.789.012" \
-H "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"

Error: price incorrectly formatted with a comma as a decimal separator.

Sample response:

{
  "status": "Error",
  "placements": [],
  "errors": [
    "Required param price was not of the expected format: Expected one or many numerical values greater than 0"
  ],
  "page-uid": null
}

Could not convert parameter criteo-partner-id to an integer

Sample call:

curl -X GET "https://d.us.criteo.com/delivery/retailmedia" \
--data-urlencode "criteo-partner-id=abc" \
--data-urlencode "event-type=viewItem" \
--data-urlencode "retailer-visitor-id=123" \
--data-urlencode "customer-id=456" \
--data-urlencode "page-id=viewItem_API_mobile" \
--data-urlencode "item=abc" \
--data-urlencode "price=299.00" \
--data-urlencode "availability=1" \
--data-urlencode "nolog=1" \
-H "Referer: www.criteo.com" \
-H "X-Forwarded-For: 123.456.789.012" \
-H "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"

Error: The parameter criteo-partner-id is always an integer.

Sample response:

{
  "status": "Error",
  "placements": [],
  "errors": [
    "Could not convert parameter criteo-partner-id to an integer"
  ],
  "page-uid": null
}

Could not determine a valid event type from the event-type parameter

Sample call:

curl -X GET "https://d.us.criteo.com/delivery/retailmedia" \
--data-urlencode "criteo-partner-id=123" \
--data-urlencode "page-id=viewItem_API_mobile" \
--data-urlencode "event-type=viewItem" \
--data-urlencode "retailer-visitor-id=123" \
--data-urlencode "customer-id=456" \
--data-urlencode "item=abc" \
--data-urlencode "price=299.00" \
--data-urlencode "availability=1" \
--data-urlencode "nolog=1" \
-H "Referer: www.criteo.com" \
-H "X-Forwarded-For: 123.456.789.012" \
-H "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"

Error: The parameters event-type and page-id are switched.

Sample response:

{
  "status": "Error",
  "placements": [],
  "errors": [
    "Could not determine a valid event type from the event-type parameter"
  ],
  "page-uid": null
}

Missing required parameter [parameter]

Sample call:

curl -X GET "https://d.us.criteo.com/delivery/retailmedia" \
--data-urlencode "criteo-partner-id=123" \
--data-urlencode "event-type=viewItem" \
--data-urlencode "page-id=viewItem_API_mobile" \
--data-urlencode "retailer-visitor-id=123" \
--data-urlencode "customer-id=456" \
--data-urlencode "item=abc" \
--data-urlencode "price=299.00" \
--data-urlencode "nolog=1" \
-H "Referer: www.criteo.com" \
-H "X-Forwarded-For: 123.456.789.012" \
-H "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"

Error: One or many required parameters for this event-type are missing.

Sample response:

{
  "status": "Error",
  "placements": [],
  "errors": [
    "Missing required param availability"
  ],
  "page-uid": null
}

Updated 2 months ago

What’s Next