These are example configurations
As CitrusAd's brand page product is flexible in the naming of certain fields in the API response, these are intended as thought starter templates.
You may choose to create templates in similar formats, or design your own.
Previewer limitations
At beta launch, CitrusAd will only support a single previewer. We plan to introduce a retailer-hosted previewer in the future to support the previewing of more complex templates.
Basic
This template has only two segments. One content, and one products segment. It is simple, but very easy to activate due to its simplicity.
Sample response
{
"id": "26f6117c-147b-4447-86aa-992e9ddb0daa",
"brandPageId": "262cb376-63dd-4e0c-8a6a-a7fd04f2ae82",
"brandPageTemplateId": "8e0d8836-aa23-42e5-84e1-535c7c9ced33",
"data": [
{
"id": "1b5a2521-9e79-4b95-99b0-4deffc586d81",
"name": "headingText",
"headingTextContent": "Kick-start Juice"
},
{
"id": "a79eb54b-4972-43cc-883d-9293921d50d0",
"name": "productSegment",
"productSelection": [
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 1,
"productCode": "ABC1",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 2,
"productCode": "ABC2",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 3,
"productCode": "ABC3",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 4,
"productCode": "ABC4",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 5,
"productCode": "ABC5",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 6,
"productCode": "ABC6",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 7,
"productCode": "ABC7",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 8,
"productCode": "ABC8",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 9,
"productCode": "ABC9",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 10,
"productCode": "ABC10",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 11,
"productCode": "ABC11",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 12,
"productCode": "ABC12",
"sellerId": ""
}
]
}
]
}
Standard
This template has four segments. Two content, one banner, and one products segment.
Sample response
{
"id": "26f6117c-147b-4447-86aa-992e9ddb0daa",
"brandPageId": "262cb376-63dd-4e0c-8a6a-a7fd04f2ae82",
"brandPageTemplateId": "8e0d8836-aa23-42e5-84e1-535c7c9ced33",
"data": [
{
"id": "1b5a2521-9e79-4b95-99b0-4deffc586d81",
"name": "headingText",
"headingTextContent": "Kick-start Juice"
},
{
"id": "c955d424-08ef-4f18-bfdd-57393f8caf9b",
"name": "banner",
"bannerText": "The world’s market leading coffee in a juice!",
"bannerSubText": "Start your day with a cup of Joe, in a cup of juice!",
"bannerHeroImageUrl": "https://assets.imageurl.io/s/9c6fa248-c5ff-4341-9833-7e2b08464ada",
"bannerBackgroundImageUrl": "https://assets.imageurl.io/s/85d2d333-eed5-44d7-b131-8m435c34r"
},
{
"id": "91f91531-6435-464d-bf30-4ce7bd50c00c",
"name": "paragraphText",
"paragraphTextContent": "With a standard cup of coffee infused with each 250ml cup of orange juice, you’ll be ready to start your day with a kick-start!"
},
{
"id": "a79eb54b-4972-43cc-883d-9293921d50d0",
"name": "productSegment",
"productSelection": [
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 1,
"productCode": "ABC1",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 2,
"productCode": "ABC2",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 3,
"productCode": "ABC3",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 4,
"productCode": "ABC4",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 5,
"productCode": "ABC5",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 6,
"productCode": "ABC6",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 7,
"productCode": "ABC7",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 8,
"productCode": "ABC8",
"sellerId": ""
}
]
}
]
}
Luxury
This template has six segments. Two content, two banner, and two products segments.
Sample response
{
"id": "26f6117c-147b-4447-86aa-992e9ddb0daa",
"brandPageId": "262cb376-63dd-4e0c-8a6a-a7fd04f2ae82",
"brandPageTemplateId": "8e0d8836-aa23-42e5-84e1-535c7c9ced33",
"data": [
{
"id": "1b5a2521-9e79-4b95-99b0-4deffc586d81",
"name": "headingText",
"headingTextContent": "Kick-start Juice"
},
{
"id": "c955d424-08ef-4f18-bfdd-57393f8caf9b",
"name": "topBanner",
"bannerText": "The world’s market leading coffee in a juice!",
"bannerSubText": "Start your day with a cup of Joe, in a cup of juice!",
"bannerHeroImageUrl": "https://assets.imageurl.io/s/9c6fa248-c5ff-4341-9833-7e2b08464ada",
"bannerBackgroundImageUrl": "https://assets.imageurl.io/s/85d2d333-eed5-44d7-b131-8m435c34r"
},
{
"id": "91f91531-6435-464d-bf30-4ce7bd50c00c",
"name": "paragraphText",
"paragraphTextContent": "With a standard cup of coffee infused with each 250ml cup of orange juice, you’ll be ready to start your day with a kick-start!"
},
{
"id": "a79eb54b-4972-43cc-883d-9293921d50d0",
"name": "productSegmentOne",
"productSelection": [
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 1,
"productCode": "ABC1",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 2,
"productCode": "ABC2",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 3,
"productCode": "ABC3",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 4,
"productCode": "ABC4",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 5,
"productCode": "ABC5",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 6,
"productCode": "ABC6",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 7,
"productCode": "ABC7",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 8,
"productCode": "ABC8",
"sellerId": ""
}
]
},
{
"id": "c955d424-08ef-4f18-bfdd-57393f8caf9b",
"name": "MidBanner",
"bannerText": "Interested in how this is even possible? Watch our process video to see how the magic happens!",
"backgroundHex": "#2e2e2e",
"callToActionLink": "https://www.brand-website.com/link-from-brandpage",
"callToActionText": "Watch now",
"callToActionAccessibilityText": "https://assets.imageurl.io/s/85d2d333-eed5-44d7-b131-8m435c34r"
},
{
"id": "a79eb54b-4972-43cc-883d-9293921d50d0",
"name": "productSegmentTwo",
"productSelection": [
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 1,
"productCode": "DEF1",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 2,
"productCode": "DEF2",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 3,
"productCode": "DEF3",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 4,
"productCode": "DEF4",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 5,
"productCode": "DEF5",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 6,
"productCode": "DEF6",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 7,
"productCode": "DEF7",
"sellerId": ""
},
{
"catalogId": "5234abe0-40cd-481f-9d99-596c88ede340",
"position": 8,
"productCode": "DEF8",
"sellerId": ""
}
]
}
]
}