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.
Oversee the extension sections in your application through the CLI. This includes obtaining draft extension sections, publishing extension sections, retrieving sections of extensions, and more.
Operations
GET
# Get extension sections
Retrieve the list of extension sections for a given application in the specified company.
Parameters
company_id
integer
Required
The ID of the company
application_id
string
Required
The ID of the application
type
string
The type of the theme
company_mode
string
The mode of the company
Response
200
Successfully retrieved the list of extension sections.
Array of GetExtensionSectionRes
extension_id
string
bundle_name
string
organization_id
string
sections
array of object (ExtensionSection)
Array of ExtensionSection
label
string
name
string
props
array of object (PropExtension)
Array of PropExtension
id
string
label
string
type
string
info
string
blocks
array of object
assets
object (AssetsExtension)
AssetsExtension
js
string
css
string
status
string
type
string
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
company_id:
1
application_id:
"value"
type:
"value"
company_mode:
"value"
Was this section helpful?
GET
Response
Theme API 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
PATCH
# Update theme name
GET
# Get applied theme
Parameters
company_id
integer
Required
The ID of the company.
application_id
string
Required
The ID of the application.
theme_id
string
Required
The ID of the theme to be updated.
Request body
name
string
The new name of the theme.
Response
200
Theme name updated successfully.
ThemesSchema
font
object (Font)
Font
variants
object (FontVariants)
FontVariants
light
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
regular
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
medium
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
semi_bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
family
string
The font family
config
object (Config)
Config
current
string
The current configuration
list
array of object (ThemeConfiguration)
A list of configurations
Array of ThemeConfiguration
name
string
The name of the configuration
global_config
object
page
array of object (ThemeConfigListPage)
An array of pages
Array of ThemeConfigListPage
page
string
Name of the page
settings
object (ThemeConfigListPageSettingsProps)
ThemeConfigListPageSettingsProps
props
object
global_schema
object (GlobalSchema)
GlobalSchema
props
array of object (Prop)
Array of Prop
type
string
The type of the property
category
string
The category of the property
value
string
The value of the property
id
string
The ID of the property
label
string
The label of the property
info
string
Additional information about the property
preset
object (Preset)
Preset
pages
array of object (Page)
Array of Page
sections
array of object (Section)
Array of Section
blocks
array of object (Block)
Array of Block
type
string
The type of the block.
name
string
The name of the block.
props
object (BlockProps)
BlockProps
image
object (ImagePickerProp)
ImagePickerProp
type
string
The type of the property.
value
string
The value of the image picker property.
slide_link
object (UrlProp)
UrlProp
type
string
The type of the property.
value
string
The value of the URL property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
predicate
object (Predicate)
Predicate
screen
object (Screen)
Screen
mobile
boolean
True if the screen is a mobile device.
desktop
boolean
True if the screen is a desktop device.
tablet
boolean
True if the screen is a tablet device.
user
object (ThemeUserSchema)
ThemeUserSchema
authenticated
boolean
True if the user is authenticated.
anonymous
boolean
True if the user is anonymous.
route
object (Route)
Route
selected
string
The selected route.
exact_url
string
The exact URL of the route.
name
string
The name of the section.
props
object (SectionProps)
SectionProps
title
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
item_margin
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
autoplay
object (CheckboxProp)
CheckboxProp
value
boolean
The value of the checkbox property.
type
string
The type of the property.
slide_interval
object (RangeProp)
RangeProp
value
integer
The value of the range property.
type
string
The type of the property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
preset
object (SectionPreset)
SectionPreset
blocks
array of object (Block)
Array of Block
type
string
The type of the block.
name
string
The name of the block.
props
object (BlockProps)
BlockProps
image
object (ImagePickerProp)
ImagePickerProp
type
string
The type of the property.
value
string
The value of the image picker property.
slide_link
object (UrlProp)
UrlProp
type
string
The type of the property.
value
string
The value of the URL property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
value
string
The value of the page.
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
payment
object (ThemePayment)
ThemePayment
is_paid
boolean
Whether the theme is a paid theme.
amount
number
The amount to be paid for the theme.
description
string
The description of the theme
industry
array of string
An array of industries associated with the theme
release
object (Release)
Release
notes
string
The release notes of the theme
version
string
The version of the theme
images
object (Images)
Images
desktop
string
The URL of the desktop image
mobile
string
The URL of the mobile image
slug
string
The slug of the theme
name
string
The name of the theme
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
| date-time
The creation timestamp of the theme
updated_at
string
| date-time
The last update timestamp of the theme
assets
object (Assets)
Assets
umd_js
object (UMDJs)
UMDJs
link
string
links
array of string
An array of pages
common_js
object (CommonJS)
CommonJS
link
string
css
object (CSS)
CSS
link
string
links
array of string
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
props
array of Undefined Type
blocks
array of Undefined Type
Blocks
name
string
Name of the section
label
string
Label for the section
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
Examples
Parameters
body:
body
Was this section helpful?
PATCH
Response
Parameters
company_id
integer
Required
The ID of the company
application_id
string
Required
The ID of the application
Response
200
Successfully fetch the applied theme
ThemesSchema
font
object (Font)
Font
variants
object (FontVariants)
FontVariants
light
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
regular
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
medium
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
semi_bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
family
string
The font family
config
object (Config)
Config
current
string
The current configuration
list
array of object (ThemeConfiguration)
A list of configurations
Array of ThemeConfiguration
name
string
The name of the configuration
global_config
object
page
array of object (ThemeConfigListPage)
An array of pages
Array of ThemeConfigListPage
page
string
Name of the page
settings
object (ThemeConfigListPageSettingsProps)
ThemeConfigListPageSettingsProps
props
object
global_schema
object (GlobalSchema)
GlobalSchema
props
array of object (Prop)
Array of Prop
type
string
The type of the property
category
string
The category of the property
value
string
The value of the property
id
string
The ID of the property
label
string
The label of the property
info
string
Additional information about the property
preset
object (Preset)
Preset
pages
array of object (Page)
Array of Page
sections
array of object (Section)
Array of Section
blocks
array of object (Block)
Array of Block
type
string
The type of the block.
name
string
The name of the block.
props
object (BlockProps)
BlockProps
image
object (ImagePickerProp)
ImagePickerProp
type
string
The type of the property.
value
string
The value of the image picker property.
slide_link
object (UrlProp)
UrlProp
type
string
The type of the property.
value
string
The value of the URL property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
predicate
object (Predicate)
Predicate
screen
object (Screen)
Screen
mobile
boolean
True if the screen is a mobile device.
desktop
boolean
True if the screen is a desktop device.
tablet
boolean
True if the screen is a tablet device.
user
object (ThemeUserSchema)
ThemeUserSchema
authenticated
boolean
True if the user is authenticated.
anonymous
boolean
True if the user is anonymous.
route
object (Route)
Route
selected
string
The selected route.
exact_url
string
The exact URL of the route.
name
string
The name of the section.
props
object (SectionProps)
SectionProps
title
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
item_margin
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
autoplay
object (CheckboxProp)
CheckboxProp
value
boolean
The value of the checkbox property.
type
string
The type of the property.
slide_interval
object (RangeProp)
RangeProp
value
integer
The value of the range property.
type
string
The type of the property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
preset
object (SectionPreset)
SectionPreset
blocks
array of object (Block)
Array of Block
type
string
The type of the block.
name
string
The name of the block.
props
object (BlockProps)
BlockProps
image
object (ImagePickerProp)
ImagePickerProp
type
string
The type of the property.
value
string
The value of the image picker property.
slide_link
object (UrlProp)
UrlProp
type
string
The type of the property.
value
string
The value of the URL property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
value
string
The value of the page.
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
payment
object (ThemePayment)
ThemePayment
is_paid
boolean
Whether the theme is a paid theme.
amount
number
The amount to be paid for the theme.
description
string
The description of the theme
industry
array of string
An array of industries associated with the theme
release
object (Release)
Release
notes
string
The release notes of the theme
version
string
The version of the theme
images
object (Images)
Images
desktop
string
The URL of the desktop image
mobile
string
The URL of the mobile image
slug
string
The slug of the theme
name
string
The name of the theme
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
| date-time
The creation timestamp of the theme
updated_at
string
| date-time
The last update timestamp of the theme
assets
object (Assets)
Assets
umd_js
object (UMDJs)
UMDJs
link
string
links
array of string
An array of pages
common_js
object (CommonJS)
CommonJS
link
string
css
object (CSS)
CSS
link
string
links
array of string
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
props
array of object
blocks
array of object
Blocks
name
string
Name of the section
label
string
Label for the section
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
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
PUT
# Update a page
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
theme_id
string
Required
ID of the theme
page_value
string
Required
Value of the page to be updated
socket_id
string
Required
Unique socket id for websocket
Request body
value
string
text
string
path
string
type
string
Enum
sections
array of object (AvailablePageSchemaSections)
Array of AvailablePageSchemaSections
name
string
label
string
props
object
blocks
array of object
preset
object
predicate
object (AvailablePagePredicate)
AvailablePagePredicate
screen
object (AvailablePageScreenPredicate)
AvailablePageScreenPredicate
mobile
boolean
desktop
boolean
tablet
boolean
user
object (AvailablePageUserPredicate)
AvailablePageUserPredicate
authenticated
boolean
anonymous
boolean
route
object (AvailablePageRoutePredicate)
AvailablePageRoutePredicate
selected
string
Enum
exact_url
string
query
object
schedule
object (AvailablePageSchedulePredicate)
AvailablePageSchedulePredicate
cron
string
start
string
| date-time
end
string
| date-time
platform
object (AvailablePagePlatformPredicate)
AvailablePagePlatformPredicate
ios
boolean
Section visibility on ios platform
android
boolean
Section visibility on android platform
web
boolean
Section visibility on web platform
zones
array of string
An array of zone ids associated with the section
__source
object (SectionSource)
SectionSource
id
string
The source id specifying the source of the section.
bundle_name
string
This is the extension binding name containing this section.
type
string
This is source type. It will either be themeBundle or extension.
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Array of AvailablePageSectionMetaAttributes
attributes
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
theme
string
seo
object (AvailablePageSeo)
AvailablePageSeo
title
string
description
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
_id
string
props
array of object
_id
string
created_at
string
| date-time
The creation timestamp of the page
updated_at
string
| date-time
The last update timestamp of the page
Response
200
4XX
5XX
Success. Returns a the page of the theme. Refer `AvailablePageSchema` for more details.
AvailablePageSchema
value
string
text
string
path
string
type
string
Enum
sections
array of object (AvailablePageSchemaSections)
Array of AvailablePageSchemaSections
name
string
label
string
props
object
blocks
array of object
preset
object
predicate
object (AvailablePagePredicate)
AvailablePagePredicate
screen
object (AvailablePageScreenPredicate)
AvailablePageScreenPredicate
mobile
boolean
desktop
boolean
tablet
boolean
user
object (AvailablePageUserPredicate)
AvailablePageUserPredicate
authenticated
boolean
anonymous
boolean
route
object (AvailablePageRoutePredicate)
AvailablePageRoutePredicate
selected
string
Enum
exact_url
string
query
object
schedule
object (AvailablePageSchedulePredicate)
AvailablePageSchedulePredicate
cron
string
start
string
| date-time
end
string
| date-time
platform
object (AvailablePagePlatformPredicate)
AvailablePagePlatformPredicate
ios
boolean
Section visibility on ios platform
android
boolean
Section visibility on android platform
web
boolean
Section visibility on web platform
zones
array of string
An array of zone ids associated with the section
__source
object (SectionSource)
SectionSource
id
string
The source id specifying the source of the section.
bundle_name
string
This is the extension binding name containing this section.
type
string
This is source type. It will either be themeBundle or extension.
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Array of AvailablePageSectionMetaAttributes
attributes
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
theme
string
seo
object (AvailablePageSeo)
AvailablePageSeo
title
string
description
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
_id
string
props
array of object
_id
string
created_at
string
| date-time
The creation timestamp of the page
updated_at
string
| date-time
The last update timestamp of the page
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Response