Content

The Content service manages various types of content on the e-commerce platform, including Announcements, Blogs, Legal content, Navigation menus, Custom Pages, Path Redirection Rules, Customer Support information, and Slideshows.

Announcement

Announcements are banners or notifications that appear on top of your website or below the headers of navigation content in mobile applications. These will generally display any information that you wish to highlight to customers, such as a running or upcoming sale offer, vital notice information, or any user or business activities that need attention. This resource allows you to access all announcements configured on the platform.

Operations
GET
/service/application/content/v1.0/announcements
# List announcements
GET

List announcements

List all current announcements in the application.
Parameters
No Parameters
Response
200
4XX
Success. Returns a JSON object with the details of the announcement shown on an individual page. `$all` is a special slug to indicate that an announcement is being shown on all the pages. Check the example shown below or refer `AnnouncementsResponseSchema` for more details.
AnnouncementsResponseSchema
announcements
object
List all the announcement bar details and its contents.
refresh_rate
integer
| int32
Number of seconds after which api should hit again to fetch new announcements.
refresh_pages
array of string
List of page slugs on which announcement should be fetched as soon as they are loaded.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/announcements
Loading...
Response
Loading...

Blog

Blogs serve as a multifaceted tool to engage with your audience, enhance your brand image, and drive sales. Through informative and engaging content, you can attract potential customers, improve your website's search engine rankings, and establish yourself as an authority in your industry. Blogs are utilized for various purposes, including content marketing, SEO, product announcements, customer engagement, brand storytelling, educational resources, and promotional activities. By regularly updating your blog with relevant content, you can foster a sense of community, provide value to your audience, and ultimately increase conversions on your store. This resource allows access to all blogs and related information to display over the website or mobile application.

Operations
GET
/service/application/content/v1.0/blogs/{slug}
# Get a blog
GET
/service/application/content/v1.0/blogs
# List blogs
GET

Get a blog

Get information related to a specific blog such as it's contents, author, publish date, SEO related information.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a blog. You can get slug value from the endpoint /service/application/content/v1.0/blogs/.
root_id
string
ID given to the HTML element.
preview
boolean
Boolean value to get the preview for the blogs.
Response
200
4XX
Success. Returns a JSON object with blog details. Check the example shown below or refer `BlogSchema` for more details.
BlogSchema
_id
string
Unique identifier for an entry.
_custom_json
object
Custom JSON object for specific use cases.
application
string
Application ID - Identifier for a Sales channel.
archived
boolean
Boolean flag denoting whether blog is archived or not.
author
object (Author)
Author
designation
string
Description of the author of blog.
id
string
Unique Identifier of the author of blog.
name
string
Name of the author of blog.
content
array of object (ResourceContent)
Contents of blog.
Array of ResourceContent
type
string
The type of content of blogs - html.
value
string
The contents of blog.
feature_image
object (Asset)
Asset
aspect_ratio
string
Aspect ratio of the image.
id
string
Unique identifier for an entry.
secure_url
string
URL of the image.
published
boolean
Boolean flag denoting whether blog is published or not.
reading_time
string
Estimated time required to read the blog.
slug
string
A short, human-readable, URL-friendly identifier.
tags
array of string
Tags under a blog.
publish_date
string
| date-time
Timestamp denoting when the blog was published.
seo
object (SEO)
SEO
description
string
The contents of og:description.
image
object (SEOImage)
SEOImage
url
string
The url of image.
title
string
The contents of og:title.
meta_tags
array of object (SEOMetaItem)
List of meta tags.
Array of SEOMetaItem
title
string
Title of the custom meta tags group.
items
array of object (SEOMetaItems)
List of key value pairs to power meta tags.
Array of SEOMetaItems
key
string
The key denoting the attribute name of SEO meta tag.
value
string
The key denoting the attribute value of SEO meta tag.
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
Value of sitemap priority randing from 0.0 to 1.0.
frequency
string
Value of sitemap frequency change denoting how frequently the content changes.
breadcrumb
array of object (SEObreadcrumb)
List of action objects which can power breadcrumbs on website.
Array of SEObreadcrumb
url
string
URL of where the breadcrumb link redirects to.
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
canonical_url
string
The canonical URL for canonical link element.
title
string
Title of the Blog.
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
Timestamp which represent the time when data was created.
modified_on
string
| date-time
Timestamp which represent when was the last time when data was updated.
summary
string
A brief description of blog.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/blogs/{slug}
Loading...
Response
Loading...
GET

List blogs

List all the blogs against an application.
Parameters
page_no
integer
The page number to navigate through the given set of results. Default value is 1. .
Default Value : 1
page_size
integer
The number of items to retrieve in each page.
Default Value : 10
tags
string
Blogs retrieve based on the list of tags passed.
search
string
Blogs retrieve based on the title.
Response
200
4XX
Success. Check the example shown below or refer `BlogGetDetails` for more details.
BlogGetDetails
items
array of object (BlogSchema)
List of blogs with details.
Array of BlogSchema
_id
string
Unique identifier for an entry.
_custom_json
object
Custom JSON object for specific use cases.
application
string
Application ID - Identifier for a Sales channel.
archived
boolean
Boolean flag denoting whether blog is archived or not.
author
object (Author)
Author
designation
string
Description of the author of blog.
id
string
Unique Identifier of the author of blog.
name
string
Name of the author of blog.
content
array of object (ResourceContent)
Contents of blog.
Array of ResourceContent
type
string
The type of content of blogs - html.
value
string
The contents of blog.
feature_image
object (Asset)
Asset
aspect_ratio
string
Aspect ratio of the image.
id
string
Unique identifier for an entry.
secure_url
string
URL of the image.
published
boolean
Boolean flag denoting whether blog is published or not.
reading_time
string
Estimated time required to read the blog.
slug
string
A short, human-readable, URL-friendly identifier.
tags
array of string
Tags under a blog.
publish_date
string
| date-time
Timestamp denoting when the blog was published.
seo
object (SEO)
SEO
description
string
The contents of og:description.
image
object (SEOImage)
SEOImage
url
string
The url of image.
title
string
The contents of og:title.
meta_tags
array of object (SEOMetaItem)
List of meta tags.
Array of SEOMetaItem
title
string
Title of the custom meta tags group.
items
array of object (SEOMetaItems)
List of key value pairs to power meta tags.
Array of SEOMetaItems
key
string
The key denoting the attribute name of SEO meta tag.
value
string
The key denoting the attribute value of SEO meta tag.
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
Value of sitemap priority randing from 0.0 to 1.0.
frequency
string
Value of sitemap frequency change denoting how frequently the content changes.
breadcrumb
array of object (SEObreadcrumb)
List of action objects which can power breadcrumbs on website.
Array of SEObreadcrumb
url
string
URL of where the breadcrumb link redirects to.
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
canonical_url
string
The canonical URL for canonical link element.
title
string
Title of the Blog.
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
Timestamp which represent the time when data was created.
modified_on
string
| date-time
Timestamp which represent when was the last time when data was updated.
summary
string
A brief description of blog.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
filters
object (BlogFilters)
BlogFilters
tags
array of string
All tags present under blogs.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/blogs
Loading...
Response
Loading...

Custom Fields

Custom fields are a flexible way to attach additional information to a resource (e.g. Product, promotions, etc.). Some examples of data stored using custom-fields include specifications, size charts, downloadable documents, release dates, images, or part numbers. Custom fields are identified by an owner resource, a namespace, and a key and they store a value along with type information for that context.

Operations
GET
/service/application/content/v2.0/customfields/resource/{resource}/{resource_slug}
# Get list of custom fields of given resource and resource slug
GET

Get list of custom fields of given resource and resource slug

Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug.
Parameters
resource
string
Required
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resource_slug
string
Required
This is the resource id for which custom fields created
Response
200
400
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
List of custom fields against a resource.
Array of CustomFieldSchema
_id
string
Unique identifier of an entry.
namespace
string
Namespace under which custom field is present.
slug
string
Unique identifier for a custom field in a given namespace.
resource
string
Type of an entity under which custom field is defined.
value
array of object (CustomFieldValue)
Array containing values of custom field.
Array of CustomFieldValue
value
Undefined Type
Array containing value(s) of custom field.
anyOf Schema from below
resource_id
string
Unique identifier for the entity under which custom field is defined.
type
string
The type type of custom field.
multi_value
boolean
Whether custom field can have multiple values or not.
company_id
string
| integer
Unique Identifier for a company.
application_id
string
Application ID - Identifier for a Sales channel.
definition_id
string
Unique identifier for a custom field definition.
has_invalid_values
boolean
Whether the custom field has invalid values.
invalid_value_errors
array of Undefined Type
Array denoting if there's a validation failure on a custom field inside a custom object.
is_deleted
boolean
Whether the custom field definition is deleted.
created_at
string
| date-time
Timestamp which represent the time when data was created.
updated_at
string
| date-time
Timestamp which represent when was the last time when data was updated.
Examples
Parameters
resource:
"product"
resource_slug:
"64bb987e9a3c4b6c29d676bc"
GET
/service/application/content/v2.0/customfields/resource/{resource}/{resource_slug}
Loading...
Response
Loading...

Custom Objects

Custom objects refer to entities that are not currently present on the platform. Sellers can create these custom data structures, allowing them to define the essential custom fields according to their preferences. These custom objects are introduced to address unique data requirements that fall outside the platform's standard features.

Operations
GET
/service/application/content/v2.0/customobjects/definition/{definition_slug}/entries/{slug}
# Get custom object details
GET

Get custom object details

Details of a custom object entry can be obtained using this endpoint.
Parameters
definition_slug
string
Required
This is custom object definition slug
slug
string
Required
This is custom object entry slug
Response
200
400
Success. Returns a custom object. Refer `CustomObjectByIdSchema` for more details.
CustomObjectByIdSchema
id
string
Unique identifier of an entry.
status
string
String denoting whether custom object is active or inactive.
display_name
string
Unique Display name of a custom object which is system generated: Concatenation of string definition name and _id.
definition
object (CustomObjectListItemDefinationSchema)
CustomObjectListItemDefinationSchema
_id
string
Unique identifier of an entry.
name
string
Name of definition of custom field.
type
string
Data type of the custom field.
references
array of Undefined Type
List of custom fields ids where the custom object is added as a field.
fields
array of object (CustomObjectFieldSchema)
List of custom fields against a Custom Object.
Array of CustomObjectFieldSchema
_id
string
Unique identifier of an entry.
slug
string
Slug of custom field inside custom object.
value
array of object (CustomObjectFieldValue)
Value of custom field inside custom object.
Array of CustomObjectFieldValue
value
Undefined Type
Value of custom field.
anyOf Schema from below
type
string
Data type of custom field inside custom object.
definition_id
string
Definition id of custom field inside custom object.
Examples
Parameters
definition_slug:
"namespace_success"
slug:
"address-1-success"
GET
/service/application/content/v2.0/customobjects/definition/{definition_slug}/entries/{slug}
Loading...
Response
Loading...

Customer Support

Customer support information on an E-commerce website encompasses various resources and channels through which customers can seek assistance or resolve queries related to products, orders, payments, shipping, returns, and general inquiries. This typically includes contact details such as email addresses or phone numbers, enabling customers to reach out to the seller directly for support. This resource allows you to fetch all customer support contact details related information into website or mobile applications.

Operations
GET
/service/application/content/v1.0/support
# Get customer support information
GET

Get customer support information

Get customer support contact details. Contact Details can be either a phone number or an email-id or both.
Parameters
No Parameters
Response
200
4XX
Success. Returns all support information including email and phone number. Check the example shown below or refer `Support` for more details.
Support
created
boolean
Whether support contact details are created or not.
_id
string
Unique identifier of an entry.
application
string
Application ID - Identifier for a Sales channel.
created_at
string
| date-time
Timestamp which represent the time when data was created.
updated_at
string
| date-time
Timestamp which represent when was the last time when data was updated.
contact
object (ContactSchema)
ContactSchema
phone
object (PhoneSchema)
PhoneSchema
active
boolean
Flag denoting whether contact detail is active or not.
phone
array of object (PhoneProperties)
Details related to phone contact of SPOC.
Array of PhoneProperties
key
string
Name of the Contact SPOC.
code
string
International dial Code.
number
string
Phone Number.
phone_type
string
Denotes the type of phone number.
Enum
email
object (EmailSchema)
EmailSchema
active
boolean
Whether contact detail is active or not.
email
array of object (EmailProperties)
Details related to email contact of SPOC.
Array of EmailProperties
key
string
Name of email SPOC.
value
string
Email Id of the SPOC.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/support
Loading...
Response
Loading...

Data Loaders

Data loaders are a mechanism through which one can override the FDK (Fynd Platform SDK) method implementation. They are primarily used when you have better-managed data storage or faster data retrieval tools suited for a particular use case, or when you want your requests to not follow the predefined flow pattern provided by the Platform, or a combination of these reasons. To use Data loaders, you forward the requests coming from the website or mobile applications to externally hosted services instead of the default Fynd Platform systems. To do so, you must provide the path where these requests should reach alternatively while setting up a Dataloader. This resource allows you to access all Data loaders that are setup for an application module wise.

Operations
GET
/service/application/content/v1.0/data-loader
# List Dataloaders
GET

List Dataloaders

List all the data loaders that are enabled for an application.
Parameters
No Parameters
Response
200
4XX
Success. Returns a JSON object containing all the data loaders injected in the application. Check the example shown below or refer `DataLoadersSchema` for more details.
DataLoadersSchema
items
array of object (DataLoaderSchema)
List of data loaders.
Array of DataLoaderSchema
name
string
Name of dataloader.
service
string
Service of data loader which overrides the default method.
operation_id
string
Operation ID of the method which data loader is overriding.
type
string
Type of data loader.
Enum
url
string
URL at which data loader redirects.
content
string
Content of a data loader.
__source
object (DataLoaderSourceSchema)
DataLoaderSourceSchema
type
string
Type of creator.
id
string
Identifier of an extension.
_id
string
Unique identifier of an entry.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/data-loader
Loading...
Response
Loading...

FAQs

FAQs (Frequently Asked Questions) is designed to help provide answers to common inquiries and streamline customer support. FAQs are typically compiled lists of questions and corresponding answers that address common concerns or queries customers may have about a store's products, policies, or services. These can cover topics such as shipping information, return policies, product details, and more. FAQ Categories allow for the organization of FAQs into specific sections or topics, making it easier for customers to navigate and find relevant information.

Operations
GET
/service/application/content/v1.0/faq
# List FAQs
GET
/service/application/content/v1.0/faq/categories
# List FAQ Categories
GET
/service/application/content/v1.0/faq/{slug}
# Get FAQ
GET
/service/application/content/v1.0/faq/category/{slug}
# Get a FAQ category
GET
/service/application/content/v1.0/faq/category/{slug}/faqs
# List FAQs by category
GET

List FAQs

List frequently asked questions and answers.
Parameters
No Parameters
Response
200
4XX
Success. Returns a JSON object with question and answers. Check the example shown below or refer `FaqResponseSchema` for more details.
FaqResponseSchema
faqs
array of object (FaqSchema)
List of FAQs.
Array of FaqSchema
slug
string
A short, human-readable, URL-friendly identifier.
application
string
Application ID - Identifier for a Sales channel.
_id
string
Unique identifier of an entry.
question
string
The contents of a question of a FAQ.
answer
string
The contents of a answer of a FAQ.
tags
array of string
Tags under a FAQ.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/faq
Loading...
Response
Loading...
GET

List FAQ Categories

List categories for organizing FAQs.
Parameters
No Parameters
Response
200
4XX
Success. Returns a JSON object with categories of FAQ. Check the example shown below or refer `GetFaqCategoriesSchema` for more details.
GetFaqCategoriesSchema
categories
array of object (CategorySchema)
List of FAQ Categories.
Array of CategorySchema
index
integer
Order of FAQ Category.
title
string
Title of the FAQ category.
description
string
Details of the FAQ category.
children
array of string
List of FAQs.
_id
string
Unique identifier of an entry.
slug
string
A short, human-readable, URL-friendly identifier.
application
string
Application ID - Identifier for a Sales channel.
icon_url
string
URL of the image associated with FAQ Category.
_custom_json
object
Custom JSON object for specific use cases.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/faq/categories
Loading...
Response
Loading...
GET

Get FAQ

Get a specific FAQ using its slug identifier.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of an FAQ. You can get slug value from the endpoint /service/application/content/v1.0/faq.
Response
200
4XX
Success. Returns a question and answer by its slug. Check the example shown below or refer `FaqSchema` for more details.
FaqSchema
slug
string
A short, human-readable, URL-friendly identifier.
application
string
Application ID - Identifier for a Sales channel.
_id
string
Unique identifier of an entry.
question
string
The contents of a question of a FAQ.
answer
string
The contents of a answer of a FAQ.
tags
array of string
Tags under a FAQ.
Examples
Parameters
slug:
"value"
GET
/service/application/content/v1.0/faq/{slug}
Loading...
Response
Loading...
GET

Get a FAQ category

Get a specific FAQ category using its slug.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of an FAQ category. You can get slug value from the endpoint /service/application/content/v1.0/faq/categories.
Response
200
4XX
Success. Returns a FAQ category with its slug. Check the example shown below or refer `GetFaqCategoryBySlugSchema` for more details.
GetFaqCategoryBySlugSchema
category
object (FAQCategorySchema)
FAQCategorySchema
index
integer
Order of FAQ Category.
title
string
Title of a FAQ Category.
description
string
Details of the FAQ category.
children
array of object (ChildrenSchema)
Details regarding a FAQs stored under a FAQs category.
Array of ChildrenSchema
question
string
The contents of a question of a FAQ.
answer
string
The contents of a answer of a FAQ.
slug
string
A short, human-readable, URL-friendly identifier.
application
string
Application ID - Identifier for a Sales channel.
_id
string
Unique identifier of an entry.
_id
string
Unique identifier of an entry.
slug
string
A short, human-readable, URL-friendly identifier.
application
string
Application ID - Identifier for a Sales channel.
icon_url
string
URL of the image associated with FAQ Category.
_custom_json
object
Custom JSON object for specific use cases.
Examples
Parameters
slug:
"value"
GET
/service/application/content/v1.0/faq/category/{slug}
Loading...
Response
Loading...
GET

List FAQs by category

Get FAQs belonging to a specific category slug.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of an FAQ category. You can get slug value from the endpoint /service/application/content/v1.0/faq/categories.
Response
200
4XX
Success. Returns a categorized list of question and answers using its slug. Check the example shown below or refer `GetFaqSchema` for more details.
GetFaqSchema
faqs
array of object (FaqSchema)
List of FAQs.
Array of FaqSchema
slug
string
A short, human-readable, URL-friendly identifier.
application
string
Application ID - Identifier for a Sales channel.
_id
string
Unique identifier of an entry.
question
string
The contents of a question of a FAQ.
answer
string
The contents of a answer of a FAQ.
tags
array of string
Tags under a FAQ.
Examples
Parameters
slug:
"value"
GET
/service/application/content/v1.0/faq/category/{slug}/faqs
Loading...
Response
Loading...

HTML Tags

Third-party HTML tags encompass external HTML elements sourced from outside the application or website environment, often integrated via Sales Channel Settings or extensions. These tags can include script elements, enabling the integration of external functionalities such as analytics tracking, live chat services, or e-commerce tools. Similarly, style elements may be incorporated to leverage external CSS frameworks or design libraries, enhancing the visual presentation and user experience of the application. This resource allows you to fetch all such Tags that are setup for an application.

Operations
GET
/service/application/content/v1.0/tags
# Get HTML tags
GET

Get HTML tags

Lists HTML tags to power additional functionalities within an application.
Parameters
No Parameters
Response
200
4XX
Success. Returns a JSON object containing all the tags injected in the application. Check the example shown below or refer `TagsSchema` for more details.
TagsSchema
application
string
Application ID - Identifier for a Sales channel.
_id
string
Unique identifier of an entry.
tags
array of object (TagSchema)
List of Third party injectable html tags.
Array of TagSchema
name
string
Name of the html tag.
url
string
URL at which css or js might be hosted.
type
string
Whether Tag is JS or CSS.
Enum
sub_type
string
Whether js/css is external or inline.
Enum
_id
string
Unique identifier of an entry.
position
string
Position where Tag is so to be placed.
Enum
attributes
object
Custom JSON object for specific use cases.
content
string
Content of tag.
pages
array of object
List of all the page where tag is to be added.
__source
object (TagSourceSchema)
TagSourceSchema
type
string
Type of creator of tag.
id
string
Identifier of an extension.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/tags
Loading...
Response
Loading...

Landing Page

The landing Page Selection module extends versatility by enabling sellers to designate specific landing pages as the home page for different types of devices and platforms, including websites, Android, and iOS. This functionality offers unprecedented customization, allowing sellers to tailor the browsing experience based on the preferences and behaviours of their audience across various devices. By selecting dedicated landing pages optimized for each platform, sellers can ensure consistency in branding and messaging while maximizing engagement and conversions. Whether visitors are accessing the site from a desktop browser, Android device, or iOS device, Fynd Platform's Landing Page Selection empowers sellers to deliver a seamless and tailored experience that resonates with their audience, ultimately driving success in their e-commerce endeavours.

Operations
GET
/service/application/content/v1.0/landing-page
# Get a landing page
GET

Get a landing page

Get content of the application's landing page.
Parameters
No Parameters
Response
200
4XX
Success. Returns the landing page details. Check the example shown below or refer `LandingPageSchema` for more details.
LandingPageSchema
slug
string
A short, human-readable, URL-friendly identifier.
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
platform
array of string
List of platforms linked to this landing page.
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
Details containing the creator of custom page.
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
Timestamp which represent the time when data was created.
modified_on
string
| date-time
Timestamp which represent when was the last time when data was updated.
_id
string
Unique identifier of an entry.
application
string
Application ID - Identifier for a Sales channel.
archived
boolean
Whether landing page is archived or not.
_custom_json
object
Custom JSON object for specific use cases.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/landing-page
Loading...
Response
Loading...

Legal Page

Legal pages encompass essential documents required for e-commerce businesses to comply with legal regulations and establish transparent policies. These pages include a Privacy Policy detailing data handling practices, Terms & Conditions of Service outlining user responsibilities and transaction terms, Return Policy specifying refund procedures, and Shipping Policy detailing shipping terms and conditions. These documents help build trust with customers, mitigate legal risks, and ensure compliance with relevant laws and regulations, ultimately contributing to a positive shopping experience and legal protection for the business. Using this resource, you can retrieve all such information that has been set up on the platform to display it over websites and mobile applications.

Operations
GET
/service/application/content/v1.0/legal
# Get legal information
GET

Get legal information

Get legal policies for an application which includes Terms and conditions, return policy, shipping policy and privacy policy.
Parameters
No Parameters
Response
200
4XX
Success. Returns the T&C, Shipping Policy, Privacy Policy and Return Policy. Check the example shown below or refer `ApplicationLegal` for more details.
ApplicationLegal
application
string
Application ID - Identifier for a Sales channel.
tnc
string
Content for Terms and Conditions page on storefront.
policy
string
Content for Privacy Policy page on storefront.
shipping
string
Content for Shipping Policy page on storefront.
returns
string
Content for Return policy page on storefront.
faq
array of object (ApplicationLegalFAQ)
FAQs of an application.
Array of ApplicationLegalFAQ
question
string
The contents of a question of a FAQ.
answer
string
The contents of a answer of a FAQ.
_id
string
Unique identifier of an entry.
updated_at
string
| date-time
Timestamp which represent when was the last time when data was updated.
created_at
string
| date-time
Timestamp which represent the time when data was created.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/legal
Loading...
Response
Loading...

Page

Custom pages allow Sellers to create unique web pages tailored to specific purposes or content needs within. These pages can include essential elements such as an About Us section detailing the store's background and mission, a Contact Us page facilitating communication with customers, and additional pages tailored to promotional campaigns or product launches. Through custom pages, Sellers can enhance the user experience, provide valuable information, and strengthen their brand presence. This resource allows you to fetch all such custom pages on the website or mobile application. You can either fetch these custom pages together or individually with the help of slugs.

Operations
GET
/service/application/content/v2.0/pages/{slug}
# Get a page
GET
/service/application/content/v2.0/pages
# Lists pages
GET

Get a page

Get detailed information for a specific page within the theme.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a page. You can get slug value from the endpoint /service/application/content/v2.0/pages/.
root_id
string
ID given to the HTML element.
Response
200
4XX
Success. Returns a JSON object with page details. Check the example shown below or refer `CustomPageSchema` for more details.
PageSchema
_id
string
Unique identifier of an entry.
application
string
Application ID - Identifier for a Sales channel.
component_ids
array of string
Components can be used to store multiple components.
content
array of object
Contents of a custom page.
content_path
string
A CDN URL at which the entire html content can be fetched from.
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
Details containing the creator of custom page.
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
Timestamp which represent the time when data was created.
modified_on
string
| date-time
Timestamp which represent when was the last time when data was updated.
description
string
Description about the page.
feature_image
object (Asset)
Asset
aspect_ratio
string
Aspect ratio of the image.
id
string
Unique identifier for an entry.
secure_url
string
URL of the image.
page_meta
array of object
List of Custom JSON object for specific use cases.
_schedule
object (ScheduleSchema)
ScheduleSchema
cron
string
String representing the cron expression.
start
string
Start time of schedule.
end
string
End time of schedule.
duration
number
Duration of the scheduled entity.
next_schedule
array of object (NextSchedule)
Details regarding the next trigger point of schedule.
Array of NextSchedule
start
string
Start time of next trigger point of schedule.
end
string
End time of next trigger point of schedule.
_custom_json
object
Custom JSON object for specific use cases.
orientation
string
Orientation for Custom Pages - Landscape or portrait.
platform
string
Platform for Custom Pages - Denotes the device type.
published
boolean
Whether page is active or not on website.
slug
string
A short, human-readable, URL-friendly identifier.
tags
array of string
Tags under a page.
title
string
The title of the page.
type
string
Type of editor through which the page was created so appropriate rendering engine is used.
seo
object (SEO)
SEO
description
string
The contents of og:description.
image
object (SEOImage)
SEOImage
url
string
The url of image.
title
string
The contents of og:title.
meta_tags
array of object (SEOMetaItem)
List of meta tags.
Array of SEOMetaItem
title
string
Title of the custom meta tags group.
items
array of object (SEOMetaItems)
List of key value pairs to power meta tags.
Array of SEOMetaItems
key
string
The key denoting the attribute name of SEO meta tag.
value
string
The key denoting the attribute value of SEO meta tag.
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
Value of sitemap priority randing from 0.0 to 1.0.
frequency
string
Value of sitemap frequency change denoting how frequently the content changes.
breadcrumb
array of object (SEObreadcrumb)
List of action objects which can power breadcrumbs on website.
Array of SEObreadcrumb
url
string
URL of where the breadcrumb link redirects to.
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
canonical_url
string
The canonical URL for canonical link element.
visibility
object
Visibility of Page.
archived
boolean
Flag denoting whether the page is archived or not.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v2.0/pages/{slug}
Loading...
Response
Loading...
GET

Lists pages

Lists all Custom Pages.
Parameters
page_no
integer
The page number to navigate through the given set of results. Default value is 1. .
Default Value : 1
page_size
integer
The number of items to retrieve in each page.
Default Value : 10
Response
200
4XX
Success. Returns a list of pages along with their details. Check the example shown below or refer `PageGetStorefrontResponse` for more details.
PageGetDetails
items
array of object (PageSchema)
List of details of custom pages.
Array of PageSchema
_id
string
Unique identifier of an entry.
application
string
Application ID - Identifier for a Sales channel.
component_ids
array of string
Components can be used to store multiple components.
content
array of object
Contents of a custom page.
content_path
string
A CDN URL at which the entire html content can be fetched from.
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
Details containing the creator of custom page.
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
Timestamp which represent the time when data was created.
modified_on
string
| date-time
Timestamp which represent when was the last time when data was updated.
description
string
Description about the page.
feature_image
object (Asset)
Asset
aspect_ratio
string
Aspect ratio of the image.
id
string
Unique identifier for an entry.
secure_url
string
URL of the image.
page_meta
array of object
List of Custom JSON object for specific use cases.
_schedule
object (ScheduleSchema)
ScheduleSchema
cron
string
String representing the cron expression.
start
string
Start time of schedule.
end
string
End time of schedule.
duration
number
Duration of the scheduled entity.
next_schedule
array of object (NextSchedule)
Details regarding the next trigger point of schedule.
Array of NextSchedule
start
string
Start time of next trigger point of schedule.
end
string
End time of next trigger point of schedule.
_custom_json
object
Custom JSON object for specific use cases.
orientation
string
Orientation for Custom Pages - Landscape or portrait.
platform
string
Platform for Custom Pages - Denotes the device type.
published
boolean
Whether page is active or not on website.
slug
string
A short, human-readable, URL-friendly identifier.
tags
array of string
Tags under a page.
title
string
The title of the page.
type
string
Type of editor through which the page was created so appropriate rendering engine is used.
seo
object (SEO)
SEO
description
string
The contents of og:description.
image
object (SEOImage)
SEOImage
url
string
The url of image.
title
string
The contents of og:title.
meta_tags
array of object (SEOMetaItem)
List of meta tags.
Array of SEOMetaItem
title
string
Title of the custom meta tags group.
items
array of object (SEOMetaItems)
List of key value pairs to power meta tags.
Array of SEOMetaItems
key
string
The key denoting the attribute name of SEO meta tag.
value
string
The key denoting the attribute value of SEO meta tag.
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
Value of sitemap priority randing from 0.0 to 1.0.
frequency
string
Value of sitemap frequency change denoting how frequently the content changes.
breadcrumb
array of object (SEObreadcrumb)
List of action objects which can power breadcrumbs on website.
Array of SEObreadcrumb
url
string
URL of where the breadcrumb link redirects to.
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
canonical_url
string
The canonical URL for canonical link element.
visibility
object
Visibility of Page.
archived
boolean
Flag denoting whether the page is archived or not.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v2.0/pages
Loading...
Response
Loading...

Sales Channel SEO

SEO (Search Engine Optimization) encompasses a holistic approach to optimizing a website's digital footprint for enhanced search engine visibility and user engagement. This involves meticulously crafting title tags, meta descriptions, and meta tags to accurately represent page content and entice clicks in search results. Sellers also fine-tune their robots.txt file to control search engine crawlers' access to specific pages, ensuring indexation of relevant content while safeguarding private information. Additionally, sellers generate comprehensive sitemaps to facilitate search engine discovery and efficient indexing of all site pages. Furthermore, leveraging structured data markup such as SEO schema markup enriches search results with additional context, enhancing the appearance and relevance of listings.

Operations
GET
/service/application/content/v1.0/seo
# Get SEO settings
GET
/service/application/content/v1.0/seo/schema
# List SEO Markup schemas
GET

Get SEO settings

Get search engine optimization configurations of an application. Details include the title, description and an image.
Parameters
No Parameters
Response
200
4XX
Success. Returns a JSON object SEO details such as robots.txt, meta-tags, and sitemap. Check the example shown below or refer `SeoComponent` for more details.
SeoComponent
seo
object (SeoSchema)
SeoSchema
app
string
Application ID - Identifier for a Sales channel.
_id
string
Unique identifier of an entry.
robots_txt
string
Contents of robots.txt file of a sales channel.
sitemap_enabled
boolean
Whether sitemaps is enabled or not for a sales channel's website.
additonal_sitemap
string
Contents of additional sitemap.
cannonical_enabled
boolean
Whether canonical tags is enabled or not for a sales channel's website.
Default Value : false
custom_meta_tags
array of object (CustomMetaTag)
Custom meta tags for a sales channel website.
Array of CustomMetaTag
name
string
Name of the custom meta tag group.
content
string
Contents of the custom meta tag group.
_id
string
Unique identifier of an entry.
details
object (Detail)
Detail
title
string
Contents of the og:title of a sales channel website.
description
string
Contents of the og:description of a sales channel website.
image_url
string
URL of the og:image of a sales channel website.
created_at
string
| date-time
Timestamp which represent the time when data was created.
updated_at
string
| date-time
Timestamp which represent when was the last time when data was updated.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/seo
Loading...
Response
Loading...
GET

List SEO Markup schemas

Get all SEO Markup schema Templates setup for an application.
Parameters
page_type
string
The type of page against which schema template was created.
Enum
active
boolean
Boolean value for fetching seo schema.
Default Value : true
Response
200
4XX
Success. Refer `SeoSchemaComponent` for more details.
SeoSchemaComponent
items
array of object (SEOSchemaMarkupTemplate)
List of SEO Markup Schemas for a sales channel website.
Array of SEOSchemaMarkupTemplate
id
string
Unique identifier for an entry.
title
string
Title of the SEO Schema template.
page_type
string
Page Type for the SEO Schema Template where it'll be rendered.
Enum
description
string
Description of the SEO Schema Template.
schema
string
Contents of the SEO Schema template in nunjucks format.
active
boolean
Whether SEO Schema template is active or not.
created_at
string
| date-time
Timestamp which represent the time when data was created.
updated_at
string
| date-time
Timestamp which represent when was the last time when data was updated.
application
string
Application ID - Identifier for a Sales channel.
Examples
Parameters
page_type:
"value"
active:
false
GET
/service/application/content/v1.0/seo/schema
Loading...
Response
Loading...

Slideshow

With Slideshow module, users can enhance the visual appeal of their storefronts during idle times. They have the flexibility to display static images or videos, allowing them to showcase their best-selling products, promotions, or brand messaging. Whether it's a captivating product image or an engaging brand video, users can easily upload and manage their content through the Platform panel. This module helps them make a lasting impression on potential customers, even when they're not actively browsing the store.

Operations
GET
/service/application/content/v1.0/slideshow
# List Slideshows
GET
/service/application/content/v1.0/slideshow/{slug}
# Get a Slideshow
GET

List Slideshows

List slideshows along with their details.
Parameters
page_no
integer
The page number to navigate through the given set of results. Default value is 1. .
Default Value : 1
page_size
integer
The number of items to retrieve in each page.
Default Value : 10
Response
200
4XX
Success. Check the example shown below or refer `SlideshowGetDetails` for more details.
SlideshowGetDetails
items
array of object (SlideshowSchema)
Details related to slideshow/screensaver.
Array of SlideshowSchema
_id
string
Unique identifier of an entry.
slug
string
Details related to slideshow/screensaver.
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
Timestamp which represent the time when data was created.
modified_on
string
| date-time
Timestamp which represent when was the last time when data was updated.
application
string
Application ID - Identifier for a Sales channel.
platform
string
Details related to slideshow/screensaver.
configuration
object (ConfigurationSchema)
ConfigurationSchema
sleep_time
integer
Amount of time in seconds after which slideshow/screensaver is run.
start_on_launch
boolean
Flag denoting whether screensaver needs to be shown on launch of website/app.
duration
integer
Duration of the slideshow/screensaver.
slide_direction
string
Direction of the slideshow.
media
array of object (SlideshowMedia)
Details related to slideshow/screensaver.
Array of SlideshowMedia
type
string
Type of Media.
url
string
URL of Media where it's hosted.
bg_color
string
Background colour of Media.
duration
integer
Amount of time in seconds for which Media has to appear.
auto_decide_duration
boolean
Whether the duration for each media is to be decided by system or not. If true, it'll equally divide time in all medias.
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
active
boolean
Details related to slideshow/screensaver.
archived
boolean
Whether slideshow is deleted or not.
_custom_json
object
Custom JSON object for specific use cases.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/slideshow
Loading...
Response
Loading...
GET

Get a Slideshow

Get a slideshow using its `slug`.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a slideshow. You can get slug value from the endpoint /service/application/content/v1.0/slideshow/.
Response
200
4XX
Success. Returns the details of how a slideshow is configured. Check the example shown below or refer `SlideshowSchema` for more details.
SlideshowSchema
_id
string
Unique identifier of an entry.
slug
string
Details related to slideshow/screensaver.
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
Timestamp which represent the time when data was created.
modified_on
string
| date-time
Timestamp which represent when was the last time when data was updated.
application
string
Application ID - Identifier for a Sales channel.
platform
string
Details related to slideshow/screensaver.
configuration
object (ConfigurationSchema)
ConfigurationSchema
sleep_time
integer
Amount of time in seconds after which slideshow/screensaver is run.
start_on_launch
boolean
Flag denoting whether screensaver needs to be shown on launch of website/app.
duration
integer
Duration of the slideshow/screensaver.
slide_direction
string
Direction of the slideshow.
media
array of object (SlideshowMedia)
Details related to slideshow/screensaver.
Array of SlideshowMedia
type
string
Type of Media.
url
string
URL of Media where it's hosted.
bg_color
string
Background colour of Media.
duration
integer
Amount of time in seconds for which Media has to appear.
auto_decide_duration
boolean
Whether the duration for each media is to be decided by system or not. If true, it'll equally divide time in all medias.
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
active
boolean
Details related to slideshow/screensaver.
archived
boolean
Whether slideshow is deleted or not.
_custom_json
object
Custom JSON object for specific use cases.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/slideshow/{slug}
Loading...
Response
Loading...