Partner API
Introduction
Client Libraries
Authentication
POSTThis will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
POSTThis operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
GETBrowse Files
GETProxy
POSTProxy
POSTGet signed URLs.
POSTSample File Download
GETGet Serviceability TAT sample files generator status
GETGet all countries and associated data
POSTRegion TAT Import or Export
GETGet region tat bulk history
POSTServiceability Import or Export
GETGet Region Serviceability Bulk History
POSTCreate courier account
GETList courier accounts
PUTUpdate courier account
GETGet courier account
POSTRegion based delivery time insert
GETGet region based delivery time list
GETGet region based delivery time for a given identifier
PUTRegion based delivery time update
DELRegion based delivery time delete
GETRetrieves a sample file that shows the required format for rate card uploads.
POSTRate Card Import or Export
GETRetrieve the history of bulk rate card uploads.
POSTGet Rate Zone sample file
POSTRate Zone Import or Export
GETGet Rate Zone Bulk History
GETFetch Rate Zone Configuration
PUTUpdate Rate Zone Configuration
POSTCreate Scheme for courier partner extension
GETGet created Schemes for courier partner
PUTUpdate Scheme for courier partner extension
GETGet Scheme for courier partner extension by Id
POSTServiceability insert
GETGet region serviceability list
GETGet region serviceability
PUTServiceability update
DELServiceability delete
POSTDraft extension section
POSTPublish an extension section
POSTStart a Preview of Extension Section
DELClose a Preview of Extension Section
GETGet all pages
POSTCreate page
PUTUpdate multiple pages
GETGet page
PUTUpdate page
DELDelete page
GETGet application themes
GETGet theme by ID
PUTUpdate theme
DELDelete theme
GETGet organization themes
GETGet organization theme details
PATCHUpdate draft theme
PUTSubmit organization theme
DELDelete organization theme
GETGet latest version of theme by slug
POSTCreate new theme in organization
GETGet theme rejection reasons
GETGet theme versions
POSTCreate a new theme
GETResponse time summary
POSTValidate filter configuration.
POSTValidate reducer configuration.
PUTSave filter or reducer configuration.

Theme

Responsible for partner theme submission

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
/service/partner/theme/v1.0/organization/{organization_id}/extension-section/{extension_id}/draft
# Draft extension section
POST
/service/partner/theme/v1.0/organization/{organization_id}/extension-section/{extension_id}/publish
# Publish an extension section
POST
/service/partner/theme/v1.0/organization/{organization_id}/extension-section/{extension_section_id}/preview
# Start a Preview of Extension Section
DEL
/service/partner/theme/v1.0/organization/{organization_id}/extension-section/{extension_section_id}/preview
# Close a Preview of Extension Section
POST

Draft extension section

Create a new draft for an extension section within the specified organization.
Parameters
organization_idpath
string
Required
Organization ID
extension_idpath
string
Required
Extension ID
Request body
extension_id
string
bundle_name
string
organization_id
string
sections
array of object (ExtensionSection)
Show
assets
object (AssetsExtension)
Show
type
string
status
string
POST
/service/partner/theme/v1.0/organization/{organization_id}/extension-section/{extension_id}/draft
Loading...
Response
200
Success. Returns the created draft extension section.
Hide
sections
object (Sections)
Show
Examples
Parameters
body:
body
Response
Loading...
POST

Publish an extension section

Publish a draft extension section within the specified organization.
Parameters
organization_idpath
string
Required
Organization ID
extension_idpath
string
Required
Extension ID
Request body
extension_id
string
bundle_name
string
organization_id
string
sections
array of object (ExtensionSection)
Show
assets
object (AssetsExtension)
Show
type
string
status
string
POST
/service/partner/theme/v1.0/organization/{organization_id}/extension-section/{extension_id}/publish
Loading...
Response
200
Success. The extension section has been published.
Hide
sections
object (Sections)
Show
Examples
Parameters
body:
body
Response
Loading...
POST

Start a Preview of Extension Section

Use this API to start a local session for previewing the extension section binding.
Parameters
organization_idpath
string
Required
Organization ID
extension_section_idpath
string
Required
Extension Section ID
Request body
application_id
string
Application ID
section_preview_hash
string
Hash for the section preview
POST
/service/partner/theme/v1.0/organization/{organization_id}/extension-section/{extension_section_id}/preview
Loading...
Response
200
Returns the preview details
Hide
message
string
Examples
Parameters
organization_id:
"value"
extension_section_id:
"value"
body:
body
Response
Loading...
DEL

Close a Preview of Extension Section

Use this API to close a local session for previewing the extension section binding
Parameters
organization_idpath
string
Required
Organization ID
extension_section_idpath
string
Required
Extension Section ID
Request body
application_id
string
Application ID
section_preview_hash
string
Hash for the section preview
DEL
/service/partner/theme/v1.0/organization/{organization_id}/extension-section/{extension_section_id}/preview
Loading...
Response
200
Returns the deletion status
Hide
message
string
Examples
Parameters
organization_id:
"value"
extension_section_id:
"value"
body:
body
Response
Loading...

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
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/page
# Get all pages
POST
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/page
# Create page
PUT
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/page
# Update multiple pages
GET
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
# Get page
PUT
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
# Update page
DEL
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
# Delete page
GET
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/themes
# Get application themes
GET
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}
# Get theme by ID
PUT
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}
# Update theme
DEL
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}
# Delete theme
GET
/service/partner/theme/v1.0/organization/{organization_id}/themes
# Get organization themes
GET
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_id}
# Get organization theme details
PATCH
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_id}
# Update draft theme
PUT
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_id}
# Submit organization theme
DEL
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_id}
# Delete organization theme
GET
/service/partner/theme/v1.0/organization/{organization_id}/{slug_name}/latest
# Get latest version of theme by slug
POST
/service/partner/theme/v1.0/organization/{organization_id}/theme
# Create new theme in organization
GET
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_id}/reasons
# Get theme rejection reasons
GET
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_slug}/versions
# Get theme versions
POST
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}
# Create a new theme
GET

Get all pages

Retrieve a list of all pages available in the partner server setup.
Parameters
company_idpath
integer
Required
Company ID
application_idpath
string
Required
Application ID
theme_idpath
string
Required
ID of the theme to be retrieved
organization_idpath
string
Required
Organization ID
GET
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/page
Loading...
Response
200
Success. Returns an array all the pages of the theme. Refer `AllAvailablePageSchema` for more details.
Hide
pages
array of object (AvailablePageSchema)
Show
Examples
Parameters
Parameters are not required.
Response
Loading...
POST

Create page

Add a new page to the partner server configurations.
Parameters
company_idpath
integer
Required
Company ID
application_idpath
string
Required
Application ID
theme_idpath
string
Required
ID of the theme
organization_idpath
string
Required
Organization ID
Request body
value
string
text
string
path
string
type
string
Enum
sections
array of object (AvailablePageSchemaSections)
Show
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Show
theme
string
seo
object (AvailablePageSeo)
Show
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
POST
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/page
Loading...
Response
200
Success. Returns the page of the theme. Refer `AvailablePageSchema` for more details.
Hide
value
string
text
string
path
string
type
string
Enum
sections
array of object (AvailablePageSchemaSections)
Show
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Show
theme
string
seo
object (AvailablePageSeo)
Show
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.
Response
Loading...
PUT

Update multiple pages

Modify and update multiple pages in the partner server setup.
Parameters
company_idpath
integer
Required
Company ID
application_idpath
string
Required
Application ID
theme_idpath
string
Required
ID of the theme to be retrieved
organization_idpath
string
Required
Organization ID
Request body
pages
array of object (AvailablePageSchema)
Show
PUT
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/page
Loading...
Response
200
Success. Returns an array all the pages of the theme. Refer `AllAvailablePageSchema` for more details.
Hide
pages
array of object (AvailablePageSchema)
Show
Examples
Parameters
Parameters are not required.
Response
Loading...
GET

Get page

Obtain detailed information about a specific page in the partner server.
Parameters
company_idpath
integer
Required
Company ID
application_idpath
string
Required
Application ID
theme_idpath
string
Required
ID of the theme to be retrieved
page_valuepath
string
Required
Value of the page to be retrieved
organization_idpath
string
Required
Organization ID
GET
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
Loading...
Response
200
Success. Returns an object of the page. Refer `AvailablePageSchema` for more details.
Hide
value
string
text
string
path
string
type
string
Enum
sections
array of object (AvailablePageSchemaSections)
Show
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Show
theme
string
seo
object (AvailablePageSeo)
Show
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.
Response
Loading...
PUT

Update page

Modify and update information related to a specific page in the partner server.
Parameters
company_idpath
integer
Required
Company ID
application_idpath
string
Required
Application ID
theme_idpath
string
Required
ID of the theme
page_valuepath
string
Required
Value of the page to be updated
organization_idpath
string
Required
Organization ID
Request body
value
string
text
string
path
string
type
string
Enum
sections
array of object (AvailablePageSchemaSections)
Show
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Show
theme
string
seo
object (AvailablePageSeo)
Show
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
PUT
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
Loading...
Response
200
Success. Returns a the page of the theme. Refer `AvailablePageSchema` for more details.
Hide
value
string
text
string
path
string
type
string
Enum
sections
array of object (AvailablePageSchemaSections)
Show
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Show
theme
string
seo
object (AvailablePageSeo)
Show
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.
Response
Loading...
DEL

Delete page

Remove a page from the partner server configurations.
Parameters
company_idpath
integer
Required
Company ID
application_idpath
string
Required
Application ID
theme_idpath
string
Required
ID of the theme
page_valuepath
string
Required
Value of the page to be updated
organization_idpath
string
Required
Organization ID
DEL
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
Loading...
Response
200
Success. Returns a the page of the theme. Refer `AvailablePageSchema` for more details.
Hide
value
string
text
string
path
string
type
string
Enum
sections
array of object (AvailablePageSchemaSections)
Show
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Show
theme
string
seo
object (AvailablePageSeo)
Show
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.
Response
Loading...
GET

Get application themes

Retrieve a list of themes available for the partner server application.
Parameters
company_idpath
integer
Required
The ID of the company
application_idpath
string
Required
The ID of the application
organization_idpath
string
Required
Organization ID
GET
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/themes
Loading...
Response
200
The list of themes for the application was fetched successfully.
Hide
The response body containing the theme details
font
object (Font)
Show
config
object (Config)
Show
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)
Show
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)
Show
available_sections
array of object (SectionItem)
Available sections information
Show
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
Response
Loading...
GET

Get theme by ID

Obtain detailed information about a theme using its unique ID.
Parameters
company_idpath
integer
Required
The ID of the company
application_idpath
string
Required
The ID of the application
theme_idpath
string
Required
The ID of the theme
organization_idpath
string
Required
Organization ID
GET
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}
Loading...
Response
200
The Details of themes for the application was fetched successfully.
Hide
The response body containing the theme details
font
object (Font)
Show
config
object (Config)
Show
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)
Show
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)
Show
available_sections
array of object (SectionItem)
Available sections information
Show
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"
Response
Loading...
PUT

Update theme

Modify and update information related to a theme in the partner server.
Parameters
company_idpath
integer
Required
The ID of the company.
application_idpath
string
Required
The ID of the application.
theme_idpath
string
Required
The ID of the theme.
organization_idpath
string
Required
Organization ID
Request body
config
object (Config)
Show
font
object (Font)
Show
PUT
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}
Loading...
Response
200
Theme updated successfully
Hide
The response body containing the theme details
font
object (Font)
Show
config
object (Config)
Show
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)
Show
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)
Show
available_sections
array of object (SectionItem)
Available sections information
Show
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
Examples
Parameters
Parameters are not required.
Response
Loading...
DEL

Delete theme

Remove a theme from the partner server configurations.
Parameters
company_idpath
integer
Required
The ID of the company.
application_idpath
string
Required
The ID of the application.
theme_idpath
string
Required
The ID of the theme to be deleted.
organization_idpath
string
Required
Organization ID
DEL
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}
Loading...
Response
200
Theme successfully deleted.
Hide
The response body containing the theme details
font
object (Font)
Show
config
object (Config)
Show
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)
Show
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)
Show
available_sections
array of object (SectionItem)
Available sections information
Show
theme_type
string
Enum
company_id
number
The company id in which sales channel exists
src
string
Examples
Parameters
Parameters are not required.
Response
Loading...
GET

Get organization themes

Retrieve a list of themes associated with partner server organizations.
Parameters
organization_idpath
string
Required
Id of your organization
statusquery
string
The status of the theme
Enum
page_sizequery
integer
Number of themes per page
page_noquery
integer
Page number to retrieve
GET
/service/partner/theme/v1.0/organization/{organization_id}/themes
Loading...
Response
200
Successful operation
Hide
themes
array of object (MarketplaceTheme)
Show
page
object (PaginationSchema)
Show
Examples
Parameters
organization_id:
"value"
status:
"value"
page_size:
1
page_no:
1
Response
Loading...
GET

Get organization theme details

Obtain detailed information about a theme within partner server organizations.
Parameters
organization_idpath
string
Required
The ID of the organization
theme_idpath
string
Required
The ID of the theme
GET
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_id}
Loading...
Response
200
Successful response
Hide
_id
string
Theme ID
payment
object (PaymentInfo)
Show
contact
object (ContactInfo)
Show
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)
Show
images
object (MarketplaceThemeImages)
Show
carousel
array of object (CarouselItem)
Show
src
string
Theme source URL
explore
object (ExploreInfo)
Show
features
array of object (Feature)
Show
highlights
array of object (Highlight)
Show
variations
array of object (Variation)
Show
documentation
object (Documentation)
Show
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Show
release
object (Release)
Show
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"
Response
Loading...
PATCH

Update draft theme

Modify and update a draft theme in partner server organizations.
Parameters
organization_idpath
string
Required
The ID of the organization
theme_idpath
string
Required
The ID of the theme
Request body
_id
string
Theme ID
payment
object (PaymentInfo)
Show
contact
object (ContactInfo)
Show
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)
Show
images
object (MarketplaceThemeImages)
Show
carousel
array of object (CarouselItem)
Show
src
string
Theme source URL
explore
object (ExploreInfo)
Show
features
array of object (Feature)
Show
highlights
array of object (Highlight)
Show
variations
array of object (Variation)
Show
documentation
object (Documentation)
Show
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Show
release
object (Release)
Show
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
PATCH
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_id}
Loading...
Response
200
Theme updated successfully
Hide
_id
string
Theme ID
payment
object (PaymentInfo)
Show
contact
object (ContactInfo)
Show
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)
Show
images
object (MarketplaceThemeImages)
Show
carousel
array of object (CarouselItem)
Show
src
string
Theme source URL
explore
object (ExploreInfo)
Show
features
array of object (Feature)
Show
highlights
array of object (Highlight)
Show
variations
array of object (Variation)
Show
documentation
object (Documentation)
Show
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Show
release
object (Release)
Show
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
Loading...
PUT

Submit organization theme

Initiate the process of submitting a theme within partner server organizations.
Parameters
organization_idpath
string
Required
The ID of the organization
theme_idpath
string
Required
The ID of the theme
Request body
_id
string
Theme ID
payment
object (PaymentInfo)
Show
contact
object (ContactInfo)
Show
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)
Show
images
object (MarketplaceThemeImages)
Show
carousel
array of object (CarouselItem)
Show
src
string
Theme source URL
explore
object (ExploreInfo)
Show
features
array of object (Feature)
Show
highlights
array of object (Highlight)
Show
variations
array of object (Variation)
Show
documentation
object (Documentation)
Show
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Show
release
object (Release)
Show
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
PUT
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_id}
Loading...
Response
200
Theme updated successfully
Hide
_id
string
Theme ID
payment
object (PaymentInfo)
Show
contact
object (ContactInfo)
Show
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)
Show
images
object (MarketplaceThemeImages)
Show
carousel
array of object (CarouselItem)
Show
src
string
Theme source URL
explore
object (ExploreInfo)
Show
features
array of object (Feature)
Show
highlights
array of object (Highlight)
Show
variations
array of object (Variation)
Show
documentation
object (Documentation)
Show
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Show
release
object (Release)
Show
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.
Response
Loading...
DEL

Delete organization theme

Remove a theme from partner server organizations.
Parameters
organization_idpath
string
Required
The ID of the organization
theme_idpath
string
Required
The ID of the theme
DEL
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_id}
Loading...
Response
200
Successful deletion of the theme
Hide
_id
string
Theme ID
payment
object (PaymentInfo)
Show
contact
object (ContactInfo)
Show
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)
Show
images
object (MarketplaceThemeImages)
Show
carousel
array of object (CarouselItem)
Show
src
string
Theme source URL
explore
object (ExploreInfo)
Show
features
array of object (Feature)
Show
highlights
array of object (Highlight)
Show
variations
array of object (Variation)
Show
documentation
object (Documentation)
Show
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Show
release
object (Release)
Show
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"
Response
Loading...
GET

Get latest version of theme by slug

Retrieve the most recent version of a theme using its slug.
Parameters
organization_idpath
string
Required
The ID of the organization
slug_namepath
string
Required
Slug of theme
GET
/service/partner/theme/v1.0/organization/{organization_id}/{slug_name}/latest
Loading...
Response
200
Successful operation
Hide
_id
string
Theme ID
payment
object (PaymentInfo)
Show
contact
object (ContactInfo)
Show
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)
Show
images
object (MarketplaceThemeImages)
Show
carousel
array of object (CarouselItem)
Show
src
string
Theme source URL
explore
object (ExploreInfo)
Show
features
array of object (Feature)
Show
highlights
array of object (Highlight)
Show
variations
array of object (Variation)
Show
documentation
object (Documentation)
Show
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Show
release
object (Release)
Show
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"
Response
Loading...
POST

Create new theme in organization

Add a new theme to partner server organizations.
Parameters
organization_idpath
string
Required
The ID of the organization
slugquery
string
The slug of the theme.
Request body
_id
string
Theme ID
payment
object (PaymentInfo)
Show
contact
object (ContactInfo)
Show
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)
Show
images
object (MarketplaceThemeImages)
Show
carousel
array of object (CarouselItem)
Show
src
string
Theme source URL
explore
object (ExploreInfo)
Show
features
array of object (Feature)
Show
highlights
array of object (Highlight)
Show
variations
array of object (Variation)
Show
documentation
object (Documentation)
Show
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Show
release
object (Release)
Show
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
POST
/service/partner/theme/v1.0/organization/{organization_id}/theme
Loading...
Response
200
Theme updated successfully
Hide
_id
string
Theme ID
payment
object (PaymentInfo)
Show
contact
object (ContactInfo)
Show
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)
Show
images
object (MarketplaceThemeImages)
Show
carousel
array of object (CarouselItem)
Show
src
string
Theme source URL
explore
object (ExploreInfo)
Show
features
array of object (Feature)
Show
highlights
array of object (Highlight)
Show
variations
array of object (Variation)
Show
documentation
object (Documentation)
Show
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Show
release
object (Release)
Show
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.
Response
Loading...
GET

Get theme rejection reasons

Retrieve reasons for the rejection of themes within partner server organizations.
Parameters
organization_idpath
string
Required
The ID of the organization
theme_idpath
string
Required
The ID of the theme
GET
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_id}/reasons
Loading...
Response
200
Theme rejection reasons retrieved successfully
Hide
_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)
Show
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"
Response
Loading...
GET

Get theme versions

Retrieve a list of versions available for a theme within partner server organizations.
Parameters
organization_idpath
string
Required
The ID of the organization.
theme_slugpath
string
Required
The slug of the theme.
page_sizequery
integer
The number of items to return per page.
page_noquery
integer
The page number to return.
GET
/service/partner/theme/v1.0/organization/{organization_id}/theme/{theme_slug}/versions
Loading...
Response
200
Successful operation.
Hide
themes
array of object (MarketplaceTheme)
Show
page
object (PaginationSchema)
Show
Examples
Parameters
organization_id:
"value"
theme_slug:
"value"
page_size:
1
page_no:
1
Response
Loading...
POST

Create a new theme

Themes improve the look and appearance of a website. Use this API to create a theme.
Parameters
company_idpath
integer
Required
Company ID
application_idpath
string
Required
Application ID
organization_idpath
string
Required
Organization ID
Request body
name
string
Required
The name of the theme
available_sections
array of object (SectionItem)
Required
Available sections information
Show
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
Show
global_schema
object (GlobalSchema)
Show
preset
object (Preset)
Show
current
string
The current configuration
pages
array of object (Page)
Show
POST
/service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}
Loading...
Response
200
Returns the new application theme details
Hide
The response body containing the theme details
font
object (Font)
Show
config
object (Config)
Show
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)
Show
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)
Show
available_sections
array of object (SectionItem)
Available sections information
Show
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
Response
Loading...
Previous
« Sample File Download
Next
Response time summary »