Cms

get

This method returns details about a specific landing page type, including its ID, name, slug, creation and modification timestamps, and associated function module and name. It also includes the schema for the landing page, such as attributes like product badges, with their data types, requirements, and labels.

Authorizations
Query parameters
created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

func_modulestringOptional

Query parameter func_module used to filter results based on specific conditions.

func_namestringOptional

Query parameter func_name used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

namestringOptional

Query parameter name used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

schemaanyOptional

Query parameter schema used to filter results based on specific conditions.

slugstringOptional

Query parameter slug used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/landing-page-types/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "created_date": "2025-06-27T08:34:30.841Z",
      "func_module": "text",
      "func_name": "text",
      "id": 1,
      "modified_date": "2025-06-27T08:34:30.841Z",
      "name": "text",
      "schema": null,
      "slug": "text"
    }
  ]
}
get

This method returns details about a specific landing page type, including its ID, name, slug, creation and modification timestamps, and associated function module and name. It also includes the schema for the landing page, such as attributes like product badges, with their data types, requirements, and labels. This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this landing page type.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/landing-page-types/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "created_date": "2025-06-27T08:34:30.841Z",
  "func_module": "text",
  "func_name": "text",
  "id": 1,
  "modified_date": "2025-06-27T08:34:30.841Z",
  "name": "text",
  "schema": null,
  "slug": "text"
}
get

This method returns details about a specific landing page, including its ID, name, URL, template, and associated landing page type. It also provides information about its active status, content type, pretty URL, and related attributes, including any localized attributes and values.

Authorizations
Query parameters
attribute_valueintegerOptional

Query parameter attribute_value used to filter results based on specific conditions.

attributesanyOptional

Query parameter attributes used to filter results based on specific conditions.

attributes_kwargsanyOptional

Query parameter attributes_kwargs used to filter results based on specific conditions.

content_typeintegerOptional

Query parameter content_type used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

is_activebooleanOptional

Query parameter is_active used to filter results based on specific conditions.

landing_page_typeintegerOptional

Query parameter landing_page_type used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

localized_attributesanyOptional

Query parameter localized_attributes used to filter results based on specific conditions.

localized_attributes_kwargsanyOptional

Query parameter localized_attributes_kwargs used to filter results based on specific conditions.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

namestringOptional

Query parameter name used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

pretty_urlintegerOptional

Query parameter pretty_url used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

templatestringOptional

Query parameter template used to filter results based on specific conditions.

urlstringOptional

Query parameter url used to filter results based on specific conditions.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/landing-pages/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "attribute_value": 1,
      "attributes": null,
      "attributes_kwargs": null,
      "content_type": 1,
      "created_date": "2025-06-27T08:34:30.841Z",
      "id": 1,
      "is_active": true,
      "landing_page_type": 1,
      "localized_attributes": null,
      "localized_attributes_kwargs": null,
      "modified_date": "2025-06-27T08:34:30.841Z",
      "name": "text",
      "pretty_url": 1,
      "template": "text",
      "url": "text"
    }
  ]
}
get

This method returns details about a specific landing page, including its ID, name, URL, template, and associated landing page type. It also provides information about its active status, content type, pretty URL, and related attributes, including any localized attributes and values. This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this landing page.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/landing-pages/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "attribute_value": 1,
  "attributes": null,
  "attributes_kwargs": null,
  "content_type": 1,
  "created_date": "2025-06-27T08:34:30.841Z",
  "id": 1,
  "is_active": true,
  "landing_page_type": 1,
  "localized_attributes": null,
  "localized_attributes_kwargs": null,
  "modified_date": "2025-06-27T08:34:30.841Z",
  "name": "text",
  "pretty_url": 1,
  "template": "text",
  "url": "text"
}
get

This method returns details about a specific SEO entry, including its ID, creation and modification timestamps, URL, title, description, and keywords. It also includes any associated attributes, such as CSS class, along with localized attributes if available.

Authorizations
Query parameters
attributesanyOptional

Query parameter attributes used to filter results based on specific conditions.

attributes_kwargsanyOptional

Query parameter attributes_kwargs used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

descriptionstringOptional

Query parameter description used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

keywordsstringOptional

Query parameter keywords used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

localized_attributesanyOptional

Query parameter localized_attributes used to filter results based on specific conditions.

localized_attributes_kwargsanyOptional

Query parameter localized_attributes_kwargs used to filter results based on specific conditions.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

titlestringOptional

Query parameter title used to filter results based on specific conditions.

urlstringOptional

Query parameter url used to filter results based on specific conditions.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/seo/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "attributes": null,
      "attributes_kwargs": null,
      "created_date": "2025-06-27T08:34:30.841Z",
      "description": "text",
      "id": 1,
      "keywords": "text",
      "localized_attributes": null,
      "localized_attributes_kwargs": null,
      "modified_date": "2025-06-27T08:34:30.841Z",
      "title": "text",
      "url": "text"
    }
  ]
}
get

This method returns details about a specific SEO entry, including its ID, creation and modification timestamps, URL, title, description, and keywords. It also includes any associated attributes, such as CSS class, along with localized attributes if available. This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this seo.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/seo/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "attributes": null,
  "attributes_kwargs": null,
  "created_date": "2025-06-27T08:34:30.841Z",
  "description": "text",
  "id": 1,
  "keywords": "text",
  "localized_attributes": null,
  "localized_attributes_kwargs": null,
  "modified_date": "2025-06-27T08:34:30.841Z",
  "title": "text",
  "url": "text"
}
get

This method returns details about a specific special page’s pretty URL, including its ID, creation and modification timestamps, associated special page ID, URL, and the language in which it is defined.

Authorizations
Query parameters
created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

languagestringOptional

Query parameter language used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

special_pageintegerOptional

Query parameter special_page used to filter results based on specific conditions.

urlstringOptional

Query parameter url used to filter results based on specific conditions.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/special-page-pretty-urls/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "created_date": "2025-06-27T08:34:30.841Z",
      "id": 1,
      "language": "tr-tr",
      "modified_date": "2025-06-27T08:34:30.841Z",
      "special_page": 1,
      "url": "text"
    }
  ]
}
get

This method returns details about a specific special page’s pretty URL, including its ID, creation and modification timestamps, associated special page ID, URL, and the language in which it is defined. This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this special page pretty url.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/special-page-pretty-urls/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "created_date": "2025-06-27T08:34:30.841Z",
  "id": 1,
  "language": "tr-tr",
  "modified_date": "2025-06-27T08:34:30.841Z",
  "special_page": 1,
  "url": "text"
}
get

This method returns details about a specific special page, including its ID, name, URL, template, and extraction strategy. It also includes information on banners, video embedded code, associated product collection, and pretty URL. The response may also include the page’s active status, creation and modification timestamps, and any localized or additional attributes.

Authorizations
Query parameters
attributesanyOptional

Query parameter attributes used to filter results based on specific conditions.

attributes_kwargsanyOptional

Query parameter attributes_kwargs used to filter results based on specific conditions.

banner_descriptionstringOptional

Query parameter banner_description used to filter results based on specific conditions.

banner_urlstringOptional

Query parameter banner_url used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

extraction_strategystringOptional

Query parameter extraction_strategy used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

is_activebooleanOptional

Query parameter is_active used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

localized_attributesanyOptional

Query parameter localized_attributes used to filter results based on specific conditions.

localized_attributes_kwargsanyOptional

Query parameter localized_attributes_kwargs used to filter results based on specific conditions.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

namestringOptional

Query parameter name used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

pretty_urlintegerOptional

Query parameter pretty_url used to filter results based on specific conditions.

product_collectionintegerOptional

Query parameter product_collection used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

templatestringOptional

Query parameter template used to filter results based on specific conditions.

urlstringOptional

Query parameter url used to filter results based on specific conditions.

video_embedded_codestringOptional

Query parameter video_embedded_code used to filter results based on specific conditions.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/special-pages/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "attributes": null,
      "attributes_kwargs": null,
      "banner": "https://example.com",
      "banner_description": "text",
      "banner_mobile": "https://example.com",
      "banner_url": "text",
      "created_date": "2025-06-27T08:34:30.841Z",
      "extraction_strategy": "omnishop.search.strategies.DefaultProductExtractionStrategy",
      "id": 1,
      "is_active": true,
      "localized_attributes": null,
      "localized_attributes_kwargs": null,
      "modified_date": "2025-06-27T08:34:30.841Z",
      "name": "text",
      "pretty_url": 1,
      "product_collection": 1,
      "template": "text",
      "url": "text",
      "video_embedded_code": "text"
    }
  ]
}
get

This method returns details about a specific special page, including its ID, name, URL, template, and extraction strategy. It also includes information on banners, video embedded code, associated product collection, and pretty URL. The response may also include the page’s active status, creation and modification timestamps, and any localized or additional attributes. This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this special page.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/special-pages/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "attributes": null,
  "attributes_kwargs": null,
  "banner": "https://example.com",
  "banner_description": "text",
  "banner_mobile": "https://example.com",
  "banner_url": "text",
  "created_date": "2025-06-27T08:34:30.841Z",
  "extraction_strategy": "omnishop.search.strategies.DefaultProductExtractionStrategy",
  "id": 1,
  "is_active": true,
  "localized_attributes": null,
  "localized_attributes_kwargs": null,
  "modified_date": "2025-06-27T08:34:30.841Z",
  "name": "text",
  "pretty_url": 1,
  "product_collection": 1,
  "template": "text",
  "url": "text",
  "video_embedded_code": "text"
}
get

This method returns details about a specific widget type, including its ID, name, and schema. The schema contains information about the widget’s attributes, such as the title, its localizability, required status, data type, and label

Authorizations
Query parameters
idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

limitintegerOptional

Limits the number of results returned in the response.

namestringOptional

Query parameter name used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

schemaanyOptional

Query parameter schema used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/widget-types/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "name": "text",
      "schema": null
    }
  ]
}
get

This method returns details about a specific widget type, including its ID, name, and schema. The schema contains information about the widget’s attributes, such as the title, its localizability, required status, data type, and label This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this widget type.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/widget-types/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "id": 1,
  "name": "text",
  "schema": null
}
get

This method returns details about a specific widget, including its ID, name, slug, template, creation and modification timestamps, and content type. It also includes information about the associated widget type and any attributes, both localized and non-localized.

Authorizations
Query parameters
attributesanyOptional

Query parameter attributes used to filter results based on specific conditions.

attributes_kwargsanyOptional

Query parameter attributes_kwargs used to filter results based on specific conditions.

content_typeintegerOptional

Query parameter content_type used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

limitintegerOptional

Limits the number of results returned in the response.

localized_attributesanyOptional

Query parameter localized_attributes used to filter results based on specific conditions.

localized_attributes_kwargsanyOptional

Query parameter localized_attributes_kwargs used to filter results based on specific conditions.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

namestringOptional

Query parameter name used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

slugstringOptional

Query parameter slug used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

templatestringOptional

Query parameter template used to filter results based on specific conditions.

widget_typeintegerOptional

Query parameter widget_type used to filter results based on specific conditions.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/widgets/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "attributes": null,
      "attributes_kwargs": null,
      "content_type": 1,
      "created_date": "2025-06-27T08:34:30.841Z",
      "id": 1,
      "localized_attributes": null,
      "localized_attributes_kwargs": null,
      "modified_date": "2025-06-27T08:34:30.841Z",
      "name": "text",
      "slug": "text",
      "template": "text",
      "widget_type": 1
    }
  ]
}
get

This method returns details about a specific widget, including its ID, name, slug, template, creation and modification timestamps, and content type. It also includes information about the associated widget type and any attributes, both localized and non-localized. This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this widget.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/cms/widgets/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "attributes": null,
  "attributes_kwargs": null,
  "content_type": 1,
  "created_date": "2025-06-27T08:34:30.841Z",
  "id": 1,
  "localized_attributes": null,
  "localized_attributes_kwargs": null,
  "modified_date": "2025-06-27T08:34:30.841Z",
  "name": "text",
  "slug": "text",
  "template": "text",
  "widget_type": 1
}

Was this helpful?