Content Pages

Special pages and flat pages

Retrieve special page

get

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

Path parameters

special_page_idintegerRequired

Special page identifier

Query parameters

sorterstringOptional

Sort option for product results

Example: price_asc

Responses

200

Special page retrieved with product results

application/json

404

Special page not found or not active

get

/special-page/{special_page_id}/

HTTPcURLJavaScriptPython

GET /special-page/{special_page_id}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "special_page": {
    "pk": 1,
    "name": "Summer Sale",
    "url": "/summer-sale",
    "template": "list/index.html",
    "banner": "https://example.com",
    "banner_url": "https://example.com",
    "product_collection": 1,
    "banner_description": "text",
    "is_active": true,
    "created_date": "2025-11-29T20:14:20.145Z",
    "modified_date": "2025-11-29T20:14:20.145Z",
    "video_embedded_code": "text",
    "specialpageprettyurl_set": [
      {
        "pk": 1,
        "url": "text",
        "language": "text"
      }
    ],
    "pretty_url": {
      "url": "text"
    },
    "extraction_strategy": "text",
    "banner_mobile": "https://example.com"
  },
  "pagination": {
    "current_page": 1,
    "num_pages": 5,
    "page_size": 20,
    "total_count": 100
  },
  "facets": [
    {
      "name": "text",
      "key": "text",
      "search_key": "text",
      "widget_type": "text",
      "order": 1,
      "extra_params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "sorters": [
    {
      "label": "text",
      "value": "text",
      "is_selected": true
    }
  ],
  "search_text": "text",
  "products": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Retrieve flat page

get

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

Path parameters

flat_page_idintegerRequired

Flat page identifier

Responses

200

Flat page retrieved

text/htmlapplication/json

Responsestring

Rendered HTML content

404

Flat page not found

get

/flat-page/{flat_page_id}/

HTTPcURLJavaScriptPython

GET /flat-page/{flat_page_id}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

text

Retrieve shop flat page

get

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

Path parameters

shop_flat_page_idintegerRequired

Shop flat page identifier

Responses

200

Shop flat page retrieved

application/json

404

Shop flat page not found

get

/shop-flat-page/{shop_flat_page_id}/

HTTPcURLJavaScriptPython

GET /shop-flat-page/{shop_flat_page_id}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "pk": 5,
  "flat_page": {
    "pk": 10,
    "url": "/about-us/",
    "title": "About Us",
    "content": "<h1>About Us</h1><p>Welcome to our store...</p>",
    "template_name": "flatpages/default.html",
    "registration_required": false,
    "sites": [
      1
    ],
    "flatpageprettyurl_set": [
      {
        "pk": 1,
        "url": "text",
        "language": "text"
      }
    ],
    "type": "standard"
  },
  "type": "standard"
}