Skip to main content

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
5XX
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
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.
Was this section helpful?
GET
/service/application/content/v1.0/announcements
Loading...
Response
Example response not available.

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 all 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/.
rootId
string
ID given to the HTML element
Response
200
4XX
5XX
Success. Returns a JSON object with blog details. Check the example shown below or refer `BlogSchema` for more details.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
content
array of object (ResourceContent)
Array of ResourceContent
feature_image
object (Asset)
Asset
published
boolean
reading_time
string
slug
string
tags
array of string
publish_date
string
seo
object (SEO)
SEO
_schedule
object (CronSchedule)
CronSchedule
title
string
date_meta
object (DateMeta)
DateMeta
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/content/v1.0/blogs/{slug}
Loading...
Response
Example response not available.
GET

List blogs

List all the blogs against an application
Parameters
pageNo
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
pageSize
integer
The number of items to retrieve in each page.
Default Value : 10
Response
200
4XX
5XX
Success. Check the example shown below or refer `BlogGetResponse` for more details.
BlogGetResponse
items
array of object (BlogSchema)
Array of BlogSchema
page
object (Page)
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/content/v1.0/blogs/
Loading...
Response
Example response not available.

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/v1.0/metafields/{resource}/{resource_id}
# Get list of custom fields
GET

Get list of custom fields

Retrieves a list of custom fields attached to a particular resource by using the resource.
Parameters
resource
string
Required
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resourceId
string
Required
This is the resource id for which custom fields created
Response
200
4XX
5XX
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Array of CustomFieldSchema
Examples
Parameters
resource:
"product"
resourceId:
"64bb987e9a3c4b6c29d676bc"
Was this section helpful?
GET
/service/application/content/v1.0/metafields/{resource}/{resource_id}
Loading...
Response
Example response not available.

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/v1.0/metaobjects/{metaobject_id}
# Get custom object
GET

Get custom object

Details of custom objects, their field details, definitions, and references can be obtained using this endpoint.
Parameters
metaobjectId
string
Required
This is meta object id
Response
200
4XX
5XX
Success. Returns a custom object. Refer `CustomObjectByIdSchema` for more details.
CustomObjectByIdSchema
_id
string
status
string
display_name
string
definition
object (CustomObjectListItemDefinationSchema)
CustomObjectListItemDefinationSchema
references
array of Undefined Type
fields
array of object (CustomObjectFieldSchema)
Array of CustomObjectFieldSchema
Examples
Parameters
metaobjectId:
"65392bd912376081aafa90ff"
Was this section helpful?
GET
/service/application/content/v1.0/metaobjects/{metaobject_id}
Loading...
Response
Example response not available.

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
5XX
Success. Returns all support information including email and phone number. Check the example shown below or refer `Support` for more details.
Support
created
boolean
_id
string
config_type
string
application
string
created_at
string
updated_at
string
contact
object (ContactSchema)
ContactSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/content/v1.0/support
Loading...
Response
Example response not available.

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
5XX
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)
Array of DataLoaderSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
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 a list of frequently asked questions and ansers
Parameters
No Parameters
Response
200
4XX
5XX
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)
Array of FaqSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/content/v1.0/faq
Loading...
Response
Example response not available.
GET

List FAQ Categories

Lists categories for organizing FAQs.
Parameters
No Parameters
Response
200
4XX
5XX
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)
Array of CategorySchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
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
5XX
Success. Returns a question and answer by its slug. Check the example shown below or refer `FaqSchema` for more details.
FaqSchema
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
Examples
Parameters
slug:
"value"
Was this section helpful?
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
5XX
Success. Returns a FAQ category with its slug. Check the example shown below or refer `GetFaqCategoryBySlugSchema` for more details.
GetFaqCategoryBySlugSchema
category
object (FAQCategorySchema)
FAQCategorySchema
Examples
Parameters
slug:
"value"
Was this section helpful?
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
5XX
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)
Array of FaqSchema
Examples
Parameters
slug:
"value"
Was this section helpful?
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
5XX
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
_id
string
tags
array of object (TagSchema)
Array of TagSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
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

Gets the content of the application's landing page.
Parameters
No Parameters
Response
200
4XX
5XX
Success. Returns the landing page details. Check the example shown below or refer `LandingPageSchema` for more details.
LandingPageSchema
slug
string
action
object (Action)
Action
platform
array of string
created_by
object (CreatedBySchema)
CreatedBySchema
date_meta
object (DateMeta)
DateMeta
_id
string
application
string
archived
boolean
_custom_json
object
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/content/v1.0/landing-page
Loading...
Response
Example response not available.

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
5XX
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
tnc
string
policy
string
shipping
string
returns
string
faq
array of object (ApplicationLegalFAQ)
Array of ApplicationLegalFAQ
_id
string
updated_at
string
| date-time
created_at
string
| date-time
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/content/v1.0/legal
Loading...
Response
Example response not available.

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/.
rootId
string
ID given to the HTML element
Response
200
4XX
5XX
Success. Returns a JSON object with page details. Check the example shown below or refer `CustomPageSchema` for more details.
PageSchema
_id
string
application
string
component_ids
array of string
Components can be used to store multiple components
content
array of object
content_path
string
created_by
object (CreatedBySchema)
CreatedBySchema
date_meta
object (DateMeta)
DateMeta
description
string
feature_image
object (Asset)
Asset
page_meta
array of object
_schedule
object (ScheduleSchema)
ScheduleSchema
_custom_json
object
orientation
string
platform
string
published
boolean
slug
string
tags
array of string
title
string
type
string
seo
object (SEO)
SEO
visibility
object
archived
boolean
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/content/v2.0/pages/{slug}
Loading...
Response
Example response not available.
GET

Lists pages

Lists all Custom Pages
Parameters
pageNo
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
pageSize
integer
The number of items to retrieve in each page.
Default Value : 10
Response
200
4XX
5XX
Success. Returns a list of pages along with their details. Check the example shown below or refer `PageGetStorefrontResponse` for more details.
PageGetResponse
items
array of object (PageSchema)
Array of PageSchema
page
object (Page)
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/content/v2.0/pages/
Loading...
Response
Example response not available.

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
5XX
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
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/content/v1.0/seo
Loading...
Response
Example response not available.
GET

List SEO Markup schemas

Get all SEO Markup schema Templates setup for an application
Parameters
pageType
string
The type of page against which schema template was created
active
boolean
Boolean value for fetching seo schema.
Default Value : true
Response
200
4XX
5XX
Success. Refer `SeoSchemaComponent` for more details.
SeoSchemaComponent
items
array of object (SEOSchemaMarkupTemplate)
Array of SEOSchemaMarkupTemplate
Examples
Parameters
pageType:
"value"
active:
false
Was this section helpful?
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

Get a list of slideshows along with their details.
Parameters
pageNo
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
pageSize
integer
The number of items to retrieve in each page.
Default Value : 10
Response
200
4XX
5XX
Success. Check the example shown below or refer `SlideshowGetResponse` for more details.
SlideshowGetResponse
items
array of object (SlideshowSchema)
Array of SlideshowSchema
page
object (Page)
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/content/v1.0/slideshow/
Loading...
Response
Example response not available.
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
5XX
Success. Returns the details of how a slideshow is configured. Check the example shown below or refer `SlideshowSchema` for more details.
SlideshowSchema
_id
string
slug
string
date_meta
object (DateMeta)
DateMeta
application
string
platform
string
configuration
object (ConfigurationSchema)
ConfigurationSchema
media
array of object (SlideshowMedia)
Array of SlideshowMedia
active
boolean
archived
boolean
_custom_json
object
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/content/v1.0/slideshow/{slug}
Loading...
Response
Example response not available.