Partner API
API Reference

Generate product and banner ads

post
https://integration-BASE-URL.citrusad.com/v1/ads/generate
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The catalogId you are requesting ads for. Typically a single identifier for a retailer.

string
required

The placement you are requesting ads for.

string

Your unique customerId. Optional.

string

Unique sessionId used for attribution. Required to be consistent between a user's session and order reporting.

string

Used for search placements. The exact search term entered by the customer on your site.

string

Used for cross-sell placements. The product code that is being advertised against

int32
required

The maximum number of product ads to receive.

string

The banner contentStandardId. Required for banners.

bannerSlotIds
array of strings

The banner slots ads are required. Will be superseded by bannerSlots array object.

bannerSlotIds
json
Defaults to [ [ "category:Frozen" ], ["Location:Brisbane Central"]]

An array or arrays are required depending on your ad generation filtering. Used in category placements or any other placement to further define business rules. Not currently compatible with cross-sell or upsell placements.

options
array of objects
options
bannerSlots
array of objects

The banner slots that are requested. Specifying maxNumberOfAds for the banner allows you to retrieve multiple of the same banner slot.

bannerSlots
audience
array of objects
audience
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago