This is the early access documentation preview for Custom Views. This documentation might not be in sync with our official documentation.

Type representations

Common API Types used within multiple API resources.

Representations

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
layoutElements
Array of LayoutElement

LayoutElement

layoutElementId
String
configuration
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
state
String

PageDataResponse

pageFolder
page
Page
data

PageFolder

pageFolderId
String
isDynamic
Boolean
pageFolderType
String
configuration
Any
dataSourceConfigurations
name
String
ancestorIdsMaterializedPath
String
depth
Float
sort
Float

PagePreviewContext

customerName
String

PagePreviewDataResponse

pageFolder
page
Page
data
previewId
String
previewContext

PathConfiguration

path
String
pathTranslations
Array of String

ProjectContext

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 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

Tastic

tasticId
String
tasticType
String
configuration

TasticConfiguration

desktop
Boolean
mobile
Boolean
tablet
Boolean

ViewData

dataSources

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