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:
"6399ba8924ab1be7c21314b5"
type:
"react"
company_mode:
"live"
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
GET
# List theme fonts
PATCH
# Update theme name
POST
# Get Create theme
GET
# Get applied theme
GET
# Get latest version of theme by slug.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Response
200
Success. Refer `FontsSchema` for more details.
FontsSchema
items
array of object
kind
string
Examples
Parameters
company_id:
123
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
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
400
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
preset
object
An Object of default theme configurations
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
global_sections
array of object
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
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.
label
string
Label for the section
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
applied_themes
array of object
Applied themes array
Examples
Parameters
company_id:
123
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
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
Request body
marketplace_theme_id
string
Theme id of the marketplace
Response
200
Successfully fetch the create 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
preset
object
An Object of default theme configurations
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
global_sections
array of object
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
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.
label
string
Label for the section
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
applied_themes
array of object
Applied themes array
Examples
Parameters
company_id:
19243
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
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
preset
object
An Object of default theme configurations
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
global_sections
array of object
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
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.
label
string
Label for the section
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
applied_themes
array of object
Applied themes array
Examples
Parameters
company_id:
19243
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Parameters
application_id
string
Required
The ID of the application
company_id
integer
Required
The ID of the company
slug_name
string
Required
Slug of theme
Response
200
Successful operation
Array of MarketplaceTheme
_id
string
Theme ID
payment
object (PaymentInfo)
PaymentInfo
is_paid
boolean
Indicates if the theme is paid
amount
number
Amount of payment
contact
object (ContactInfo)
ContactInfo
developer_contact
array of string
Developer contact information
seller_contact
string
Seller contact information
industry
array of string
Industries the theme is suitable for
is_update
boolean
Indicates if the theme is an update
is_default
boolean
Indicates if the theme is a default theme
name
string
Theme name
tagline
string
Theme tagline
description
string
Theme description
catalog_size
object (CatalogSize)
CatalogSize
min
integer
Minimum catalog size
max
integer
Maximum catalog size
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
desktop
string
Desktop theme image URL
mobile
string
Mobile theme image URL
carousel
array of object (CarouselItem)
Array of CarouselItem
desktop
string
Desktop carousel image URL
mobile
string
Mobile carousel image URL
src
string
Theme source URL
explore
object (ExploreInfo)
ExploreInfo
title
string
Explore feature title
description
string
Explore feature description
features
array of object (Feature)
Array of Feature
category
string
Feature category
list
array of object (FeatureItem)
Array of FeatureItem
label
string
Feature properties
description
string
Feature description
highlights
array of object (Highlight)
Array of Highlight
title
string
Highlight title
description
string
Highlight description
image
string
Highlight image URL
variations
array of object (Variation)
Array of Variation
name
string
Variation name
color
string
Variation color
demo_url
string
Variation demo URL
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
desktop
string
Desktop theme image URL
mobile
string
Mobile theme image URL
documentation
object (Documentation)
Documentation
notes
string
Documentation notes
url
string
Documentation URL
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Comments
developer_remark
string
Developer remark
reviewer_feedback
string
Reviewer feedback
release
object (Release)
Release
notes
string
The release notes of the theme
version
string
The version of the theme
slug
string
Theme slug
organization_id
string
Organization ID
user_id
string
User ID
created_at
string
| date-time
Theme creation timestamp
updated_at
string
| date-time
Theme update timestamp
template_theme_id
string
Template theme ID
theme_type
string
Theme type
Examples
Parameters
application_id:
"000000000000000000000001"
company_id:
123
slug_name:
"astra"
Was this section helpful?
GET
Response