Content

This API provides operations for managing translations and application languages within Fynd Commerce.

Announcement

Announcement

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

List announcements

List all current announcements in the application.
Parameters
No Parameters
GET
/service/application/content/v1.0/announcements
Loading...
Response
200
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.
Hide
Details related to announcement bar and its contents.
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.
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
slugpath
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_idquery
string
ID given to the HTML element.
previewquery
boolean
Boolean value to get the preview for the blogs.
GET
/service/application/content/v1.0/blogs/{slug}
Loading...
Response
200
Success. Returns a JSON object with blog details. Check the example shown below or refer `BlogSchema` for more details.
Hide
All relevant data related to a blog.
_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)
Show
content
array of object (ResourceContent)
Contents of blog.
Show
feature_image
object (Asset)
Show
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)
Show
title
string
Title of the Blog.
date_meta
object (DateMeta)
Show
summary
string
A brief description of blog.
Examples
Parameters
Parameters are not required.
Response
Loading...
GET

List blogs

List all the blogs against an application.
Parameters
page_noquery
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_sizequery
integer
The number of items to retrieve in each page.
Default Value : 10
tagsquery
string
Blogs retrieve based on the list of tags passed.
searchquery
string
Blogs retrieve based on the title.
GET
/service/application/content/v1.0/blogs
Loading...
Response
200
Success. Check the example shown below or refer `BlogGetDetails` for more details.
Hide
Blogs live on a sales channel.
items
array of object (BlogSchema)
List of blogs with details.
Show
page
object (Page)
Show
filters
object (BlogFilters)
Show
Examples
Parameters
Parameters are not required.
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
/service/application/content/v2.0/customfields/resource/{resource}
# Get bulk list of custom fields of given resource
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
resourcepath
string
Required
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resource_slugpath
string
Required
This is the resource id for which custom fields created
GET
/service/application/content/v2.0/customfields/resource/{resource}/{resource_slug}
Loading...
Response
200
400
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
Hide
Object containing a list of custom fields against a resource.
items
array of object (CustomFieldSchema)
List of custom fields against a resource.
Show
Response
Loading...
GET

Get bulk list of custom fields of given resource

Retrieves a bulk list of custom fields attached to a particular resource by using the resource and resource IDs. The resource_ids query parameter is required and can accept multiple comma-separated values. Optional filters for keys and namespaces can also be applied.
Parameters
resourcepath
string
Required
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resource_idsquery
string
Required
This is the resource ids for which custom fields created with comma separated.
keysquery
string
Filter custom fields by specific keys (slugs). Multiple values can be provided as comma-separated.
namespacesquery
string
Filter custom fields by specific namespaces. Multiple values can be provided as comma-separated.
GET
/service/application/content/v2.0/customfields/resource/{resource}
Loading...
Response
200
400
Returns a bulk list of custom fields grouped by resource IDs. Refer `BulkCustomFieldsResponseByResourceSchema` for more details.
Hide
Object containing a bulk list of custom fields grouped by resource IDs. Each item represents a resource with its associated custom fields.
items
array of object (ResourceCustomFieldsSchema)
List of resources with their custom fields.
Show
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_slugpath
string
Required
Slug of Meta object definition
slugpath
string
Required
Slug of Meta object
GET
/service/application/content/v2.0/customobjects/definition/{definition_slug}/entries/{slug}
Loading...
Response
200
400
Success. Returns a custom object. Refer `CustomObjectByIdSchema` for more details.
Hide
Object containing custom object along with it's custom fields.
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)
Show
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.
Show
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
GET
/service/application/content/v1.0/support
Loading...
Response
200
Success. Returns all support information including email and phone number. Check the example shown below or refer `Support` for more details.
Hide
Object containing support contact related details.
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)
Show
Examples
Parameters
Parameters are not required.
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
GET
/service/application/content/v1.0/data-loader
Loading...
Response
200
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.
Hide
List of data loaders.
items
array of object (DataLoaderSchema)
List of data loaders.
Show
Examples
Parameters
Parameters are not required.
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
GET
/service/application/content/v1.0/faq
Loading...
Response
200
Success. Returns a JSON object with question and answers. Check the example shown below or refer `FaqResponseSchema` for more details.
Hide
Details regarding Frequently asked questions and Answers.
faqs
array of object (FaqSchema)
List of FAQs.
Show
Examples
Parameters
Parameters are not required.
Response
Loading...
GET

List FAQ Categories

List categories for organizing FAQs.
Parameters
No Parameters
GET
/service/application/content/v1.0/faq/categories
Loading...
Response
200
Success. Returns a JSON object with categories of FAQ. Check the example shown below or refer `GetFaqCategoriesSchema` for more details.
Hide
List of FAQ Categories.
categories
array of object (CategorySchema)
List of FAQ Categories.
Show
Examples
Parameters
Parameters are not required.
Response
Loading...
GET

Get FAQ

Get a specific FAQ using its slug identifier.
Parameters
slugpath
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.
GET
/service/application/content/v1.0/faq/{slug}
Loading...
Response
200
Success. Returns a question and answer by its slug. Check the example shown below or refer `FaqSchema` for more details.
Hide
Details related to 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.
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"
Response
Loading...
GET

Get a FAQ category

Get a specific FAQ category using its slug.
Parameters
slugpath
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.
GET
/service/application/content/v1.0/faq/category/{slug}
Loading...
Response
200
Success. Returns a FAQ category with its slug. Check the example shown below or refer `GetFaqCategoryBySlugSchema` for more details.
Hide
List of FAQ Categories.
category
object (FAQCategorySchema)
Show
Examples
Parameters
slug:
"value"
Response
Loading...
GET

List FAQs by category

Get FAQs belonging to a specific category slug.
Parameters
slugpath
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.
GET
/service/application/content/v1.0/faq/category/{slug}/faqs
Loading...
Response
200
Success. Returns a categorized list of question and answers using its slug. Check the example shown below or refer `GetFaqSchema` for more details.
Hide
List of FAQs.
faqs
array of object (FaqSchema)
List of FAQs.
Show
Examples
Parameters
slug:
"value"
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
GET
/service/application/content/v1.0/tags
Loading...
Response
200
Success. Returns a JSON object containing all the tags injected in the application. Check the example shown below or refer `TagsSchema` for more details.
Hide
Data related to Third party injectable html tags.
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.
Show
Examples
Parameters
Parameters are not required.
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
GET
/service/application/content/v1.0/landing-page
Loading...
Response
200
Success. Returns the landing page details. Check the example shown below or refer `LandingPageSchema` for more details.
Hide
Details contains data related to landing page.
slug
string
A short, human-readable, URL-friendly identifier.
action
object (Action)
Show
platform
array of string
List of platforms linked to this landing page.
created_by
object (CreatedBySchema)
Show
date_meta
object (DateMeta)
Show
_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.
Response
Loading...

Legal Page

Legal Page

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
GET
/service/application/content/v1.0/legal
Loading...
Response
200
Success. Returns the T&C, Shipping Policy, Privacy Policy and Return Policy. Check the example shown below or refer `ApplicationLegal` for more details.
Hide
Object containing all legal related contents.
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.
Show
_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.
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
slugpath
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_idquery
string
ID given to the HTML element.
GET
/service/application/content/v2.0/pages/{slug}
Loading...
Response
200
Success. Returns a JSON object with page details. Check the example shown below or refer `CustomPageSchema` for more details.
Hide
Details related to a custom page and contents.
_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)
Show
date_meta
object (DateMeta)
Show
description
string
Description about the page.
feature_image
object (Asset)
Show
page_meta
array of object
List of Custom JSON object for specific use cases.
_schedule
object (ScheduleSchema)
Show
_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)
Show
visibility
object
Visibility of Page.
archived
boolean
Flag denoting whether the page is archived or not.
Examples
Parameters
Parameters are not required.
Response
Loading...
GET

Lists pages

Lists all Custom Pages.
Parameters
page_noquery
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_sizequery
integer
The number of items to retrieve in each page.
Default Value : 10
GET
/service/application/content/v2.0/pages
Loading...
Response
200
Success. Returns a list of pages along with their details. Check the example shown below or refer `PageGetStorefrontResponse` for more details.
Hide
Object containing list of custom pages with all details and paginated data.
items
array of object (PageSchema)
List of details of custom pages.
Show
page
object (Page)
Show
Examples
Parameters
Parameters are not required.
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
GET
/service/application/content/v1.0/seo
Loading...
Response
200
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.
Hide
Object containing all data related to SEO for a sales channel website.
seo
object (SeoSchema)
Show
Examples
Parameters
Parameters are not required.
Response
Loading...
GET

List SEO Markup schemas

Get all SEO Markup schema Templates setup for an application.
Parameters
page_typequery
object (PageType)
The type of page against which schema template was created.
Enum
activequery
boolean
Boolean value for fetching seo schema.
Default Value : true
GET
/service/application/content/v1.0/seo/schema
Loading...
Response
200
Success. Refer `SeoSchemaComponent` for more details.
Hide
SEO Markup Schemas for a sales channel website.
items
array of object (SEOSchemaMarkupTemplate)
List of SEO Markup Schemas for a sales channel website.
Show
Examples
Parameters
page_type:
"default"
active:
false
Response
Loading...