# Content Pages

Special pages and flat pages

## Retrieve special page

> Returns special page data with product search results from the associated product collection.\
> This endpoint integrates with the search/facet system.

```json
{"openapi":"3.1.0","info":{"title":"CMS API - Content Management & Pages","version":"1.0.0"},"tags":[{"name":"Content Pages","description":"Special pages and flat pages"}],"servers":[{"description":"Default commerce site","url":"https://{commerce_url}","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Commerce storefront hostname"}}}],"paths":{"/special-page/{special_page_id}/":{"get":{"tags":["Content Pages"],"operationId":"retrieveSpecialPage","summary":"Retrieve special page","description":"Returns special page data with product search results from the associated product collection.\nThis endpoint integrates with the search/facet system.","parameters":[{"name":"special_page_id","in":"path","required":true,"schema":{"type":"integer"},"description":"Special page identifier"},{"$ref":"#/components/parameters/SearchParameters"}],"responses":{"200":{"description":"Special page retrieved with product results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecialPageResponse"}}}},"404":{"description":"Special page not found or not active"}}}}},"components":{"parameters":{"SearchParameters":{"name":"sorter","in":"query","description":"Sort option for product results","required":false,"schema":{"type":"string"}}},"schemas":{"SpecialPageResponse":{"type":"object","description":"Response from special page endpoint. Contains special page data, paginated product results from\nthe associated product collection, search facets, sorters, and pagination metadata.\nProducts are extracted from the special page's product collection using the configured extraction strategy.","required":["special_page","pagination","facets","sorters","products"],"properties":{"special_page":{"$ref":"#/components/schemas/SpecialPage"},"pagination":{"type":"object","description":"Pagination information","properties":{"current_page":{"type":"integer"},"num_pages":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"}}},"facets":{"type":"array","description":"Search facets/widgets for filtering and navigation","items":{"type":"object","description":"Facet/widget configuration for product filtering","properties":{"name":{"type":"string","description":"Display name of the facet"},"key":{"type":"string","description":"Facet key identifier"},"search_key":{"type":"string","description":"Search key used in query parameters"},"widget_type":{"type":"string","description":"Type of widget used to render this facet"},"order":{"type":"integer","description":"Display order of the facet"},"extra_params":{"type":"object","description":"Additional parameters for facet configuration","additionalProperties":true},"data":{"type":"object","description":"Facet data and options","additionalProperties":true}}}},"sorters":{"type":"array","description":"Available sort options for product results","items":{"type":"object","description":"Sort option configuration","properties":{"label":{"type":"string","description":"Display label for the sort option"},"value":{"type":"string","description":"Sort value to use in query parameters"},"is_selected":{"type":"boolean","description":"Whether this sort option is currently selected"}}}},"search_text":{"type":"string","description":"Search query text"},"products":{"type":"array","description":"Paginated list of product results from the product collection","items":{"type":"object","description":"Product data object (structure depends on product type and configuration)","additionalProperties":true}}}},"SpecialPage":{"type":"object","description":"Product collection page that displays products from a specific product collection. Contains banner images,\nproduct collection reference, template information, and pretty URL mappings. Supports video embedding\nand different product extraction strategies.","required":["pk","is_active"],"properties":{"pk":{"type":"integer"},"name":{"type":"string"},"url":{"type":"string"},"template":{"type":"string"},"banner":{"type":"string","format":"uri","description":"Banner image URL"},"banner_url":{"type":"string","format":"uri","description":"Banner link URL"},"product_collection":{"type":"integer","description":"Product collection identifier"},"banner_description":{"type":"string","description":"Banner description text"},"is_active":{"type":"boolean"},"created_date":{"type":"string","format":"date-time"},"modified_date":{"type":"string","format":"date-time"},"video_embedded_code":{"type":"string","description":"Embedded video code"},"specialpageprettyurl_set":{"type":"array","description":"Pretty URL mappings","items":{"type":"object","properties":{"pk":{"type":"integer"},"url":{"type":"string"},"language":{"type":"string"}}}},"pretty_url":{"type":"object","description":"Pretty URL object","properties":{"url":{"type":"string"}}},"extraction_strategy":{"type":"string","description":"Product extraction strategy"},"banner_mobile":{"type":"string","format":"uri","description":"Mobile banner image URL"}}}}}}
```

## Retrieve flat page

> Returns flat page content. Can return HTML or JSON format based on Accept header.\
> Flat pages may require registration depending on configuration.

```json
{"openapi":"3.1.0","info":{"title":"CMS API - Content Management & Pages","version":"1.0.0"},"tags":[{"name":"Content Pages","description":"Special pages and flat pages"}],"servers":[{"description":"Default commerce site","url":"https://{commerce_url}","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Commerce storefront hostname"}}}],"paths":{"/flat-page/{flat_page_id}/":{"get":{"tags":["Content Pages"],"operationId":"retrieveFlatPage","summary":"Retrieve flat page","description":"Returns flat page content. Can return HTML or JSON format based on Accept header.\nFlat pages may require registration depending on configuration.","parameters":[{"name":"flat_page_id","in":"path","required":true,"schema":{"type":"integer"},"description":"Flat page identifier"}],"responses":{"200":{"description":"Flat page retrieved","content":{"text/html":{"schema":{"type":"string","description":"Rendered HTML content"}},"application/json":{"schema":{"$ref":"#/components/schemas/FlatPage"}}}},"404":{"description":"Flat page not found"}}}}},"components":{"schemas":{"FlatPage":{"type":"object","description":"Static content page (flat page) returned in JSON format. Contains HTML content, title, URL,\ntemplate information, and optional shop flat page configuration. Can be returned as HTML or JSON\nbased on the Accept header.","required":["url","title","content"],"properties":{"url":{"type":"string"},"title":{"type":"string"},"content":{"type":"string","description":"HTML content"},"template_name":{"type":"string"},"shopflatpage":{"type":"object","description":"Shop flat page configuration","properties":{"attributes":{"type":"object","description":"Shop flat page attributes","additionalProperties":true},"type":{"type":"string","description":"Shop flat page type"},"config":{"type":"object","description":"Shop flat page configuration","additionalProperties":true}}}}}}}}
```

## Retrieve shop flat page

> Returns shop-specific flat page data with type and configuration.

```json
{"openapi":"3.1.0","info":{"title":"CMS API - Content Management & Pages","version":"1.0.0"},"tags":[{"name":"Content Pages","description":"Special pages and flat pages"}],"servers":[{"description":"Default commerce site","url":"https://{commerce_url}","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Commerce storefront hostname"}}}],"paths":{"/shop-flat-page/{shop_flat_page_id}/":{"get":{"tags":["Content Pages"],"operationId":"retrieveShopFlatPage","summary":"Retrieve shop flat page","description":"Returns shop-specific flat page data with type and configuration.","parameters":[{"name":"shop_flat_page_id","in":"path","required":true,"schema":{"type":"integer"},"description":"Shop flat page identifier"}],"responses":{"200":{"description":"Shop flat page retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShopFlatPage"}}}},"404":{"description":"Shop flat page not found"}}}}},"components":{"schemas":{"ShopFlatPage":{"type":"object","description":"Shop-specific flat page with type and configuration. Extends the base flat page with shop-specific\nattributes, type classification, and configuration. Supports multi-language pretty URLs.","required":["pk","flat_page","type"],"properties":{"pk":{"type":"integer"},"flat_page":{"type":"object","description":"Flat page details","required":["pk","url","title","content"],"properties":{"pk":{"type":"integer"},"url":{"type":"string"},"title":{"type":"string"},"content":{"type":"string","description":"HTML content"},"template_name":{"type":"string"},"registration_required":{"type":"boolean"},"sites":{"type":"array","description":"Site identifiers","items":{"type":"integer"}},"flatpageprettyurl_set":{"type":"array","description":"Pretty URL mappings","items":{"type":"object","properties":{"pk":{"type":"integer"},"url":{"type":"string"},"language":{"type":"string"}}}},"type":{"type":"string","description":"Shop flat page type"}}},"type":{"type":"string","description":"Shop flat page type"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.akinon.com/commerce-openapis/cms/content-pages.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.