# Landing Pages

Category and attribute-based landing pages

## Retrieve category node landing page

> Returns landing page data for a category node with merged attributes and category information.

```json
{"openapi":"3.1.0","info":{"title":"CMS API - Content Management & Pages","version":"1.0.0"},"tags":[{"name":"Landing Pages","description":"Category and attribute-based landing pages"}],"servers":[{"description":"Default commerce site","url":"https://{commerce_url}","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Commerce storefront hostname"}}}],"paths":{"/category-node-landing-page/{landing_page_id}/":{"get":{"tags":["Landing Pages"],"operationId":"retrieveCategoryNodeLandingPage","summary":"Retrieve category node landing page","description":"Returns landing page data for a category node with merged attributes and category information.","parameters":[{"name":"landing_page_id","in":"path","required":true,"schema":{"type":"integer"},"description":"Landing page identifier"}],"responses":{"200":{"description":"Category node landing page retrieved","content":{"application/json":{"schema":{"type":"object","required":["attributes","category"],"properties":{"attributes":{"type":"object","description":"Merged attributes for the landing page","additionalProperties":true},"category":{"$ref":"#/components/schemas/CategoryNode"}}}}}},"404":{"description":"Landing page not found or not active"}}}}},"components":{"schemas":{"CategoryNode":{"type":"object","description":"Represents a category node in the product catalog hierarchy. Used in category node landing pages\nto display products from a specific category with merged category attributes and configuration.","required":["pk","name"],"properties":{"pk":{"type":"integer"},"name":{"type":"string"},"menuitemmodel":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Menu item model UUID"},"absolute_url":{"type":"string","format":"uri"},"attributes":{"type":"object","description":"Merged category attributes","additionalProperties":true},"attributes_kwargs":{"type":"object","description":"Attribute configuration","additionalProperties":true},"localized_attributes":{"type":"object","description":"Localized attributes","additionalProperties":true},"localized_attributes_kwargs":{"type":"object","description":"Localized attribute configuration","additionalProperties":true},"sort_option":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Sort option identifier"},"prev_sibling":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Previous sibling category identifier"},"parent":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Parent category identifier"},"uuid":{"type":"string","format":"uuid"},"depth":{"type":"integer","description":"Category depth in tree"},"path":{"type":"string","description":"Category path"}}}}}}
```

## Retrieve landing page

> Returns landing page data with product search results based on attribute values.\
> This endpoint integrates with the search/facet system to return products.

```json
{"openapi":"3.1.0","info":{"title":"CMS API - Content Management & Pages","version":"1.0.0"},"tags":[{"name":"Landing Pages","description":"Category and attribute-based landing pages"}],"servers":[{"description":"Default commerce site","url":"https://{commerce_url}","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Commerce storefront hostname"}}}],"paths":{"/landing-page/{landing_page_id}/":{"get":{"tags":["Landing Pages"],"operationId":"retrieveLandingPage","summary":"Retrieve landing page","description":"Returns landing page data with product search results based on attribute values.\nThis endpoint integrates with the search/facet system to return products.","parameters":[{"name":"landing_page_id","in":"path","required":true,"schema":{"type":"integer"},"description":"Landing page identifier"},{"$ref":"#/components/parameters/SearchParameters"}],"responses":{"200":{"description":"Landing page retrieved with product results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPageResponse"}}}},"404":{"description":"Landing 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":{"LandingPageResponse":{"type":"object","description":"Response from attribute-based landing page endpoint. Contains landing page data, merged attributes,\nattribute value information, paginated product results with search facets, sorters, and pagination metadata.\nProducts are filtered based on the landing page's attribute value.","required":["landing_page","attributes","attribute_value","pagination","facets","sorters","products"],"properties":{"landing_page":{"$ref":"#/components/schemas/LandingPage"},"attributes":{"type":"object","description":"Merged landing page attributes","additionalProperties":true},"attribute_value":{"$ref":"#/components/schemas/AttributeValue"},"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 matching the landing page criteria","items":{"type":"object","description":"Product data object (structure depends on product type and configuration)","additionalProperties":true}}}},"LandingPage":{"type":"object","description":"Attribute-based landing page that displays products filtered by a specific attribute value.\nContains landing page metadata, template information, attributes, and pretty URL mappings for multi-language support.","required":["pk","is_active"],"properties":{"pk":{"type":"integer"},"url":{"type":"string"},"attribute_value":{"type":"integer","description":"Attribute value identifier"},"landing_page_type":{"type":"integer","description":"Landing page type identifier"},"template":{"type":"string"},"is_active":{"type":"boolean"},"attributes":{"type":"object","description":"Landing page attributes","additionalProperties":true},"attributes_kwargs":{"type":"object","description":"Attribute configuration","additionalProperties":true},"created_date":{"type":"string","format":"date-time"},"modified_date":{"type":"string","format":"date-time"},"name":{"type":"string"},"landingpageprettyurl_set":{"type":"array","description":"Pretty URL mappings","items":{"type":"object","properties":{"pk":{"type":"integer"},"url":{"type":"string"},"language":{"type":"string"}}}}}},"AttributeValue":{"type":"object","description":"Represents a product attribute value used to filter products on attribute-based landing pages.\nContains the attribute definition, value, and display value for presentation.","required":["pk"],"properties":{"pk":{"type":"integer"},"attribute":{"type":"object","description":"Attribute information","properties":{"pk":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"}}},"value":{"type":"string"},"display_value":{"type":"string"}}}}}}
```

## Retrieve data source landing page

> Returns landing page data for a data source with widget and product collection information.

```json
{"openapi":"3.1.0","info":{"title":"CMS API - Content Management & Pages","version":"1.0.0"},"tags":[{"name":"Landing Pages","description":"Category and attribute-based landing pages"}],"servers":[{"description":"Default commerce site","url":"https://{commerce_url}","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Commerce storefront hostname"}}}],"paths":{"/data-source-landing-page/{pk}/":{"get":{"tags":["Landing Pages"],"operationId":"retrieveDataSourceLandingPage","summary":"Retrieve data source landing page","description":"Returns landing page data for a data source with widget and product collection information.","parameters":[{"name":"pk","in":"path","required":true,"schema":{"type":"integer"},"description":"Data source landing page identifier"}],"responses":{"200":{"description":"Data source landing page retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSourceLandingPage"}}}},"404":{"description":"Landing page not found or not active"}}}}},"components":{"schemas":{"DataSourceLandingPage":{"type":"object","description":"Landing page associated with a data source. Contains widget and product collection widget slugs\nfor displaying content and products related to the data source. Used for data source-specific product pages.","required":["pk","is_active"],"properties":{"pk":{"type":"integer"},"data_source":{"type":"object","description":"Associated data source information","properties":{"pk":{"type":"integer","description":"Data source identifier"},"name":{"type":"string","description":"Data source name"},"slug":{"type":"string","description":"Data source slug identifier"},"title":{"type":"string","description":"Data source title"}}},"widget":{"type":"string","description":"Widget slug"},"product_collection_widget":{"type":"string","description":"Product collection widget slug"},"is_active":{"type":"boolean"}}}}}}
```


---

# 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/landing-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.