Theme
Responsible for partner theme submission
Operations
POST
# Create a new theme
Themes improve the look and appearance of a website. Use this API to create a theme.
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
organization_id
string
Required
Organization ID
Request body
name
string
Required
The name of the theme
available_sections
array of object (SectionItem)
Required
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
version
string
Required
The version of the theme
theme_type
string
Required
Type of the Theme
Enum
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.
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.
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.
value
string
The value of the page.
current
string
The current configuration
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.
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.
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.
value
string
The value of the page.
Response
200
4XX
5XX
Returns the new application theme details
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.
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.
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.
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 paid or not
amount
number
The amount of 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
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
company_id:
1
application_id:
"value"
organization_id:
"value"
body:
body
Was this section helpful?
POST
Response
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
POST
# Draft extension section
POST
# Publish an extension section
POST
# Start a Preview of Extension Section
DEL
# Close a Preview of Extension Section
Create a new draft for an extension section within the specified organization.
Parameters
organization_id
string
Required
Organization ID
extension_id
string
Required
Extension ID
Request body
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
type
string
status
string
Response
200
Success. Returns the created draft extension section.
ExtensionSectionDraft
sections
object (Sections)
Sections
acknowledged
boolean
matched_count
integer
modified_count
integer
upserted_id
string
upserted_count
integer
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Publish a draft extension section within the specified organization.
Parameters
organization_id
string
Required
Organization ID
extension_id
string
Required
Extension ID
Request body
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
type
string
status
string
Response
200
Success. The extension section has been published.
ExtensionSectionPublish
sections
object (Sections)
Sections
acknowledged
boolean
matched_count
integer
modified_count
integer
upserted_id
string
upserted_count
integer
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Use this API to start a local session for previewing the extension section binding.
Parameters
organization_id
string
Required
Organization ID
extension_section_id
string
Required
Extension Section ID
Request body
application_id
string
Application ID
section_preview_hash
string
Hash for the section preview
Response
200
Returns the preview details
ExtensionPreview
message
string
Examples
Parameters
organization_id:
"value"
extension_section_id:
"value"
body:
body
Was this section helpful?
POST
Response
Use this API to close a local session for previewing the extension section binding
Parameters
organization_id
string
Required
Organization ID
extension_section_id
string
Required
Extension Section ID
Request body
application_id
string
Application ID
section_preview_hash
string
Hash for the section preview
Response
200
Returns the deletion status
ExtensionPreview
message
string
Examples
Parameters
organization_id:
"value"
extension_section_id:
"value"
body:
body
Was this section helpful?
DEL
Response
Operations
GET
# Get all pages
POST
# Create page
PUT
# Update multiple pages
GET
# Get page
PUT
# Update page
DEL
# Delete page
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
theme_id
string
Required
ID of the theme to be retrieved
organization_id
string
Required
Organization ID
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
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
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?
GET
Response
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
theme_id
string
Required
ID of the theme
organization_id
string
Required
Organization ID
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
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 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
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?
POST
Response
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
theme_id
string
Required
ID of the theme to be retrieved
organization_id
string
Required
Organization ID
Request body
pages
array of object (AvailablePageSchema)
Array of 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
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 an array all the pages of the theme. Refer `AllAvailablePageSchema` for more details.
AllAvailablePageSchema
pages
array of object (AvailablePageSchema)
Array of 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
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
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
theme_id
string
Required
ID of the theme to be retrieved
page_value
string
Required
Value of the page to be retrieved
organization_id
string
Required
Organization ID
Response
200
4XX
5XX
Success. Returns an object of the page. 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
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?
GET
Response
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
organization_id
string
Required
Organization ID
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
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
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
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
organization_id
string
Required
Organization ID
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
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?
DEL
Response
Oversee themes in your application through the CLI. This includes obtaining application themes, retrieving theme details by ID, updating themes, deleting themes, accessing organization themes, retrieving organization theme details, managing draft themes, submitting organization themes, accessing theme versions, and more.
Operations
GET
# Get application themes
GET
# Get theme by ID
PUT
# Update theme
DEL
# Delete theme
GET
# Get organization themes
GET
# Get organization theme details
PATCH
# Update draft theme
PUT
# Submit organization theme
DEL
# Delete organization theme
GET
# Get latest version of theme by slug
POST
# Create new theme in organization
GET
# Get theme rejection reasons
GET
# Get theme versions
Parameters
company_id
integer
Required
The ID of the company
application_id
string
Required
The ID of the application
organization_id
string
Required
Organization ID
Response
200
The list of themes for the application was fetched successfully.
Array of 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.
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.
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.
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 paid or not
amount
number
The amount of 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
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
company_id:
19243
application_id:
"6487ea376e1442284917c44e"
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
organization_id
string
Required
Organization ID
Response
200
The Details of themes for the application was fetched 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.
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.
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.
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 paid or not
amount
number
The amount of 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
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
company_id:
1
application_id:
"value"
theme_id:
"value"
organization_id:
"value"
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.
organization_id
string
Required
Organization ID
Request body
config
object (Config)
Config
current
string
Required
The current configuration
list
array of object (ThemeConfiguration)
Required
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.
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.
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.
value
string
The value of the page.
font
object (Font)
Font
variants
object (FontVariants)
Required
FontVariants
light
object (FontVariant)
FontVariant
name
string
Required
The name of the font variant
file
string
Required
The URL of the font file
regular
object (FontVariant)
FontVariant
name
string
Required
The name of the font variant
file
string
Required
The URL of the font file
medium
object (FontVariant)
FontVariant
name
string
Required
The name of the font variant
file
string
Required
The URL of the font file
semi_bold
object (FontVariant)
FontVariant
name
string
Required
The name of the font variant
file
string
Required
The URL of the font file
bold
object (FontVariant)
FontVariant
name
string
Required
The name of the font variant
file
string
Required
The URL of the font file
family
string
Required
The font family
Response
200
Theme 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.
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.
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.
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 paid or not
amount
number
The amount of 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
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?
PUT
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 deleted.
organization_id
string
Required
Organization ID
Response
200
Theme successfully deleted.
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.
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.
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.
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 paid or not
amount
number
The amount of 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
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?
DEL
Response
Parameters
organization_id
string
Required
Id of your organization
status
string
The status of the theme
Enum
page_size
integer
Number of themes per page
page_no
integer
Page number to retrieve
Response
200
Successful operation
MarketplaceThemeSchema
themes
array of object (MarketplaceTheme)
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 label
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
page
object (PaginationSchema)
PaginationSchema
size
integer
item_total
integer
has_next
boolean
type
string
current
integer
Examples
Parameters
organization_id:
"value"
status:
"value"
page_size:
1
page_no:
1
Was this section helpful?
GET
Response
Obtain detailed information about a theme within partner server organizations.
Parameters
organization_id
string
Required
The ID of the organization
theme_id
string
Required
The ID of the theme
Response
200
Successful response
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 label
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
Examples
Parameters
organization_id:
"value"
theme_id:
"value"
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
The ID of the organization
theme_id
string
Required
The ID of the theme
Request body
_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 label
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
Response
200
Theme updated successfully
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 label
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
Examples
Parameters
body:
body
Was this section helpful?
PATCH
Response
Initiate the process of submitting a theme within partner server organizations.
Parameters
organization_id
string
Required
The ID of the organization
theme_id
string
Required
The ID of the theme
Request body
_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 label
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
Response
200
Theme updated successfully
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 label
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
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Response
Parameters
organization_id
string
Required
The ID of the organization
theme_id
string
Required
The ID of the theme
Response
200
Successful deletion of the theme
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 label
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
Examples
Parameters
organization_id:
"value"
theme_id:
"value"
Was this section helpful?
DEL
Response
Parameters
organization_id
string
Required
The ID of the organization
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 label
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
Examples
Parameters
organization_id:
"value"
slug_name:
"value"
Was this section helpful?
GET
Response
Parameters
organization_id
string
Required
The ID of the organization
slug
string
The slug of the theme.
Request body
_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 label
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
Response
200
Theme updated successfully
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 label
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
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
Retrieve reasons for the rejection of themes within partner server organizations.
Parameters
organization_id
string
Required
The ID of the organization
theme_id
string
Required
The ID of the theme
Response
200
Theme rejection reasons retrieved successfully
ThemeRejectionReasons
_id
string
The ID of the theme rejection reasons object
message
string
A general message about the rejection reasons
theme_id
string
The ID of the rejected theme
organization_id
string
The ID of the organization
admin_id
string
The ID of the admin who rejected the theme
user_id
string
The ID of the user who submitted the theme
status
string
The status of the theme (e.g., rejected)
rejection_reasons
object (RejectedMessages)
RejectedMessages
theme_file
object (ThemeReviewRequestMessage)
ThemeReviewRequestMessage
message
string
Message Explaining what the issue is
theme_details
object (ThemeReviewRequestMessage)
ThemeReviewRequestMessage
message
string
Message Explaining what the issue is
theme_value_proposition
object (ThemeReviewRequestMessage)
ThemeReviewRequestMessage
message
string
Message Explaining what the issue is
theme_attributes
object (ThemeReviewRequestMessage)
ThemeReviewRequestMessage
message
string
Message Explaining what the issue is
theme_variations
object (ThemeReviewRequestMessage)
ThemeReviewRequestMessage
message
string
Message Explaining what the issue is
theme_docs
object (ThemeReviewRequestMessage)
ThemeReviewRequestMessage
message
string
Message Explaining what the issue is
theme_review
object (ThemeReviewRequestMessage)
ThemeReviewRequestMessage
message
string
Message Explaining what the issue is
created_at
string
| date-time
The date and time when the theme rejection reasons object was created
updated_at
string
| date-time
The date and time when the theme rejection reasons object was last updated
Examples
Parameters
organization_id:
"value"
theme_id:
"value"
Was this section helpful?
GET
Response
Retrieve a list of versions available for a theme within partner server organizations.
Parameters
organization_id
string
Required
The ID of the organization.
theme_slug
string
Required
The slug of the theme.
page_size
integer
The number of items to return per page.
page_no
integer
The page number to return.
Response
200
Successful operation.
MarketplaceThemeSchema
themes
array of object (MarketplaceTheme)
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 label
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
page
object (PaginationSchema)
PaginationSchema
size
integer
item_total
integer
has_next
boolean
type
string
current
integer
Examples
Parameters
organization_id:
"value"
theme_slug:
"value"
page_size:
1
page_no:
1
Was this section helpful?
GET
Response