Content service API (1.0.0-content)

Download OpenAPI specification:

URL: https://www.specsavers.co.uk License: UNLICENSED

Content related service API

content

Content related operations

Get component by id

Get the component for the given id

Authorizations:

api_key

path Parameters

id

required

string

The resource id

Responses

Response samples

200
400

Content type

application/json

{"data": {"_meta": {"id": "2bS5GnMZPsaH5nV18B9msF"
},
"_type": "ProductList",
"entryTitle": "Product List"
},
"metrics": {"durationMs": 544.78
},
"context": {"build": {"env": "dev",
"releaseId": "790",
"commitId": "539b03892ce29507eb1db78f4436abfbf260905a"
}
}
}

Get page by site, type and key

Gets the page based on site, content type and key

Authorizations:

api_key

path Parameters

siteKey required	string The key of the site for delivery options
key required	string The resource key
pageType required	string (PageType) Enum: "blog-news-page" "brand-page" "category-page" "collection-page" "content-page" "home-page" "health-fund-page" "health-page" "offer-page" "product-listing-page" "product" "site" The content page type

query Parameters

locale	string The ISO locale code
isPreview	boolean If set to true, this is for preview environment

Responses

Response samples

200
400

Content type

application/json

{"data": {"_type": "string",
"subject": {"_type": "string"
},
"title": "string",
"description": "string",
"crumbtrail": [{"assetType": "",
"assetKey": "string",
"label": "string"
}
],
"hideCrumbtrail": false,
"breadcrumbTitle": "string",
"summaryImage": {"url": "string",
"title": "string",
"_type": "Image"
},
"seoMetaDescription": "string",
"noTopSpacing": false,
"isIndexable": true,
"siteAvailability": ["string"
],
"components": {"top": [{"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
],
"main": [{"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
],
"bottom": [{"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
]
}
},
"context": {"siteKey": "specsavers-gb",
"build": {"env": "dev",
"releaseId": "911",
"commitId": "3d13f3c6c4f017d66d2a9c16c566ffb11f05f32c"
}
},
"metrics": {"durationMs": 0
}
}

Get site content by site key

Get the site content for the site key specified

Authorizations:

api_key

path Parameters

siteKey

required

string

The key of the site for delivery options

query Parameters

locale

string

The ISO locale code

Responses

Response samples

200
400

Content type

application/json

{"data": {"name": "string",
"header": {"default": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
},
"checkout": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
},
"footer": {"default": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
},
"emptyBasketActionCards": [{"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
],
"helpPrescriptionModal": {"default": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
},
"helpSunProtectionModal": {"default": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
},
"helpLensThicknessModal": {"default": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
},
"helpLensExtrasModal": {"default": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
},
"helpAddModal": {"default": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
},
"helpLensTypeModal": {"default": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
},
"noResultsPageGallery": {"default": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
},
"notFoundPage": {"default": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
},
"cardRetentionPolicy": {"default": {"_type": "string",
"_meta": {"id": "string",
"key": "string"
},
"property1": null,
"property2": null
}
},
"titleSuffix": "string",
"subscriptionDetailText": "string",
"externalUrls": {"bookAppointment": "string",
"storeFinder": "string"
},
"internalUrls": {"termsAndConditions": {"label": "string",
"target": {"type": "site",
"value": "string"
},
"noFollow": true,
"newWindow": true,
"style": "string",
"_type": "Link",
"_meta": {"id": "string",
"key": "string"
}
},
"privacyPolicy": {"label": "string",
"target": {"type": "site",
"value": "string"
},
"noFollow": true,
"newWindow": true,
"style": "string",
"_type": "Link",
"_meta": {"id": "string",
"key": "string"
}
},
"deliveryPolicy": {"label": "string",
"target": {"type": "site",
"value": "string"
},
"noFollow": true,
"newWindow": true,
"style": "string",
"_type": "Link",
"_meta": {"id": "string",
"key": "string"
}
},
"returnsPolicy": {"label": "string",
"target": {"type": "site",
"value": "string"
},
"noFollow": true,
"newWindow": true,
"style": "string",
"_type": "Link",
"_meta": {"id": "string",
"key": "string"
}
},
"offersLegal": {"label": "string",
"target": {"type": "site",
"value": "string"
},
"noFollow": true,
"newWindow": true,
"style": "string",
"_type": "Link",
"_meta": {"id": "string",
"key": "string"
}
},
"faqHub": {"label": "string",
"target": {"type": "site",
"value": "string"
},
"noFollow": true,
"newWindow": true,
"style": "string",
"_type": "Link",
"_meta": {"id": "string",
"key": "string"
}
},
"glassesCategory": {"label": "string",
"target": {"type": "site",
"value": "string"
},
"noFollow": true,
"newWindow": true,
"style": "string",
"_type": "Link",
"_meta": {"id": "string",
"key": "string"
}
},
"contactLensCategory": {"label": "string",
"target": {"type": "site",
"value": "string"
},
"noFollow": true,
"newWindow": true,
"style": "string",
"_type": "Link",
"_meta": {"id": "string",
"key": "string"
}
},
"contactUs": {"label": "string",
"target": {"type": "site",
"value": "string"
},
"noFollow": true,
"newWindow": true,
"style": "string",
"_type": "Link",
"_meta": {"id": "string",
"key": "string"
}
}
},
"_type": "string",
"_meta": {"id": "string",
"key": "string"
}
},
"context": {"siteKey": "specsavers-gb",
"build": {"env": "dev",
"releaseId": "911",
"commitId": "3d13f3c6c4f017d66d2a9c16c566ffb11f05f32c"
}
},
"metrics": {"durationMs": 0
}
}

Returns URL info objects for all URLs

Authorizations:

api_key

Responses

Response samples

200

Content type

application/json

{"data": {"property1": [{"key": "string",
"sites": ["string"
],
"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
},
"siteOverrides": {"property1": {"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
}
},
"property2": {"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
}
}
}
}
],
"property2": [{"key": "string",
"sites": ["string"
],
"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
},
"siteOverrides": {"property1": {"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
}
},
"property2": {"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
}
}
}
}
]
},
"context": {"siteKey": "specsavers-gb",
"build": {"env": "dev",
"releaseId": "911",
"commitId": "3d13f3c6c4f017d66d2a9c16c566ffb11f05f32c"
}
},
"metrics": {"durationMs": 0
}
}

Returns URL info for a given asset type

Authorizations:

api_key

path Parameters

pageType

required

string (PageType)

Enum: "blog-news-page" "brand-page" "category-page" "collection-page" "content-page" "home-page" "health-fund-page" "health-page" "offer-page" "product-listing-page" "product" "site"

The content page type

Responses

Response samples

200
400

Content type

application/json

{"data": {"property1": [{"key": "string",
"sites": ["string"
],
"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
},
"siteOverrides": {"property1": {"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
}
},
"property2": {"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
}
}
}
}
],
"property2": [{"key": "string",
"sites": ["string"
],
"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
},
"siteOverrides": {"property1": {"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
}
},
"property2": {"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
}
}
}
}
]
},
"context": {"siteKey": "specsavers-gb",
"build": {"env": "dev",
"releaseId": "911",
"commitId": "3d13f3c6c4f017d66d2a9c16c566ffb11f05f32c"
}
},
"metrics": {"durationMs": 0
}
}

Returns the URL info object for a specific asset

The type and key parameters must uniquely identify an asset

Authorizations:

api_key

path Parameters

pageType required	string (PageType) Enum: "blog-news-page" "brand-page" "category-page" "collection-page" "content-page" "home-page" "health-fund-page" "health-page" "offer-page" "product-listing-page" "product" "site" The content page type
key required	string The resource key

Responses

Response samples

200
400

Content type

application/json

{"data": {"key": "string",
"sites": ["string"
],
"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
},
"siteOverrides": {"property1": {"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
}
},
"property2": {"includeInSitemap": true,
"ancestors": [{"key": "string",
"type": "string"
}
],
"locales": {"property1": {"slug": "string",
"title": "string"
},
"property2": {"slug": "string",
"title": "string"
}
}
}
}
},
"context": {"siteKey": "specsavers-gb",
"build": {"env": "dev",
"releaseId": "911",
"commitId": "3d13f3c6c4f017d66d2a9c16c566ffb11f05f32c"
}
},
"metrics": {"durationMs": 0
}
}

Get page content search view by site, type and key

Gets the page view based on site, content type and key

Authorizations:

api_key

path Parameters

siteKey required	string The key of the site to retrieve content for
locale required	string The ISO locale code
key required	string The resource key
pageType required	string (PageType) Enum: "blog-news-page" "brand-page" "category-page" "collection-page" "content-page" "home-page" "health-fund-page" "health-page" "offer-page" "product-listing-page" "product" "site" The content page type

Responses

Response samples

200

Content type

application/json

{"data": {"_type": "string",
"title": "string",
"description": "string"
},
"context": {"siteKey": "specsavers-gb",
"build": {"env": "dev",
"releaseId": "911",
"commitId": "3d13f3c6c4f017d66d2a9c16c566ffb11f05f32c"
}
},
"metrics": {"durationMs": 0
}
}

Health check information for the content service

The health endpoint.

Authorizations:

api_key

Responses

Response samples

200
400

Content type

application/json

{"data": {"status": "pass",
"version": "1.0",
"releaseId": "1234567890",
"service": "inventory",
"details": {"time": "2023-11-15T12:19:05.737Z",
"env": "dev",
"commitId": "368de0fbdff3a5634895d69f8b17cbdfd5e77bfb"
}
}
}

Health check information for the Contentful webhook ingest service

The health endpoint.

Authorizations:

api_key

Responses

Response samples

200
400

Content type

application/json

{"data": {"status": "pass",
"version": "1.0",
"releaseId": "1234567890",
"service": "inventory",
"details": {"time": "2023-11-15T12:19:05.737Z",
"env": "dev",
"commitId": "368de0fbdff3a5634895d69f8b17cbdfd5e77bfb"
}
}
}

contentful

Handles a Contentful Webhook request

Authorizations:

api_key

Responses

Response samples

200

Content type

application/json

{"context": {"siteKey": "specsavers-gb",
"build": {"env": "dev",
"releaseId": "911",
"commitId": "3d13f3c6c4f017d66d2a9c16c566ffb11f05f32c"
}
},
"metrics": {"durationMs": 0
}
}