Skip to main content

Changelog

The changelog summarizes the updates and enhancements made to the Carrot Ads API. The most recent changes are listed first. All changes are non-breaking changes.

May 1, 2025​

  • Added the tracking_param field to the BrandPage object in the Get a brand page response.
  • Updated the Track ad events endpoint to correct some of the required fields:
    • In the FeaturedProductEventProperties object, object_tracking_id is required.
    • In the DisplayBannerEventProperties object, object_tracking_id,record_version, event_id, and interaction_id are required.
    • In the ShoppableDisplayEventData object, interaction_id is required.
    • In the ShoppableVideoEventData object, interaction_id is required.
    • In the ShoppableDisplayItemEventData object, interaction_id is required.
    • In the ShoppableVideoItemEventData object, interaction_id is required.

February 18, 2025​

  • Updated the endpoint documentation:
    • Removed information about user tokens. Retailers must use client tokens only.
    • In the SessionContext object and the EventTrackingContext object, updated the user_id, user_ip, and user_agent fields to be required.
    • In the FeaturedProductEventProperties object, removed the rrc and upc fields, added the product_id field, and clarified the descriptions for the page and record_version fields.
    • In the FilterQuery object, clarified that the catalog inventory file must contain the filters and product tags you want to use with Carrot Ads requests.
  • Added the Filters and catalog identifiers topic.
  • Update other concepts to include image sizes for ads assets.

October 25, 2024​

  • Removed the currency field from the OrderProperties object in the Ingest orders request.

October 16, 2024​

  • Updated the Brand page topic with examples of brand page blocks.

Sept 19, 2024​

  • Corrected the Ads domain in all request examples from connect.instacart.com to connect-ian.instacart.com.

August 1, 2024​

June 7, 2024​

March 18, 2024​

  • Published this documentation site.
Last updated on