Overview of the CitrusAd Platform.

What is CitrusAd?

CitrusAd is a scalable, auction based advertising platform built for e-commerce retailers to easily integrate into. The API keeps the e-commerce retailer in full control of how, when, where and how often ads are shown. If you haven't heard of CitrusAd before, or you are unfamiliar with the product's features view the citrusad.com site.

Using first party sales data from the retailer, CitrusAd is able to deliver relevant and personalised ad content to the retailer's e-commerce server in the form of barcode and image URL, each and every time a new page is loaded.

The CitrusAd API makes it possible for you (the retailer) to place advertisements on your e-commerce website. After you define the slots on your websites in which advertisements are placed, the slots become available for advertisers to bid on. You (the retailer) determine which items in your catalog you want to advertise, and CitrusAd makes it possible for advertisers to bid on the opportunity to advertise those items.

Basic Overview

In its very simplified form, CitrusAd allows advertisers to create advertising campaigns that appear on each retailer's site. Advertisers are able to promote their products to the top of a retailer's website and track the performance of those products in real time. Advertisers use the admin portal to select products, budgets, advertising strategies and search terms they wish for their products to appear at the top of the page for.

How CitrusAd Works

The CitrusAd API is organised around REST. The API has predictable, resource-oriented URLs and uses HTTP response codes to indicate API errors. This API uses built-in HTTP features such as HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.

Authentication to the CitrusAd API is handled through the use of API keys. These are used during communication between your backend and the CitrusAd API.

The CitrusAd API supports uploading products, catalogs, customers, and order information. This data is used in the generation of ads. You can use the CitrusAd API to request ads and to report on user interactions with those ads.

API Introduction

View the API Introduction to gain an overview of what is required to integrate with CitrusAd.

Ad Types

CitrusAd are capable of serving various types of ads:

  • Product Ads

  • Banner Ads

  • Banner X Ads (Responsive Banners)

Learn more about each ad type on the What Ads Can CitrusAd Serve page:

Integration Workflow Options

We support many integration options depending on your individual infrastructure and needs. See the "Integration Workflow Options" page to learn more: