Skip to main content

Theme

The Theme module makes theme management more efficient and effective. It allows you to view all theme pages, obtain details about specific theme pages, check the current app theme, and preview and test themes before applying them live.

Sales Channel Theme

Theme provides a comprehensive set of tools to efficiently manage assets and global configurations for web themes. With these APIs, developers can seamlessly handle essential asset details such as JavaScript (JS) and CSS bundle URLs, along with image URLs, crucial for creating visually appealing themes. Moreover, the APIs empower sales channel users to contribute by adding data for global configurations, including color palettes and other theme global settings.

Operations
GET
/service/application/theme/v2.0/applied-theme
# Get applied theme
GET
/service/application/theme/v2.0/{theme_id}/preview
# Get theme for preview
GET

Get applied theme

Gets the theme configuration and template details of a theme applied to the application.
Parameters
No Parameters
Response
200
4XX
5XX
Success. Returns a JSON object of the theme. Check the example shown below or refer `ThemesSchema` for more details.
ThemesSchema
font
object (Font)
Font
config
object (Config)
Config
applied
boolean
Whether the theme has been applied or not
is_private
boolean
Whether the theme is private or not
tags
array of string
An array of tags associated with the theme
_id
string
The unique identifier of the theme
application_id
string
The ID of the application
marketplace_theme_id
string
The ID of the theme in the marketplace
meta
object (ThemeMeta)
ThemeMeta
name
string
The name of the theme
template_theme_id
string
The ID of the template theme
version
string
The version of the theme
styles
object
The styles associated with the theme
created_at
string
The creation timestamp of the theme
updated_at
string
The last update timestamp of the theme
assets
object (Assets)
Assets
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/theme/v2.0/applied-theme
Loading...
Response
Example response not available.
GET

Get theme for preview

Gets the theme configuration and template details of a theme by theme Id.
Parameters
themeId
string
Required
ID of the theme to be retrieved
Response
200
4XX
5XX
Success. Returns a JSON object of the theme. Check the example shown below or refer `ThemesSchema` for more details.
ThemesSchema
font
object (Font)
Font
config
object (Config)
Config
applied
boolean
Whether the theme has been applied or not
is_private
boolean
Whether the theme is private or not
tags
array of string
An array of tags associated with the theme
_id
string
The unique identifier of the theme
application_id
string
The ID of the application
marketplace_theme_id
string
The ID of the theme in the marketplace
meta
object (ThemeMeta)
ThemeMeta
name
string
The name of the theme
template_theme_id
string
The ID of the template theme
version
string
The version of the theme
styles
object
The styles associated with the theme
created_at
string
The creation timestamp of the theme
updated_at
string
The last update timestamp of the theme
assets
object (Assets)
Assets
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/theme/v2.0/{theme_id}/preview
Loading...
Response
Example response not available.

Theme Page

Theme Pages API is a tool for developers to efficiently create dynamic and customizable web pages across various platforms. It offers essential features such as section filtering based on criteria like delivery zones, time scheduler, and type of platforms, it enables developers to configure reusable sections with multiple elements using blocks, fostering creativity and flexibility in design. Moreover, it provides functionality for managing the SEO content of a page. For instance, developers can easily design a homepage with a featured products section and a promotional banner, customizing the content and layout as needed. They can implement filtering based on delivery zones and time scheduler to cater to specific audiences effectively. Ultimately, the UI Theme Pages API empowers developers to craft engaging and optimized user experiences that resonate across platforms.

Operations
GET
/service/application/theme/v1.0/{theme_id}/page
# List pages
GET
/service/application/theme/v1.0/{theme_id}/{page_value}
# Get theme page
GET

List pages

Get all page level configs, sections and SEO data of a theme
Parameters
themeId
string
Required
ID of the theme to be retrieved
Response
200
4XX
5XX
Success. Returns an array all the pages of the theme. Refer `AllAvailablePageSchema` for more details.
AllAvailablePageSchema
pages
array of object (AvailablePageSchema)
Array of AvailablePageSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/theme/v1.0/{theme_id}/page
Loading...
Response
Example response not available.
GET

Get theme page

Get page level configurations, applied sections and SEO data of a page by `page_value` received from list pages API
Parameters
themeId
string
Required
ID of the theme to be retrieved
pageValue
string
Required
Value of the page to be retrieved
filters
string
Filters on sections to be applied or not
company
integer
Company id of the application
Response
200
4XX
5XX
Success. Returns an object of the pages. Refer `AvailablePageSchema` for more details.
AvailablePageSchema
value
string
text
string
path
string
type
string
Enum
sections
array of object (AvailablePageSchemaSections)
Array of AvailablePageSchemaSections
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Array of AvailablePageSectionMetaAttributes
theme
string
seo
object (AvailablePageSeo)
AvailablePageSeo
props
array of object
_id
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/theme/v1.0/{theme_id}/{page_value}
Loading...
Response
Example response not available.