Reference

Epsilon Retail Media's documentation is now centralized with our knowledgebase!

For up to date guides, please view this page in the new Integration APIs space of our documentation.

Reference documentation for the Integration APIs.

Getting started

• Overview

• What ads can Epsilon Retail Media serve?

• Epsilon API Terms of Use

• Acceptable Use Policy

Data & API

• API overview

• Ad Integration Workflow Options for Retailers

• Before you start

• HTTP persistence & endpoints

• Reporting Impressions and Clicks

• Ad generation filtering

• Timeouts and graceful fallback behaviour

• OAuth 2.0 Authentication

• Ad Interaction Events Reporting

• Integrate Banner X Video Interaction Reporting

• Integrate Banner X Shoppable Banner Interaction Reporting

• Data overview

• Sync data via file protocols

• Catalog & Products

• Syncing catalog via API

• Syncing products via API

• Syncing catalog & products via file

• Audience Targeting

• Option 1: Curated Unified Audiences

• Option 2: Sync Customers & Audience

• Option 3: Sync Audiences only

• Order data

• Syncing order data via API

• Syncing order data via file

FEATURE INTEGRATIONS

• Location targeting

• Pagination

• Placement level product type blocking (HFSS support)

• Marketplace sellerId

• Single Sign On for retailers

• Integrating Parent Products

• Suggested Keywords

• Category Cross-sell

• Difference Between Category and Category Cross-sell Placements

• Integration requirements

• Digital Services Act

Generating ads

• Product ads

• Requesting product ads

• Banner ads (static)

• Requesting banner ads

• Banner content standard

• Banner X

• Content standards

• Banner X previewer

• Banner X video ads

• Banner X video captions

• Companion products

• Generate banner X ads for different placements

• Frequently asked questions (FAQs)

• Go live checklist

• UAT tests

Brand Pages

• Brand Page Retailer Integration Guide

• Overview

• Prerequisites

• Integration Architecture

• Authentication

• Brand Page APIs

• Module Capabilities

• Tracking & Attribution

• Validation & Troubleshooting

References

• Audience targeting reference

• Product ad reference

• Banner ad (static) reference

• Banner X reference

• Catalog products reference

• Order reference

Integration

• Generate product and banner ads

• Generate banner X ads

• Report an order

• Retrieve a list of orders

• Retrieve an order

• Create or update a catalog

• Create or update a product

• Retrieve a list of products

• Retrieve a product

• Create or update a customer

• Retrieve a list of customers

• Retrieve a customer

• Manage customer-segment linkage

Citrus filter-mapping API

• filterMapping

• create filter mapping

• get list of filter mappings

• update a filter mapping

• get a filter mapping

• delete a filter mapping

CrossSellCategory API

• crossSellCategory

• Lists all cross sell categories (based on params provided)

• Create cross sell category

• Get cross sell category for specified id

• Delete cross sell category

REPORTING

• Overview

• Schema Definitions

• Reference

• Frequently Asked Questions