API docs by Redocly

Catalog service API (1.0.0-catalog)

Download OpenAPI specification:

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

Catalog related service API

Many endpoints accept locale and siteKey as query parameters. If you specify:

  • only siteKey the response will include the items grouped by locales applicable to that siteKey
  • only locale the response will include the items grouped by siteKeys applicable to that locale
  • siteKey and locale the response will be the specific item in that locale and siteKey
  • neither siteKey or locale the response will include the items grouped by locale and then further grouped by siteKey

catalog

Catalog related api

Get URL info by key for product or category

Return url info for a specific category or product.

Authorizations:
api_key
path Parameters
key
required
string

The resource key

assetType
required
string
Enum: "product" "category"

The type of the asset

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Get all the url-infos

Return url info for all categories and products. Supports pagination

Authorizations:
api_key
query Parameters
limit
number [ 1 .. 500 ]

The maximum number of results to return. 0 defaults to the maximum of 500

after
string

Cursor to retrieve results after.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Get product by product key

Supports a number of views

Use locale to retrieve the product in a particular locale. If locale is not set it returns the product in all the supported locales.

Use siteKey to retrieve the product for a specific site, if the siteKey is not in the includedInStore property then 404 is returned.

Use projections to control the volume of data returned, multiple projections can be specified: summary - returns the product details (summary is always returned, but use this to only return the summary) skus - returns the variants of the product, can take longer for products with large numbers of variants matrix - returns a concisely formatted version of the variant information, use when volumes of potential skus is very high

Use filters to control filtering of products searchable, sellable and browsable. Multiple filters can be specified: isSearchable - limits to products defined as searchable in product data isSellableOnWeb - limits to products defined as sellable online in product data isBrowsable - limits to products defined as browsable in product data

Authorizations:
api_key
path Parameters
key
required
string

The resource key

query Parameters
locale
string

The ISO locale code

siteKey
string

The site key

currencyCode
string

Used in retrieving sku prices, requested currency code

customerGroup
string

Used in retrieving sku prices, Customer group identiifier

customerId
string

Used in retrieving sku prices, Customer ID

filters
string
Example: filters='isBrowsable,isSearchable,isSellableOnWeb'

Comma separated string of filters to apply to the products, valid values are 'isBrowsable', 'isSellableOnWeb', 'isSearchable'

priceChannelKey
string

Used in retrieving sku prices,, Key of the price channel / site

projections
string
Example: projections='summary,skus,matrix'

Comma separated string containing product projections. Valid projections 'summary', 'matrix', 'skus', 'prices'

object

Nested projection attributes used to reduce the attributes returned for a projection. Note the projection specified in the key should match a projection specified in the projection query param. Example: projectionAttributes[skus]=sku,labcode&projectionAttributes[prices]=centAmount

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Get product by a product sku

Supports a number of views

Use locale to retrieve the product in a particular locale. If locale is not set it returns the product in all the supported locales.

Use siteKey to retrieve the product for a specific site, if the siteKey is not in the includedInStore property then 404 is returned.

Use projections to control the volume of data returned, multiple projections can be specified: summary - returns the product details (summary is always returned, but use this to only return the summary) skus - returns the variants of the product, can take longer for products with large numbers of variants matrix - returns a concisely formatted version of the variant information, use when volumes of potential skus is very high

Use filters to control filtering of products searchable, sellable and browsable. Multiple filters can be specified: isSearchable - limits to products defined as searchable in product data isSellableOnWeb - limits to products defined as sellable online in product data isBrowsable - limits to products defined as browsable in product data

Authorizations:
api_key
path Parameters
key
required
string

The resource key

query Parameters
locale
string

The ISO locale code

siteKey
string

The site key

currencyCode
string

Used in retrieving sku prices, requested currency code

customerGroup
string

Used in retrieving sku prices, Customer group identiifier

customerId
string

Used in retrieving sku prices, Customer ID

filters
string
Example: filters='isBrowsable,isSearchable,isSellableOnWeb'

Comma separated string of filters to apply to the products, valid values are 'isBrowsable', 'isSellableOnWeb', 'isSearchable'

priceChannelKey
string

Used in retrieving sku prices,, Key of the price channel / site

projections
string
Example: projections='summary,skus,matrix'

Comma separated string containing product projections. Valid projections 'summary', 'matrix', 'skus', 'prices'

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Get product SKUS by product key

Supports a number of views

Use locale to retrieve the product skus in a particular locale. If locale is not set it returns the product in all the supported locales.

Use siteKey to retrieve the product skus for a specific site, if the siteKey is not in the includedInStore property then 404 is returned.

Authorizations:
api_key
path Parameters
productKey
required
string

The product key

query Parameters
locale
string

The ISO locale code

siteKey
string

The site key

currencyCode
string

Used in retrieving sku prices, requested currency code

customerGroup
string

Used in retrieving sku prices, Customer group identiifier

customerId
string

Used in retrieving sku prices, Customer ID

filters
string
Example: filters='isBrowsable,isSearchable,isSellableOnWeb'

Comma separated string of filters to apply to the products, valid values are 'isBrowsable', 'isSellableOnWeb', 'isSearchable'

priceChannelKey
string

Used in retrieving sku prices,, Key of the price channel / site

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "context": {
    },
  • "metrics": {
    }
}

Get product sku by product and sku key

Supports a number of filters

Use locale to retrieve the product in a particular locale. If locale is not set it returns the product in all the supported locales.

Use siteKey to retrieve the product for a specific site, if the siteKey is not in the includedInStore property then 404 is returned.

Authorizations:
api_key
path Parameters
productKey
required
string

The product key

key
required
string

The resource key

query Parameters
locale
string

The ISO locale code

siteKey
string

The site key

currencyCode
string

Used in retrieving sku prices, requested currency code

customerGroup
string

Used in retrieving sku prices, Customer group identiifier

customerId
string

Used in retrieving sku prices, Customer ID

filters
string
Example: filters='isBrowsable,isSearchable,isSellableOnWeb'

Comma separated string of filters to apply to the products, valid values are 'isBrowsable', 'isSellableOnWeb', 'isSearchable'

priceChannelKey
string

Used in retrieving sku prices,, Key of the price channel / site

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Retrieve products

Allows the retrieve of multiple products from the catalog. Utilizes pagination to allow results to be paged.

For performance reasons, if a projection is not specified a default abbreviated version of the product is returned.

Authorizations:
api_key
query Parameters
locale
string

The ISO locale code

siteKey
string

The site key

limit
number [ 1 .. 500 ]

The maximum number of results to return. 0 defaults to the maximum of 500

after
string

Cursor to retrieve results after.

filters
string
Example: filters='isBrowsable,isSearchable,isSellableOnWeb'

Comma separated string of filters to apply to the products, valid values are 'isBrowsable', 'isSellableOnWeb', 'isSearchable'

projections
string
Example: projections='summary,skus,matrix'

Comma separated string containing product projections. Valid projections 'summary', 'matrix', 'skus', 'prices'

type
string
Example: type='frame,accessory'

The product type to filter the products by

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Get sku by key

Supports a number of filters

Use locale to retrieve the product in a particular locale. If locale is not set it returns the product in all the supported locales.

Use siteKey to retrieve the product for a specific site, if the siteKey is not in the includedInStore property then 404 is returned.

Authorizations:
api_key
path Parameters
key
required
string

The resource key

query Parameters
locale
string

The ISO locale code

siteKey
string

The site key

currencyCode
string

Used in retrieving sku prices, requested currency code

customerGroup
string

Used in retrieving sku prices, Customer group identiifier

customerId
string

Used in retrieving sku prices, Customer ID

filters
string
Example: filters='isBrowsable,isSearchable,isSellableOnWeb'

Comma separated string of filters to apply to the products, valid values are 'isBrowsable', 'isSellableOnWeb', 'isSearchable'

priceChannelKey
string

Used in retrieving sku prices,, Key of the price channel / site

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Get all category summaries

Get all the categories

Authorizations:
api_key
query Parameters
locale
string

The ISO locale code

siteKey
string

The site key

limit
number [ 1 .. 500 ]

The maximum number of results to return. 0 defaults to the maximum of 500

after
string

Cursor to retrieve results after.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Get category by key

Retrieve the category using a key.

You can request a category for a specific locale and site/store.

Authorizations:
api_key
path Parameters
key
required
string

The resource key

query Parameters
locale
string

The ISO locale code

siteKey
string

The site key

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    },
  • "metrics": {
    },
  • "context": {
    }
}

Get product-type by key

Retrieve the product-type using a key.

Authorizations:
api_key
path Parameters
key
required
string

The resource key

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Get the frame configuration

Get the frame configuration

Authorizations:
api_key
query Parameters
locale
string

The ISO locale code

siteKey
string

The site key

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Health check information for the catalog service

Health check information for the catalog service

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}