The below outlines the properties possible in a standard request as outlined in Requesting ads. You will need to make three API calls. One for product ads, another for your banner x ad, and finally one for the static content.

Product ad requested items

String	Description	Required/optional
`catalogId`	Your product catalog identifier for your website.	Required
`customerId`	The unique identifier for the customer being served ads.	Optional.
`filterMode`	Optional way of defining the structure of your request. See Ad generation filtering for more information.	Optional, preferred.
`maxNumberOfAds`	The maximum number of ads you would like returned up to 15.	Required
`options`	Optional way of defining the structure of your request. See Ad generation filtering for more information.	Optional, preferred.
`placement`	The unique placement you are requesting ads for.	Required
`productFilters`	Any product filters relevant to your request. Such as a location. Must additionally include your brandpage filter of `brandpage:<VALUE>` The value is the unique URL suffix of the brand page. If there is a brand page configured for the suffix, CitrusAd will send content in the payload.	Required.
`sessionId`	The unique identifier of the customer's session. Used for attribution in standard integrations. Review Integration workflow options for more information.	Required in standard integrations

Product ad returned items

String	Description	Example value
`customPayload`	This custom payload that should be threaded from the catalog file to ad generation. The field should contain a valid JSON object serialised into a byte array and Base64 encoded. The JSON object should adhere to a schema.	Custom per integration
`id`	The unique id of the ad. This is unique to each request made to CitrusAd and cannot be cached.	`display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4`
`gtin`	The product code of the ad. This will be the product code synchronised in your product catalog.	`25813383`
`discount`	Legacy, can be ignored.	`{ "amount": 0, "minPrice": 0, "maxPerCustomer": 0 }`
`position`	The ad's position in the CitrusAd response. You should honour this position in the event fixed tenancy campaigns are utilised.	1

Banner x requested items

String	Description	Required/optional
`bannerSlotIds`	A json array of the banner slotIds being requested.	Required
`catalogId`	Your product catalog identifier for your website.	Required
`contentStandardId`	The content standard identifier for your website.	Required
`customerId`	The unique identifier for the customer being served ads.	Optional.
`filterMode`	Optional way of defining the structure of your request. See Ad generation filtering for more information.	Optional, preferred.
`maxNumberOfAds`	The maximum number of each banner slot you would like returned.	Required
`options`	Optional way of defining the structure of your request. See Ad generation filtering for more information.	Optional, preferred.
`placement`	The unique placement you are requesting ads for.	Required
`productFilters`	Any product filters relevant to your request. Such as a location. Must additionally include your brandpage filter of `brandpage:<VALUE>` The value is the unique URL suffix of the brand page. If there is a brand page configured for the suffix, CitrusAd will send content in the payload.	Required.
`sessionId`	The unique identifier of the customer's session. Used for attribution in standard integrations. Review Integration workflow options for more information.	Required in standard integrations
`slotId`	This contains any requested SlotId in the context. There can be one or many.	Required

Banner x returned items

String	Description	Example value
`backgroundColour`	The background colour of the banner - HEX values only.	`6e6c6c`
`backgroundImage`	The image link of the banner background image.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`backgroundImagePosition`	This defines the position type of the background image. If no value, you will need to default to `leftaligned` .	`leftaligned` `rightaligned` `fill` `repeating`
`bannerText`	The text displayed in the banner. May include HTML tags	`<strong>Double Fudge Ice Cream</strong>`
`bannerTextColour`	The banner text colour - HEX values only. Citrus does not send the `#`.	`1dc711`
`citrusAdId`	The unique id of the ad. This is unique to each request made to CitrusAd and cannot be cached.	`shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3`
`citrusCampaignName`	The campaign name of the ad.	`CitrusAd-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6`
`citrusContentStandardId`	The content standard id related to the slot.	`8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c`
`citrusExpiry`	The expiry of the ad. This is the latest point in which a click can be reported to CitrusAd	`2021-06-01T23:48:16.573967987Z`
`citrusSlotId`	The id of the specific slot for the banner you have requested.	`Category_Top`
`contentStandardId`	The content standard id related to the slot. Duplicate of `citrusContentStandardId`	`8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c`
`ctaFlag`	This defines if a CTA is shown or not.	`true` `false`
`ctaLink`	The url forwarded from the CTA (this is like linkUrl for banners). Only served if ctaFlag is `true`	`https://www.retailer.com/groceries/en-GB/search?query=double-fudge`
`ctaText`	The text within the CTA.	`Shop now`
`ctaTextAccessibility	Accessibility text of the CTA for screen reader users.	`for Double Fudge Ice Cream`
`gtins`	An array of up to 20 product codes selected from the campaign's advertised products. Retailers may use this list to automate lister pages when the banner is clicked, or automate certain rendering functionality (roundels, pricing, secondary stock level checking).	`"gtins": [ "7714107", "7163379", "7733636", "7733657", "7733628" ],`
`headingText`	Heading text for screen reader users.	`Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button`
`heroImageAltText`	Alternative text for the hero image in the rare event it doesn't display.	`Image of double fudge iced cream`
`heroImage`	The image link of the hero image of the banner.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`position`	The banner's position in the CitrusAd response. You should honour this position in the event fixed tenancy campaigns are utilised.	1
`secondaryBackgroundImage`	The image link of the secondary background image.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`secondaryBackgroundImagePosition`	This defines the position type of the secondary background image.	`leftaligned` `rightaligned`
`secondaryHeroImageAltText`	Alternative text for the secondary hero image in the rare event it doesn't display.	`Image of [brand] logo`
`secondaryHeroImage`	The image link of the secondary hero image.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`secondaryHeroMode`	This defines the display mode of the secondary hero image. If no value, you will need to default to `block` .	`block` `landscape`
`slotId`	The slot ID of the banner you have requested. When requesting multiple banners, this can be used to reference the IDs requested.	`Category_Top`
`tags`	This field returns any third party tags entered by the advertiser in their campaign. This is not currently something supported by banner x, though the API response is formatted.	`{}`

Brand page requested items

String	Description	Required/optional
`catalogId`	Your product catalog identifier for your website.	Required
`placement`	The unique placement you are requesting ads for.	Required
`brandPageId`	The unique id of the brand page. The value is the unique URL suffix of the brand page.	Required.

Product ad returned items

String	Description	Example value
`pageContentText`	Page content entered by the advertiser. Generally a paragraph or two that markets the content of the brand page.	Milk Choc Chunk will delight cookie lovers, with crisp wafer fingers covered in white choc, topped with cookie pieces on a milk chocolate base. Available in 170g block and 45g bar.
`pageHeaderText`	The heading of the brand page	New choc cookies

📘
If there is a field not configured as part of the ad's campaign, it will not be served. i.e if the advertiser has not configured a heroImage, CitrusAd will not serve the heroImage property.