The below outlines the properties possible in a standard request, and the response if you receive an 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 10. | 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 category, location, or size. | 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 |
memoryToken | Used for pagination. Use a token provided in a previous ad request to ensure CitrusAd only serves new ads to your customers. If provided, CitrusAd will exclude previously served ads in the ad response. Review Pagination to learn more. | Optional |
dtmCookieId | Cookies created and stored by the website, used for tracking user behavior on the same domain. | Optional |
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 |
sellerId | The unique Id of the seller. Will only populate if a sellerId is set on a team. sellerIds are typically used when onboarding marketplace sellers. | 73nns-32sxr-32ss 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 |
memoryToken | Used for pagination and chaining ad requests. If provided in your next ad request for the same context, CitrusAd will exclude previously served ads in the ad response. Review Pagination to learn more. |