> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/integration/data-api/catalog-products-2/syncing-products-via-api.md). # Syncing products via API ## Standard product sync Once your catalog is created, you are able to sync products to it. The example below outlines a standard context to sync products: ```http POST $BASE_URL/v1/catalog-products?teamId= HTTP/1.1 accept: application/json content-type: application/json Authorization: Basic { "catalogProducts": [ { "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b", "gtin": "23556578965543", "inventory": 50, "price": "19.99", "tags": [ "imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL" ], "filters": [ "category:Health&Beauty","category:Grocery","brand:Covergirl","Special_Flag:0" ] } ] } ``` If successful, the following object will be returned: ```json { "catalogProducts": [ { "teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450", "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b", "gtin": "23556578965543", "inventory": 50, "price": 19.99, "tags": [ "imageurl:https://your.image.host.com/image.jpg", "name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL" ], "filters": [ "category:Health&Beauty", "category:Grocery", "brand:Covergirl", "Special_Flag:0" ], "groups": [], "profit": null } ] } ``` In this context, empty or null values for groups and profit can be ignored. ## Syncing location information You are also able to synchronise filters for various locations your products are in store. This is useful for store/location level optimisation of your product information. ```http POST $BASE_URL/v1/catalog-products?teamId= HTTP/1.1 accept: application/json content-type: application/json Authorization: Basic { "catalogProducts": [ { "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b", "gtin": "23556578965543", "inventory": 50, "price": "19.99", "tags": [ "imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL" ], "filters": [ "category:Health&Beauty","category:Grocery","brand:Covergirl","Special_Flag:0","location:123","location:ABC" ] } ] } ``` If successful, the following object will be returned: ```json { "catalogProducts": [ { "teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450", "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b", "gtin": "23556578965543", "inventory": 50, "price": 19.99, "tags": [ "imageurl:https://your.image.host.com/image.jpg", "name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL" ], "filters": [ "category:Health&Beauty", "category:Grocery", "brand:Covergirl", "Special_Flag:0", "location:123", "location:ABC" ], "groups": [], "profit": null } ] } ``` ## Syncing HFSS information In your product sync, you will need to send a filter of `hfss:true` or `hfss:false`. This enables Epsilon Retail Media to filter our interface appropriately. ```json POST $BASE_URL/v1/catalog-products?teamId= HTTP/1.1 accept: application/json content-type: application/json Authorization: Basic { "catalogProducts": [ { "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b", "gtin": "23556578965543", "inventory": 50, "price": "19.99", "tags": [ "imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL" ], "filters": [ "hfss:true","category:Health&Beauty","category:Grocery","brand:Covergirl","Special_Flag:0","location:123","location:ABC" ] } ] } ``` {% hint style="info" %} Need to learn more about HFSS? Review the UK Government's publication here: {% endhint %} ## Syncing multiple products If you are syncing multiple products, you can sequence up to 100 per request. An example context for syncing two products is outlined below: ```http POST $BASE_URL/v1/catalog-products?teamId= HTTP/1.1 accept: application/json content-type: application/json Authorization: Basic { "catalogProducts": [ { "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b", "gtin": "23556578965543", "inventory": 50, "price": "19.99", "tags": [ "imageurl:https://your.image.host.com/image.jpg", "name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL" ], "filters": [ "category:Health&Beauty", "category:Grocery", "brand:Covergirl", "Special_Flag:0" ], "profit": "1.50" }, { "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b", "gtin": "23556578965738", "inventory": 26, "price": "8.50", "tags": [ "imageurl:https://your.image.host.com/image.jpg", "name:Kelloggs Froot Loops Breakfast Cereal 500g" ], "filters": [ "brand:Kelloggs", "category:Pantry", "category:BreakfastFoods", "category:Cereals", "Special_Flag:0" ], "profit": "0.50" } ] } ``` If successful, the following object will be returned: ```json { "catalogProducts": [ { "gtin": "23556578965543", "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b", "price": 19.99, "teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450", "groups": [], "tags": [ "imageurl:https://your.image.host.com/image.jpg", "name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL" ], "filters": [ "category:Health&Beauty", "category:Grocery", "brand:Covergirl", "Special_Flag:0" ], "inventory": 50, "profit": 1.50, "tags": [ "Natural", "Lasting", "Dry Skin", "Beige" ] }, { "gtin": "23556578965736688", "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b", "price": 8.50, "teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450", "groups": [], "tags": [ "imageurl:https://your.image.host.com/image.jpg", "name:Kelloggs Froot Loops Breakfast Cereal 500g" ], "filters": [ "brand:Kelloggs", "category:Pantry", "category:BreakfastFoods", "category:Cereals", "Special_Flag:0" ], "inventory": 26, "profit": 0.50, "tags": [ "Pantry", "BreakfastFoods", "Cereals", "Kelloggs" ] } ] } ``` ## Updating product inventory To update a product's inventory, you will need to re-sync the product with Epsilon Retail Media. In your sync, flag the product's inventory to `0`. An example is outlined below: ```http POST $BASE_URL/v1/catalog-products?teamId= HTTP/1.1 accept: application/json content-type: application/json Authorization: Basic { "catalogProducts": [ { "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b", "gtin": "23556578965543", "inventory": 0, "price": "19.99", "tags": [ "imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL" ], "filters": [ "category:Health&Beauty","category:Grocery","brand:Covergirl","Special_Flag:0" ] } ] } ```
## Updating product images Epsilon caches image URLs to ensure consistent performance and reduce requests to your image server. If you update an image without changing its URL, you must explicitly trigger a refresh in Epsilon. To do this: * Remove the existing image\_url from the product. * Re-send the same image\_url once the update is complete. Alternatively, if your image server supports it, you can force a refresh by appending a query string (for example, a version or timestamp) to the existing URL. This will cause Epsilon to reload the image.. {% hint style="info" %} Images are only used in the UI Product images are not served in ad responses. Any image updates only affect how the product appears in the Epsilon UI while the cache refresh occurs. {% endhint %} ## Retrieving products Once you have a product in your catalog, you may wish to retrieve the current information it at a later time. To do this, you can make a **GET** http request with the url form of **`v1/catalog-products/catalogId/`**. The endpoint is capable of accepting one product code per request. A placeholder request is outlined below: ```http GET $BASE_URL/v1/catalog-products// HTTP/1.1 accept: application/json content-type: application/json Authorization: Basic ``` You should receive the current information ingested in the Epsilon Retail Media system for the product code. An example is below {% hint style="info" %} Pushing a product update is not instant in the Epsilon Retail Media system, it can take a short amount of time for Epsilon Retail Media to fully ingest a product update. Do not be concerned if a product's information is not instantly updated when retrieving details. {% endhint %} ## Deleting products To remove a product from your catalog, send a DELETE HTTP request using the following format when the product is no longer needed. ### Request parameters The endpoint accepts one product code per request, typically your GTIN ID. ```http DELETE $BASE_URL/v1/catalog-products// HTTP/1.1 accept: application/json content-type: application/json Authorization: Basic ``` ### Deleting products with seller ID If the product includes a seller ID, specify it as a query parameter when deleting the product: ```http DELETE $BASE_URL/v1/catalog-products//?sellerId=abc123> HTTP/1.1 accept: application/json content-type: application/json Authorization: Basic ``` ### Processing time Product deletion may take between 30 minutes to one hour to process. {% hint style="info" %} Important If a product is out of stock, set its inventory to 0 instead of deleting it. Deleting a product removes the ability for advertisers to select it in the Epsilon Retail Media platform, even when it is back in stock. {% endhint %} ### Error handling If you receive a "product not found" error, it likely means the product has not been ingested into the Epsilon Retail Media system. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.citrusad.com/retail-media-interface/integration/data-api/catalog-products-2/syncing-products-via-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.