Integration Option Two

Integration Option Two allows a Retailer to call their E-Commerce server for organic products and the CitrusAd server individually before merging the result. This may reduce development resources as as less changes will need to be made to existing requests by ensuring the request sent to CitrusAd is separate.

Integration Summary

During ad serving:

  • Products are requested from the e-commerce server

  • Organic products are returned to the website from the e-commerce server

  • Ads are requested to CitrusAd

  • Ads are returned to the retailer's e-commerce server

  • The e-commerce server serves the ads to the website

  • Ads and organic products are shown on the website together

  • Impressions are reported to CitrusAd

  • Clicks are reported to CitrusAd

  • Purchases related to ads are reported to CitrusAd

For an end user, the listings will not show until they have been merged, even though two separate calls have been made to the E-Commerce server and CitrusAd before being merged.


Step 1

Customer loads e-commerce website and navigates to either a category page or a search results page.

Step 2

The front end application (website) requests data from each e-commerce server according to categories selected by the customer (e.g Laptop - Windows).

Step 3

The e-commerce server returns the organic product listings to the user's browser, but does not show the listings to the user.

Step 4

Retailer’s server calls the CitrusAd API and requests ads from the “Laptop - Windows” category. *Retailer also sends customer ID (#13Xv652s) to CitrusAd as part of the Ad request to ensure ads returned are relevant.

Step 5

CitrusAd uses the retailer inventory (catalogue) and sales data to calculate the most relevant ads for the request (for the category and the person viewing the page). Within 50ms CitrusAd will return ads to the Retailer server in the form of product code (GTIN) and URL for Banner Ads.

Step 6

Retailer server sends sponsored products and banner content to the front end website.

Step 7

The organic listings, Product Listing Ads and Banner Ad content are merged before being served to the end user's browser.

Step 8

Retailer records which ads have been viewed and clicked on within the web browser using the CitrusAd Javascript SDK.

Step 9

Retailer reports any ads that have been purchased to CitrusAd.