Type representations

Common API Types used within multiple API resources.

DataSourceConfiguration

`dataSourceId` String
`type` String
`name` String
`configuration` Any

DataSourceResponse

`dataSourcePayload` Object
`previewPayload` Object

DataSources

Object containing the data sources configured for the page folder and referenced in the page.

Environment

production
development

Error

`ok` Boolean
`message` String

Footer

Head

layoutElements

Array of LayoutElement

LayoutElement

`layoutElementId` String
`configuration` LayoutElementConfiguration
`tastics` Array of Tastic

LayoutElementConfiguration

`size` Float
`mobile` Boolean
`tablet` Boolean
`desktop` Boolean

Locale

String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

Main

layoutElements

Array of LayoutElement

Page

Page represents the structure and data of the published page displayed through commercetools Frontend.

`pageId` String
`sections` Sections
`state` String

PageDataResponse

`pageFolder` PageFolder
`page` Page
`data` ViewData

PageFolder

`pageFolderId` String
`isDynamic` Boolean
`pageFolderType` String
`configuration` Any
`dataSourceConfigurations` Array of DataSourceConfiguration
`name` String
`ancestorIdsMaterializedPath` String
`depth` Float
`sort` Float

PagePreviewContext

customerName

String

PagePreviewDataResponse

`pageFolder` PageFolder
`page` Page
`data` ViewData
`previewId` String
`previewContext` PagePreviewContext

PathConfiguration

`path` String
`pathTranslations` Array of String

ProjectContext

`environment` Environment	Indicates whether the project is intended as production or development environment.
`locales` Array of Locale	Locales that can be used in the project.
`defaultLocale` Locale	Locale used by default in the project.

RedirectResponse

`statusCode` Float
`reason` String	Can be `"locale mismatch"`, `"redirect exists for path"`, or `"dynamic page redirect"`
`targetType` String	Can be `"page folder"`, `"link"`, or `"unknown"`
`target` String

Sections

`head` Head
`main` Main
`footer` Footer

Tastic

`tasticId` String
`tasticType` String
`configuration` TasticConfiguration

TasticConfiguration

`desktop` Boolean
`mobile` Boolean
`tablet` Boolean

ViewData

dataSources

DataSources

Data sources configured for the page folder and referenced in the page. They are indexed by data source identifier.

Type representations

Representations.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

DataSourceConfiguration.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

DataSourceResponse.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

DataSources.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Environment.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Error.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Footer.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Head.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

LayoutElement.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

LayoutElementConfiguration.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Locale.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Main.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Page.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

PageDataResponse.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

PageFolder.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

PagePreviewContext.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

PagePreviewDataResponse.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

PathConfiguration.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ProjectContext.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

RedirectResponse.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Sections.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Tastic.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

TasticConfiguration.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ViewData.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Representations

DataSourceConfiguration

DataSourceResponse

DataSources

Environment

Error

Footer

Head

LayoutElement

LayoutElementConfiguration

Locale

Main

Page

PageDataResponse

PageFolder

PagePreviewContext

PagePreviewDataResponse

PathConfiguration

ProjectContext

RedirectResponse

Sections

Tastic

TasticConfiguration

ViewData