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
Extension ID
bundle_name
string
Bundle name
organization_id
string
Organization ID
sections
array of object (ExtensionSection)
Sections
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
Status
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
Get extension sections
getExtensionSections
Global Sections Management API provides comprehensive tools for managing global sections within themes. These APIs enable platform users to create draft versions from approved global sections, allowing for safe editing and testing of global components that appear across multiple pages. The APIs handle concurrent access, draft creation, and status management to ensure consistency and reliability in theme global section workflows. This functionality is essential for managing global elements like headers, footers, navigation bars, and other shared components that need to maintain consistency across an entire application while allowing for controlled updates and modifications through a draft-approval process.
Operations
GET
# Create draft from approved global section
GET
# List global sections for a theme
PUT
# Update global section status (approve/reject)
POST
# Acquire lock for a global section
GET
# Get lock info for a global section
DEL
# Release lock for a global section
Creates a draft version of an approved global section for editing purposes. This endpoint checks if the global section is approved and creates a draft if one doesn't already exist. It handles concurrent access safely and returns the status of draft creation or existence.
Parameters
company_id
integer
Required
ID of the company that owns the application.
application_id
string
Required
ID of the application that contains the theme.
theme_id
string
Required
ID of the theme that contains the global section.
global_section_id
string
Required
ID of the global section to create draft from.
Response
200
Success. Returns the status of draft creation process with detailed information about whether a draft was created, already existed, or if the section doesn't require draft creation.
GlobalSectionDraftCreate
success
boolean
Indicates if the request was processed successfully
draft_exists
boolean
Whether a draft already existed for this approved section
draft_created
boolean
Whether a new draft was created during this request
draft_id
string
ID of the draft section (existing or newly created)
message
string
Descriptive message about the operation result
draft_section
object
Nullable
Draft section payload (returned when a draft exists/created)
Examples
Parameters
company_id:
123
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
global_section_id:
"647def456def789012345680"
Was this section helpful?
GET
Response
Create draft from approved global section
createDraftFromApprovedSection
Retrieves a paginated list of global sections for a specific theme with lock information for concurrent editing management. This endpoint provides comprehensive section data including status, configuration, and real-time lock status for collaborative editing.
Parameters
company_id
integer
Required
ID of the company that owns the application.
application_id
string
Required
ID of the application that contains the theme.
theme_id
string
Required
ID of the theme to list global sections for.
page_no
integer
| value >= 1
Page number for pagination (1-based).
Default Value : 1
page_size
integer
| value >= 1
| value <= 100
Number of items per page.
Default Value : 20
status
string
Filter global sections by status.
Enum
Response
200
Success. Returns a paginated list of global sections with lock information for collaborative editing management.
GlobalSectionList
success
boolean
Indicates if the request was successful
status_counts
object (GlobalSectionStatusCounts)
GlobalSectionStatusCounts
draft
integer
Number of sections in draft status
pending_for_approval
integer
Number of sections pending approval
approved
integer
Number of sections approved
rejected
integer
Number of sections rejected
all
integer
Total number of sections
page
integer
Current page number
page_size
integer
Number of items per page
total
integer
Total number of items
data
array of object (GlobalSection)
List of global sections for the current page
Array of GlobalSection
_id
string
Unique identifier of the global section
application_id
string
ID of the application this section belongs to
theme_id
string
ID of the theme this section belongs to
parent_id
string
Nullable
ID of the parent section (for draft sections)
section
object (GlobalSectionSectionUpdate)
GlobalSectionSectionUpdate
global_section_parent_reference
string
Nullable
Global reference of the parent section
global_reference
string
Global reference of the section
_id
string
Unique identifier of this section instance (string form, even if numeric-looking).
name
string
Internal section name used by the theme system (e.g., "hero-banner").
label
string
Human-readable section label shown in editors.
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.
blocks
array of object
Optional list of content blocks composing the section; structure is project-specific.
predicate
object (SectionPredicate)
SectionPredicate
screen
object (SectionScreenPredicate)
SectionScreenPredicate
mobile
boolean
Whether to enable on mobile screens.
desktop
boolean
Whether to enable on desktop screens.
tablet
boolean
Whether to enable on tablet screens.
user
object (SectionUserPredicate)
SectionUserPredicate
user_type
string
High-level audience bucket (e.g., "all_user").
Enum
user_groups
object (SectionUserGroups)
SectionUserGroups
l1
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
l2
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
route
object (SectionRoutePredicate)
SectionRoutePredicate
selected
string
Route selection mode (e.g., "none" to disable route constraint).
exact_url
string
Exact URL to match when `selected` is configured accordingly.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
platform
object (SectionPlatformPredicate)
SectionPlatformPredicate
ios
boolean
Whether to enable on iOS app.
android
boolean
Whether to enable on Android app.
web
boolean
Whether to enable on Web.
theme_zones
object (ThemeZones)
ThemeZones
type
string
Zone type (implementation-defined, e.g., "state", "zone_list", etc.).
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
experimental_features
array of string
Experimental features to enable on the section
schedule
array of object
Optional list of scheduling rules; empty array means always active.
status
string
Desired section status after the update. - draft: editable working copy - pending_for_approval: awaiting reviewer approval - approved: approved and ready to publish - rejected: rejected by reviewer
Enum
comment
string
Optional editorial note describing the change/reason.
updated_by
string
Identifier (email or username) of the actor performing this update.
__source
object (SourceMeta)
SourceMeta
type
string
Source type (e.g., "themeBundle").
id
string
Identifier of the source entity.
bundle_name
string
Human-readable bundle name if applicable.
created_at
string
| date-time
Timestamp when the section was created
updated_at
string
| date-time
Timestamp when the section was last updated
user
object (SectionUserPredicate)
SectionUserPredicate
user_type
string
High-level audience bucket (e.g., "all_user").
Enum
user_groups
object (SectionUserGroups)
SectionUserGroups
l1
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
l2
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
theme_zones
object (ThemeZones)
ThemeZones
type
string
Zone type (implementation-defined, e.g., "state", "zone_list", etc.).
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
schedule
array of object
Optional list of scheduling rules; empty array means always active.
__v
number
Version number of the section
is_deleted
boolean
Whether the section is deleted
default_sections
object
Default section configuration and schema
created_at
string
| date-time
Timestamp when the section was created
updated_at
string
| date-time
Timestamp when the section was last updated
lock_info
object (GlobalSectionLock)
GlobalSectionLock
user_id
string
Identifier of the user holding the lock
username
string
Username of the user holding the lock
locked_at
string
| date-time
When the lock was acquired
expires_at
string
| date-time
When the lock will expire
remaining_time_seconds
integer
Remaining lock time in seconds
application_id
string
Application id for context
theme_id
string
Theme id for context
global_section_id
string
Global section id for context
is_locked
boolean
Whether the section is currently locked
locked_by_username
string
Username of the user holding the lock
Examples
Parameters
company_id:
123
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
page_no:
1
page_size:
10
status:
"approved"
Was this section helpful?
GET
Response
List global sections for a theme
listGlobalSections
Approves or rejects a global section currently in pending_for_approval status. This route is protected by a lock check; if the section is locked by another user, the request is blocked. Allowed actions: approve, reject.
Parameters
company_id
integer
Required
ID of the company that owns the application.
application_id
string
Required
ID of the application that contains the theme.
theme_id
string
Required
ID of the theme the section belongs to.
global_section_id
string
Required
ID of the global section to update status for.
action
string
Required
Status action to apply.
Enum
Request body
comment
string
Optional comment to record with the status change.
Response
200
Status updated successfully
GlobalSection
_id
string
Unique identifier of the global section
application_id
string
ID of the application this section belongs to
theme_id
string
ID of the theme this section belongs to
parent_id
string
Nullable
ID of the parent section (for draft sections)
section
object (GlobalSectionSectionUpdate)
GlobalSectionSectionUpdate
global_section_parent_reference
string
Nullable
Global reference of the parent section
global_reference
string
Global reference of the section
_id
string
Unique identifier of this section instance (string form, even if numeric-looking).
name
string
Internal section name used by the theme system (e.g., "hero-banner").
label
string
Human-readable section label shown in editors.
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.
blocks
array of object
Optional list of content blocks composing the section; structure is project-specific.
predicate
object (SectionPredicate)
SectionPredicate
screen
object (SectionScreenPredicate)
SectionScreenPredicate
mobile
boolean
Whether to enable on mobile screens.
desktop
boolean
Whether to enable on desktop screens.
tablet
boolean
Whether to enable on tablet screens.
user
object (SectionUserPredicate)
SectionUserPredicate
user_type
string
High-level audience bucket (e.g., "all_user").
Enum
user_groups
object (SectionUserGroups)
SectionUserGroups
l1
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
l2
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
route
object (SectionRoutePredicate)
SectionRoutePredicate
selected
string
Route selection mode (e.g., "none" to disable route constraint).
exact_url
string
Exact URL to match when `selected` is configured accordingly.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
platform
object (SectionPlatformPredicate)
SectionPlatformPredicate
ios
boolean
Whether to enable on iOS app.
android
boolean
Whether to enable on Android app.
web
boolean
Whether to enable on Web.
theme_zones
object (ThemeZones)
ThemeZones
type
string
Zone type (implementation-defined, e.g., "state", "zone_list", etc.).
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
experimental_features
array of string
Experimental features to enable on the section
schedule
array of object
Optional list of scheduling rules; empty array means always active.
status
string
Desired section status after the update. - draft: editable working copy - pending_for_approval: awaiting reviewer approval - approved: approved and ready to publish - rejected: rejected by reviewer
Enum
comment
string
Optional editorial note describing the change/reason.
updated_by
string
Identifier (email or username) of the actor performing this update.
__source
object (SourceMeta)
SourceMeta
type
string
Source type (e.g., "themeBundle").
id
string
Identifier of the source entity.
bundle_name
string
Human-readable bundle name if applicable.
created_at
string
| date-time
Timestamp when the section was created
updated_at
string
| date-time
Timestamp when the section was last updated
user
object (SectionUserPredicate)
SectionUserPredicate
user_type
string
High-level audience bucket (e.g., "all_user").
Enum
user_groups
object (SectionUserGroups)
SectionUserGroups
l1
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
l2
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
theme_zones
object (ThemeZones)
ThemeZones
type
string
Zone type (implementation-defined, e.g., "state", "zone_list", etc.).
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
schedule
array of object
Optional list of scheduling rules; empty array means always active.
__v
number
Version number of the section
is_deleted
boolean
Whether the section is deleted
default_sections
object
Default section configuration and schema
created_at
string
| date-time
Timestamp when the section was created
updated_at
string
| date-time
Timestamp when the section was last updated
lock_info
object (GlobalSectionLock)
GlobalSectionLock
user_id
string
Identifier of the user holding the lock
username
string
Username of the user holding the lock
locked_at
string
| date-time
When the lock was acquired
expires_at
string
| date-time
When the lock will expire
remaining_time_seconds
integer
Remaining lock time in seconds
application_id
string
Application id for context
theme_id
string
Theme id for context
global_section_id
string
Global section id for context
is_locked
boolean
Whether the section is currently locked
locked_by_username
string
Username of the user holding the lock
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
global_section_id:
"647abc789abc123456789016"
action:
"approve"
body:
body
Was this section helpful?
PUT
Response
Update global section status (approve/reject)
updateGlobalSectionStatus
Acquires an exclusive edit lock on a global section for the authenticated user. If the section is already locked by another user, the request returns success=false along with the current lock holder details. Locks auto-expire after a TTL.
Parameters
company_id
integer
Required
ID of the company that owns the application.
application_id
string
Required
ID of the application that contains the theme.
theme_id
string
Required
ID of the theme the section belongs to.
global_section_id
string
Required
ID of the global section to lock.
Response
200
Lock acquisition result
GlobalSectionLockInfo
success
boolean
Indicates if the operation succeeded
is_locked
boolean
Whether the section is currently locked
lock
object (GlobalSectionLock)
GlobalSectionLock
user_id
string
Identifier of the user holding the lock
username
string
Username of the user holding the lock
locked_at
string
| date-time
When the lock was acquired
expires_at
string
| date-time
When the lock will expire
remaining_time_seconds
integer
Remaining lock time in seconds
application_id
string
Application id for context
theme_id
string
Theme id for context
global_section_id
string
Global section id for context
is_locked
boolean
Whether the section is currently locked
locked_by_username
string
Username of the user holding the lock
message
string
Optional message about the lock state
Examples
Parameters
company_id:
123
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
global_section_id:
"647abc789abc123456789012"
Was this section helpful?
POST
Response
Acquire lock for a global section
acquireGlobalSectionLock
Returns the current lock status for a global section. This is a read-only endpoint and does not acquire or release locks. If a lock exists, the lock metadata is returned along with remaining TTL.
Parameters
company_id
integer
Required
ID of the company that owns the application.
application_id
string
Required
ID of the application that contains the theme.
theme_id
string
Required
ID of the theme the section belongs to.
global_section_id
string
Required
ID of the global section to check lock information for.
Response
200
Current lock status for the section
GlobalSectionLockInfo
success
boolean
Indicates if the operation succeeded
is_locked
boolean
Whether the section is currently locked
lock
object (GlobalSectionLock)
GlobalSectionLock
user_id
string
Identifier of the user holding the lock
username
string
Username of the user holding the lock
locked_at
string
| date-time
When the lock was acquired
expires_at
string
| date-time
When the lock will expire
remaining_time_seconds
integer
Remaining lock time in seconds
application_id
string
Application id for context
theme_id
string
Theme id for context
global_section_id
string
Global section id for context
is_locked
boolean
Whether the section is currently locked
locked_by_username
string
Username of the user holding the lock
message
string
Optional message about the lock state
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
global_section_id:
"647abc789abc123456789012"
Was this section helpful?
GET
Response
Get lock info for a global section
getGlobalSectionLockInfo
Releases an existing edit lock on a global section for the authenticated user. - If no lock exists, a success response is returned. - If the lock exists but is owned by a different user, the request fails with success=false.
Parameters
company_id
integer
Required
ID of the company that owns the application.
application_id
string
Required
ID of the application that contains the theme.
theme_id
string
Required
ID of the theme the section belongs to.
global_section_id
string
Required
ID of the global section whose lock should be released.
Response
200
Lock release result
GlobalSectionLockInfoRelease
success
boolean
Whether the lock was released successfully.
message
string
result message.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
global_section_id:
"647abc789abc123456789012"
Was this section helpful?
DEL
Response
Release lock for a global section
releaseGlobalSectionLock
Page Mapper is a feature which enables to dynamically set different page content on a single slug based on various attributes such as user, schedule and theme zones
Operations
GET
# Get Page Mapper Configuration
PUT
# Update Page Mapper Configuration
Retrieve the page mapper configuration for a specific application within a company.
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
ID of the application within the business account.
Response
200
Success. Page Mapper information returned.
PageMapperSchema
_id
string
Unique identifier for the resource
application_id
string
Identifier of the application to which this resource belongs
created_at
string
| date-time
Timestamp when the resource was created
enabled
boolean
Flag indicating whether the resource is enabled or disabled
updated_at
string
| date-time
Timestamp when the resource was last updated
Examples
Parameters
company_id:
"1"
application_id:
"66500a1f0e79b842c8f17c21"
Was this section helpful?
GET
Response
Get Page Mapper Configuration
getPageMapperConfig
Update the `enabled` status of the page mapper for a specific application.
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
ID of the application within the business account.
Request body
enabled
boolean
Required
Whether the Page Mapper is enabled or disabled
Response
200
Success. Updated Page Mapper info returned.
PageMapperSchema
_id
string
Unique identifier for the resource
application_id
string
Identifier of the application to which this resource belongs
created_at
string
| date-time
Timestamp when the resource was created
enabled
boolean
Flag indicating whether the resource is enabled or disabled
updated_at
string
| date-time
Timestamp when the resource was last updated
Examples
Parameters
company_id:
"1"
application_id:
"66500a2a7b442d2e7a9a9e14"
body:
body
Was this section helpful?
PUT
Response
Update Page Mapper Configuration
updatePageMapperConfig
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
List theme fonts
getFontsV2
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
Global sections associated with 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
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
Type of the Theme
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
Update theme name
updateThemeName
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
Global sections associated with 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
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
Type of the Theme
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
Get Create theme
createTheme
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
Global sections associated with 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
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
Type of the Theme
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
Get applied theme
getAppliedTheme
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)
Carousel items
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)
Features
Array of Feature
category
string
Feature category
list
array of object (FeatureItem)
Features
Array of FeatureItem
label
string
Feature properties
description
string
Feature description
highlights
array of object (Highlight)
Highlights
Array of Highlight
title
string
Highlight title
description
string
Highlight description
image
string
Highlight image URL
variations
array of object (Variation)
Variations
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
Get latest version of theme by slug.
getLatestVersionOfThemeBySlug
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
POST
# Create a Page Mapping
PUT
# Update a Page Mapping
DEL
# Delete a Page Mapping
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
Request body
fallback
string
Nullable
page
string
slug
string
filter
object (PageMapperFilterConfiguration)
PageMapperFilterConfiguration
platform
object (PageMapperPlatformFilter)
PageMapperPlatformFilter
ios
boolean
android
boolean
web
boolean
user
object (PageMapperUserFilter)
PageMapperUserFilter
user_type
string
Enum
schedule
object (PageMapperScheduleFilter)
PageMapperScheduleFilter
start
string
| date-time
end
string
| date-time
feature_store
string
Nullable
Featured store where page is supposed to be mapped
Response
200
400
Success
PageMapperResponseSchema
message
string
Message indicating the result of the page mapping operation
Examples
Parameters
company_id:
882
application_id:
"6640f9f1e5e7a7a654e2a8d2"
body:
body
Was this section helpful?
POST
Response
Create a Page Mapping
createPageMapping
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
page_value
string
Required
Value of Page
Request body
fallback
string
Nullable
slug
string
filter
object (PageMapperFilterConfiguration)
PageMapperFilterConfiguration
platform
object (PageMapperPlatformFilter)
PageMapperPlatformFilter
ios
boolean
android
boolean
web
boolean
user
object (PageMapperUserFilter)
PageMapperUserFilter
user_type
string
Enum
schedule
object (PageMapperScheduleFilter)
PageMapperScheduleFilter
start
string
| date-time
end
string
| date-time
feature_store
string
Nullable
Featured store where page is supposed to be mapped
Response
200
400
Success
PageMapperResponseSchema
message
string
Message indicating the result of the page mapping operation
Examples
Parameters
company_id:
882
application_id:
"6640f9f1e5e7a7a654e2a8d2"
page_value:
"to-modify-page-for-page-mapping-1750065503244"
body:
body
Was this section helpful?
PUT
Response
Update a Page Mapping
updatePageMapping
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
page_value
string
Required
Value of Page
Response
200
400
Success
PageMapperResponseSchema
message
string
Message indicating the result of the page mapping operation
Examples
Parameters
company_id:
882
application_id:
"6640f9f1e5e7a7a654e2a8d2"
page_value:
"to-delete-page-for-page-mapping"
Was this section helpful?
DEL
Response