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.
Extension Section
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
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
assets
object (AssetsExtension)
AssetsExtension
status
string
type
string
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
companyId:
1
applicationId:
"value"
type:
"value"
companyMode:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get extension sections
getExtensionSections
Sales Channel Theme
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
PATCH
Update theme name
Modify the name of the draft theme by theme Id.
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
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
src
string
Examples
Parameters
body:
body
Was this section helpful?
PATCH
Loading...
Response
Example not available.
Update theme name
updateThemeName
GET
Get applied theme
Retrieve the currently applied theme of a sales channel using application Id.
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
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
src
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example not available.