An overview of the CitrusAd API for integrators.
When integrating, please refer to any of the below resources for more information:
Retailer and supplier knowledge base with information of each and every feature.
Instructions on how to get up and running
A list and explanation of all relevant terms used
A summary of all required steps to complete a basic integration
CitrusAd uses various endpoints to sync data and generate ads. A brief summary is below:
Used to create catalogs Via API
Used to create and update product data within a catalog
Used to create and update customer data within a catalog
Used to send order data to CitrusAd
Used to generate product ads and banner ads
Used to generate banner x ads
To interact with each API you will need access to the CitrusAd staging platform. Please contact CitrusAd for access.
Once you have access to a Retailer team, you will need to locate your
teamId and API key. For backend integrations, you will only need the secret API key. You can locate your API key within the CitrusAd Portal.
The data payload is in JSON format. The
Content-Type for these endpoints is
application/json, which should be passed as a header in your requests:
-H "Content-Type: application/json" \
CitrusAd uses basic authentication, this should be passed as a header with your API key:
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
For backend integrations, you will only need the secret API key. You can locate your API key within the CitrusAd Portal.
CitrusAd uses different base URLs for staging, as well as different production environments.