Theme
Responsible for partner theme submission
Default
Default
Operations
POST
# Create a new theme
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
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
global_schema
object (GlobalSchema)
GlobalSchema
preset
object (Preset)
Preset
current
string
The current configuration
pages
array of object (Page)
Array of Page
Response
200
4XX
5XX
Returns the new application theme details
ThemesSchema
font
object (Font)
Font
config
object (Config)
Config
applied
boolean
Whether the theme has been applied or not
is_private
boolean
Whether the theme is private or not
tags
array of string
An array of tags associated with the theme
_id
string
The unique identifier of the theme
application_id
string
The ID of the application
marketplace_theme_id
string
The ID of the theme in the marketplace
meta
object (ThemeMeta)
ThemeMeta
name
string
The name of the theme
template_theme_id
string
The ID of the template theme
version
string
The version of the theme
styles
object
The styles associated with the theme
created_at
string
The creation timestamp of the theme
updated_at
string
The last update timestamp of the theme
assets
object (Assets)
Assets
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
Examples
Parameters
companyId:
1
applicationId:
"value"
organizationId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create a new theme
createTheme
Extension Section
Oversee the extension sections in your application through the CLI. This includes obtaining draft extension sections, publishing extension sections, retrieving sections of extensions, and more.
Operations
POST
# Draft extension section
POST
# Publish an extension section
POST
# Start a Preview of Extension Section
DEL
# Close a Preview of Extension Section
POST
Draft 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
assets
object (AssetsExtension)
AssetsExtension
type
string
status
string
Response
200
Success. Returns the created draft extension section.
DraftExtensionSectionResponse
sections
object (SectionsResponse)
SectionsResponse
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Draft extension section
createExtensionSectionDraft
POST
Publish an extension section
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
assets
object (AssetsExtension)
AssetsExtension
type
string
status
string
Response
200
Success. The extension section has been published.
PublishExtensionSectionResponse
sections
object (SectionsResponse)
SectionsResponse
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Publish an extension section
publishExtensionSections
POST
Start a Preview of Extension Section
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
ExtensionPreviewResponse
message
string
Examples
Parameters
organizationId:
"value"
extensionSectionId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Start a Preview of Extension Section
applyExtensionPreview
DEL
Close a Preview of Extension Section
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
ExtensionPreviewResponse
message
string
Examples
Parameters
organizationId:
"value"
extensionSectionId:
"value"
body:
body
Was this section helpful?
DEL
Loading...
Response
Loading...
Close a Preview of Extension Section
removeExtensionPreview
Page Management
Page Management
Operations
GET
# Get all pages
POST
# Create page
PUT
# Update multiple pages
GET
# Get page
PUT
# Update page
DEL
# Delete page
GET
Get all pages
Retrieve a list of all pages available in the partner server setup.
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
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example not available.
Get all pages
getAllPages
POST
Create page
Add a new page to the partner server configurations.
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
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Array of AvailablePageSectionMetaAttributes
theme
string
seo
object (AvailablePageSeo)
AvailablePageSeo
props
array of object
_id
string
created_at
string
The creation timestamp of the page
updated_at
string
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
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Array of AvailablePageSectionMetaAttributes
theme
string
seo
object (AvailablePageSeo)
AvailablePageSeo
props
array of object
_id
string
created_at
string
The creation timestamp of the page
updated_at
string
The last update timestamp of the page
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Example not available.
Create page
createPage
PUT
Update multiple pages
Modify and update multiple pages in the partner server setup.
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
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
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Loading...
Response
Example not available.
Update multiple pages
updateMultiplePages
GET
Get page
Obtain detailed information about a specific page in the partner server.
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
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Array of AvailablePageSectionMetaAttributes
theme
string
seo
object (AvailablePageSeo)
AvailablePageSeo
props
array of object
_id
string
created_at
string
The creation timestamp of the page
updated_at
string
The last update timestamp of the page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example not available.
Get page
getPage
PUT
Update page
Modify and update information related to a specific page in the partner server.
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
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Array of AvailablePageSectionMetaAttributes
theme
string
seo
object (AvailablePageSeo)
AvailablePageSeo
props
array of object
_id
string
created_at
string
The creation timestamp of the page
updated_at
string
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
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Array of AvailablePageSectionMetaAttributes
theme
string
seo
object (AvailablePageSeo)
AvailablePageSeo
props
array of object
_id
string
created_at
string
The creation timestamp of the page
updated_at
string
The last update timestamp of the page
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Loading...
Response
Example not available.
Update page
updatePage
DEL
Delete page
Remove a page from the partner server configurations.
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
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Array of AvailablePageSectionMetaAttributes
theme
string
seo
object (AvailablePageSeo)
AvailablePageSeo
props
array of object
_id
string
created_at
string
The creation timestamp of the page
updated_at
string
The last update timestamp of the page
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Loading...
Response
Example not available.
Delete page
deletePage
Theme management
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
GET
Get application themes
Retrieve a list of themes available for the partner server application.
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
config
object (Config)
Config
applied
boolean
Whether the theme has been applied or not
is_private
boolean
Whether the theme is private or not
tags
array of string
An array of tags associated with the theme
_id
string
The unique identifier of the theme
application_id
string
The ID of the application
marketplace_theme_id
string
The ID of the theme in the marketplace
meta
object (ThemeMeta)
ThemeMeta
name
string
The name of the theme
template_theme_id
string
The ID of the template theme
version
string
The version of the theme
styles
object
The styles associated with the theme
created_at
string
The creation timestamp of the theme
updated_at
string
The last update timestamp of the theme
assets
object (Assets)
Assets
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
Examples
Parameters
companyId:
19243
applicationId:
"6487ea376e1442284917c44e"
Was this section helpful?
GET
Loading...
Response
Example not available.
Get application themes
getApplicationThemes
GET
Get theme by ID
Obtain detailed information about a theme using its unique ID.
Parameters
company_id
integer
Required
The ID of the company
application_id
string
Required
The ID of the application
theme_id
string
Required
The ID of the theme
organization_id
string
Required
Organization ID
Response
200
The Details of themes for the application was fetched successfully.
ThemesSchema
font
object (Font)
Font
config
object (Config)
Config
applied
boolean
Whether the theme has been applied or not
is_private
boolean
Whether the theme is private or not
tags
array of string
An array of tags associated with the theme
_id
string
The unique identifier of the theme
application_id
string
The ID of the application
marketplace_theme_id
string
The ID of the theme in the marketplace
meta
object (ThemeMeta)
ThemeMeta
name
string
The name of the theme
template_theme_id
string
The ID of the template theme
version
string
The version of the theme
styles
object
The styles associated with the theme
created_at
string
The creation timestamp of the theme
updated_at
string
The last update timestamp of the theme
assets
object (Assets)
Assets
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
Examples
Parameters
companyId:
1
applicationId:
"value"
themeId:
"value"
organizationId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get theme by ID
getThemeById
PUT
Update theme
Modify and update information related to a theme in the partner server.
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
font
object (Font)
Font
Response
200
Theme updated successfully
ThemesSchema
font
object (Font)
Font
config
object (Config)
Config
applied
boolean
Whether the theme has been applied or not
is_private
boolean
Whether the theme is private or not
tags
array of string
An array of tags associated with the theme
_id
string
The unique identifier of the theme
application_id
string
The ID of the application
marketplace_theme_id
string
The ID of the theme in the marketplace
meta
object (ThemeMeta)
ThemeMeta
name
string
The name of the theme
template_theme_id
string
The ID of the template theme
version
string
The version of the theme
styles
object
The styles associated with the theme
created_at
string
The creation timestamp of the theme
updated_at
string
The last update timestamp of the theme
assets
object (Assets)
Assets
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Loading...
Response
Example not available.
Update theme
updateTheme
DEL
Delete theme
Remove a theme from the partner server configurations.
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
config
object (Config)
Config
applied
boolean
Whether the theme has been applied or not
is_private
boolean
Whether the theme is private or not
tags
array of string
An array of tags associated with the theme
_id
string
The unique identifier of the theme
application_id
string
The ID of the application
marketplace_theme_id
string
The ID of the theme in the marketplace
meta
object (ThemeMeta)
ThemeMeta
name
string
The name of the theme
template_theme_id
string
The ID of the template theme
version
string
The version of the theme
styles
object
The styles associated with the theme
created_at
string
The creation timestamp of the theme
updated_at
string
The last update timestamp of the theme
assets
object (Assets)
Assets
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Loading...
Response
Example not available.
Delete theme
deleteTheme
GET
Get organization themes
Retrieve a list of themes associated with partner server organizations.
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
page
object (PaginationSchema)
PaginationSchema
Examples
Parameters
organizationId:
"value"
status:
"value"
pageSize:
1
pageNo:
1
Was this section helpful?
GET
Loading...
Response
Loading...
Get organization themes
getOrganizationThemes
GET
Get organization theme details
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
contact
object (ContactInfo)
ContactInfo
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
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
carousel
array of object (CarouselItem)
Array of CarouselItem
src
string
Theme source URL
explore
object (ExploreInfo)
ExploreInfo
features
array of object (Feature)
Array of Feature
highlights
array of object (Highlight)
Array of Highlight
variations
array of object (Variation)
Array of Variation
documentation
object (Documentation)
Documentation
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Comments
release
object (Release)
Release
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
organizationId:
"value"
themeId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get organization theme details
getOrganizationThemeDetails
PATCH
Update draft theme
Modify and update a draft theme in 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
contact
object (ContactInfo)
ContactInfo
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
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
carousel
array of object (CarouselItem)
Array of CarouselItem
src
string
Theme source URL
explore
object (ExploreInfo)
ExploreInfo
features
array of object (Feature)
Array of Feature
highlights
array of object (Highlight)
Array of Highlight
variations
array of object (Variation)
Array of Variation
documentation
object (Documentation)
Documentation
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Comments
release
object (Release)
Release
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
contact
object (ContactInfo)
ContactInfo
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
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
carousel
array of object (CarouselItem)
Array of CarouselItem
src
string
Theme source URL
explore
object (ExploreInfo)
ExploreInfo
features
array of object (Feature)
Array of Feature
highlights
array of object (Highlight)
Array of Highlight
variations
array of object (Variation)
Array of Variation
documentation
object (Documentation)
Documentation
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Comments
release
object (Release)
Release
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
Loading...
Response
Example not available.
Update draft theme
updateDraftTheme
PUT
Submit organization theme
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
contact
object (ContactInfo)
ContactInfo
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
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
carousel
array of object (CarouselItem)
Array of CarouselItem
src
string
Theme source URL
explore
object (ExploreInfo)
ExploreInfo
features
array of object (Feature)
Array of Feature
highlights
array of object (Highlight)
Array of Highlight
variations
array of object (Variation)
Array of Variation
documentation
object (Documentation)
Documentation
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Comments
release
object (Release)
Release
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
contact
object (ContactInfo)
ContactInfo
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
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
carousel
array of object (CarouselItem)
Array of CarouselItem
src
string
Theme source URL
explore
object (ExploreInfo)
ExploreInfo
features
array of object (Feature)
Array of Feature
highlights
array of object (Highlight)
Array of Highlight
variations
array of object (Variation)
Array of Variation
documentation
object (Documentation)
Documentation
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Comments
release
object (Release)
Release
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
Loading...
Response
Example not available.
Submit organization theme
submitOrganizationTheme
DEL
Delete organization theme
Remove a theme from 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 deletion of the theme
MarketplaceTheme
_id
string
Theme ID
payment
object (PaymentInfo)
PaymentInfo
contact
object (ContactInfo)
ContactInfo
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
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
carousel
array of object (CarouselItem)
Array of CarouselItem
src
string
Theme source URL
explore
object (ExploreInfo)
ExploreInfo
features
array of object (Feature)
Array of Feature
highlights
array of object (Highlight)
Array of Highlight
variations
array of object (Variation)
Array of Variation
documentation
object (Documentation)
Documentation
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Comments
release
object (Release)
Release
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
organizationId:
"value"
themeId:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete organization theme
deleteOrganizationTheme
GET
Get latest version of theme by slug
Retrieve the most recent version of a theme using its slug.
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
contact
object (ContactInfo)
ContactInfo
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
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
carousel
array of object (CarouselItem)
Array of CarouselItem
src
string
Theme source URL
explore
object (ExploreInfo)
ExploreInfo
features
array of object (Feature)
Array of Feature
highlights
array of object (Highlight)
Array of Highlight
variations
array of object (Variation)
Array of Variation
documentation
object (Documentation)
Documentation
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Comments
release
object (Release)
Release
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
organizationId:
"value"
slugName:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get latest version of theme by slug
getLatestVersionOfThemeBySlug
POST
Create new theme in organization
Add a new theme to partner server organizations.
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
contact
object (ContactInfo)
ContactInfo
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
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
carousel
array of object (CarouselItem)
Array of CarouselItem
src
string
Theme source URL
explore
object (ExploreInfo)
ExploreInfo
features
array of object (Feature)
Array of Feature
highlights
array of object (Highlight)
Array of Highlight
variations
array of object (Variation)
Array of Variation
documentation
object (Documentation)
Documentation
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Comments
release
object (Release)
Release
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
contact
object (ContactInfo)
ContactInfo
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
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
carousel
array of object (CarouselItem)
Array of CarouselItem
src
string
Theme source URL
explore
object (ExploreInfo)
ExploreInfo
features
array of object (Feature)
Array of Feature
highlights
array of object (Highlight)
Array of Highlight
variations
array of object (Variation)
Array of Variation
documentation
object (Documentation)
Documentation
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Comments
release
object (Release)
Release
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
Loading...
Response
Example not available.
Create new theme in organization
createNewThemeInOrganization
GET
Get theme rejection reasons
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
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
organizationId:
"value"
themeId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get theme rejection reasons
getThemeRejectionReasons
GET
Get theme versions
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
page
object (PaginationSchema)
PaginationSchema
Examples
Parameters
organizationId:
"value"
themeSlug:
"value"
pageSize:
1
pageNo:
1
Was this section helpful?
GET
Loading...
Response
Loading...