Retrieving banner content items

Edit on GitHub
You are browsing a previous version of the document. The latest version is 202212.0.

This endpoint allows retrieving information about banner content items.


For details on the modules that provide the API functionality and how to install them, see Content Items API.

Retrieve a banner content item

To retrieve information about a banner content item, send the request:

GET /content-banners/{{content_item_key}}

Path parameter Description
{{content_item_key}} Unique identifier of the content item to retrieve.


Header key Required Description
locale Defines the locale to retreive the content item information for. If not specified, the endpoint returns the information for the default locale.

Request sample : GET


Response sample:

	"data": {
		"type": "content-banners",
		"id": "br-3",
		"attributes": {
			"title": "Cameras Winter Collection",
			"subtitle": "The best cameras in winter 2019",
			"imageUrl": "",
			"clickUrl": "/en/canon-powershot-n-35",
			"altText": "Best selling cameras in winter"
		"links": {
			"self": ""
Attribute Type Description
title string Heading of the banner.
subtitle string Secondary message that clarifies a title to shop visitors.
imageUrl string Address to where the image element of the banner is stored.
clickUrl string URL of the target page to which your shop visitors are redirected.
altText string Text that describes the image.

Possible errors

Code Reason
2201 Content not found.
2202 Content key is missing.
2203 Content type is invalid.

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.