Content

The Content module manages content in the application. Use it to help users stay updated with announcements, read blog posts, manage data loaders, consult FAQs, and access legal and support information. It also enhances navigation modules and SEO capabilities for better online visibility, as well as supports slideshow interactions.

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

FDK Method Name: getAnnouncements
List all current announcements in the application.
Parameters
No Parameters
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.
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.
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

FDK Method Name: getBlog
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
Response
200
404
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
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
tags
array of string
publish_date
string
| date-time
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumbs
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
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
value
string
The value for the action.
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
value
string
The value for the action.
canonical_url
string
title
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
summary
string
status
string
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
slug:
"Test10"
GET
/service/application/content/v1.0/blogs/{slug}
Loading...
Response
Loading...
GET

List blogs

FDK Method Name: getBlogs
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
Success. Check the example shown below or refer `BlogGetResponseSchema` for more details.
BlogGetResponseSchema
items
array of object (BlogSchema)
Array of BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
tags
array of string
publish_date
string
| date-time
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumbs
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
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
value
string
The value for the action.
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
value
string
The value for the action.
canonical_url
string
title
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
summary
string
status
string
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
next
string
Nullable
Cursor token for the next page (alias for next_id used by search services).
item_count
integer
| int32
The number of items returned on the current 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.
limit
integer
| int32
The maximum number of items to be returned per page.
total
integer
| int32
Total number of items.
filters
object (BlogFilters)
BlogFilters
tags
array of string
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

FDK Method Name: getCustomFieldsByResourceId
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
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.
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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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

FDK Method Name: getCustomObjectBySlug
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
404
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.
type
string
Data type of custom field inside custom object.
definition_id
string
Definition id of custom field inside custom object.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
definition_slug:
"address"
slug:
"jaipur"
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

FDK Method Name: getSupportInformation
Get customer support contact details. Contact Details can be either a phone number or an email-id or both.
Parameters
No Parameters
Response
200
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
application
string
created_at
string
| date-time
updated_at
string
| date-time
contact
object (ContactSchema)
ContactSchema
phone
object (PhoneSchema)
PhoneSchema
active
boolean
phone
array of object (PhoneProperties)
Array of PhoneProperties
key
string
code
string
number
string
phone_type
string
Enum
email
object (EmailSchema)
EmailSchema
active
boolean
email
array of object (EmailProperties)
Array of EmailProperties
key
string
value
string
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

FDK Method Name: getDataLoaders
List all the data loaders that are enabled for an application.
Parameters
No Parameters
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.
DataLoadersSchema
items
array of object (DataLoaderSchema)
Array of DataLoaderSchema
name
string
service
string
operation_id
string
type
string
Enum
is_selected
boolean
created_at
string
| date-time
modified_at
string
| date-time
company
string
application
string
url
string
content
string
__source
object (DataLoaderSourceSchema)
DataLoaderSourceSchema
type
string
id
string
_id
string
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/data-loader
Loading...
Response
Loading...

Dynamic FAQ

Dynamic FAQ provides order-status-aware FAQ trees for customer self-service. Storefront endpoints return the configuration and status-to-question-tree mappings for the current application. Trees support up to 3 levels of nesting with answers only at leaf nodes.

Operations
GET
/service/application/content/v1.0/dynamic-faq/config
# Get Dynamic FAQ config
GET
/service/application/content/v1.0/dynamic-faq/mappings
# List Dynamic FAQ mappings
GET
/service/application/content/v1.0/dynamic-faq/mappings/{id}
# Get Dynamic FAQ mapping by ID
GET

Get Dynamic FAQ config

FDK Method Name: getStorefrontDynamicFaqConfig
Get the Dynamic FAQ configuration for the application, including chat/callback settings, default FAQ, and catalog filters.
Parameters
No Parameters
Response
200
Success. Returns the full Dynamic FAQ configuration or null if not configured.
Properties
data
object (DynamicFaqConfigurationDocument)
Nullable
DynamicFaqConfigurationDocument
_id
string
Unique identifier of the configuration document.
application
string
Application ID this configuration belongs to.
chat
object (DynamicFaqChatCallbackConfig)
DynamicFaqChatCallbackConfig
enabled
boolean
Whether this support channel (chat or callback) is active.
disable_time
string
Nullable
Time window when this channel is offline, in HH:MM-HH:MM format (e.g. 22:00-08:00).
enable_message
string
Nullable
Message shown to customers when this channel is available.
disable_message
string
Nullable
Message shown to customers when this channel is unavailable.
time_disable_message
string
Nullable
Message shown during the disable_time window.
callback
object (DynamicFaqChatCallbackConfig)
DynamicFaqChatCallbackConfig
enabled
boolean
Whether this support channel (chat or callback) is active.
disable_time
string
Nullable
Time window when this channel is offline, in HH:MM-HH:MM format (e.g. 22:00-08:00).
enable_message
string
Nullable
Message shown to customers when this channel is available.
disable_message
string
Nullable
Message shown to customers when this channel is unavailable.
time_disable_message
string
Nullable
Message shown during the disable_time window.
default_faq
object (DynamicFaqDefaultFaq)
DynamicFaqDefaultFaq
enabled
boolean
Whether the default FAQ fallback is active.
question
string
The default question text displayed to the customer.
answer
string
Nullable
The default answer text displayed when the customer selects this question.
chat_enabled
boolean
Whether to show the chat option alongside this default FAQ.
callback_enabled
boolean
Whether to show the callback option alongside this default FAQ.
cancellation_question_uid
string
Nullable
UID of the question node used for order cancellation flows.
luxury_catalog_ids
array of string
List of catalog IDs classified as luxury.
mass_catalog_name
string
Nullable
Name of the mass/general catalog for non-luxury items.
created_at
string
| date-time
Timestamp when the document was created.
updated_at
string
| date-time
Timestamp when the document was last updated.
__v
number
Mongoose version key.
error
object
Nullable
meta
object
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/dynamic-faq/config
Loading...
Response
Loading...
GET

List Dynamic FAQ mappings

FDK Method Name: getStorefrontDynamicFaqMappings
Get all Dynamic FAQ status-to-question-tree mappings for the current application, with optional filters. Returns the full question tree in a single response.
Parameters
status
string
Filter by order status code (e.g. SHIPPED, DELIVERED).
channel
string
Filter by channel (DESKTOP, MOBILE, APP).
Enum
Response
200
Success. Returns the full question tree in a single response.
Properties
data
array of object (DynamicFaqMappingSchema)
Array of DynamicFaqMappingSchema
_id
string
Unique identifier of the mapping document.
application
string
Application ID this mapping belongs to.
status_code
string
Order status code this mapping applies to (e.g. SHIPPED, DELIVERED, REFUND_INITIATED).
channel
string
Device channel this mapping targets.
Enum
quick_links
array of object (DynamicFaqQuickLinkL1)
Tree of question nodes (max 3 levels deep, answers only at leaf nodes).
Array of DynamicFaqQuickLinkL1
_id
string
Unique identifier of this node.
question
string
The top-level question text displayed to the customer.
priority
number
Display order priority (lower values appear first).
chat_enabled
boolean
Whether to show the chat option when this question is selected.
callback_enabled
boolean
Whether to show the callback option when this question is selected.
validation_enabled
boolean
Whether input validation is required before proceeding from this node.
restricted_payment_mode
string
Nullable
Show this question only for orders with this specific payment mode.
available_statuses
array of string
Show this question only for specific order sub-statuses.
answer
object (DynamicFaqAnswerItem)
Nullable
The answer content for leaf nodes. Null for branch nodes with children.
DynamicFaqAnswerItem
content
string
The answer text shown to the customer.
payment_mode_filter
string
Nullable
Show this answer only for a specific payment mode.
is_complaint
boolean
Whether this answer represents a customer complaint that may require escalation.
ticket_category
string
Nullable
Pre-fills ticket category when customer raises a support ticket.
ticket_sub_category
string
Nullable
Pre-fills ticket sub-category.
ticket_leaf_category
string
Nullable
Pre-fills ticket leaf category.
work_group
string
Nullable
Support work group to route the ticket to.
resolution_days
number
Nullable
Expected resolution time in days.
attachment_required
boolean
Whether the storefront should prompt the customer to upload an attachment.
children
array of object (DynamicFaqQuickLinkL2)
Sub-questions at level 2. Empty if this node is a leaf.
Array of DynamicFaqQuickLinkL2
_id
string
Unique identifier of this node.
question
string
The question text displayed to the customer at this tree level.
priority
number
Display order priority (lower values appear first).
chat_enabled
boolean
Whether to show the chat option when this question is selected.
callback_enabled
boolean
Whether to show the callback option when this question is selected.
validation_enabled
boolean
Whether input validation is required before proceeding from this node.
restricted_payment_mode
string
Nullable
Show this question only for orders with this specific payment mode.
available_statuses
array of string
Show this question only for specific order sub-statuses.
answer
object (DynamicFaqAnswerItem)
Nullable
The answer content for leaf nodes. Null for branch nodes with children.
DynamicFaqAnswerItem
content
string
The answer text shown to the customer.
payment_mode_filter
string
Nullable
Show this answer only for a specific payment mode.
is_complaint
boolean
Whether this answer represents a customer complaint that may require escalation.
ticket_category
string
Nullable
Pre-fills ticket category when customer raises a support ticket.
ticket_sub_category
string
Nullable
Pre-fills ticket sub-category.
ticket_leaf_category
string
Nullable
Pre-fills ticket leaf category.
work_group
string
Nullable
Support work group to route the ticket to.
resolution_days
number
Nullable
Expected resolution time in days.
attachment_required
boolean
Whether the storefront should prompt the customer to upload an attachment.
children
array of object (DynamicFaqQuickLinkL3)
Sub-questions at level 3. Empty if this node is a leaf.
Array of DynamicFaqQuickLinkL3
_id
string
Unique identifier of this node.
question
string
The question text displayed to the customer at this tree level.
priority
number
Display order priority (lower values appear first).
chat_enabled
boolean
Whether to show the chat option when this question is selected.
callback_enabled
boolean
Whether to show the callback option when this question is selected.
validation_enabled
boolean
Whether input validation is required before proceeding from this node.
restricted_payment_mode
string
Nullable
Show this question only for orders with this specific payment mode.
available_statuses
array of string
Show this question only for specific order sub-statuses.
answer
object (DynamicFaqAnswerItem)
Nullable
The answer content shown when the customer selects this leaf question. Null for branch nodes.
DynamicFaqAnswerItem
content
string
The answer text shown to the customer.
payment_mode_filter
string
Nullable
Show this answer only for a specific payment mode.
is_complaint
boolean
Whether this answer represents a customer complaint that may require escalation.
ticket_category
string
Nullable
Pre-fills ticket category when customer raises a support ticket.
ticket_sub_category
string
Nullable
Pre-fills ticket sub-category.
ticket_leaf_category
string
Nullable
Pre-fills ticket leaf category.
work_group
string
Nullable
Support work group to route the ticket to.
resolution_days
number
Nullable
Expected resolution time in days.
attachment_required
boolean
Whether the storefront should prompt the customer to upload an attachment.
children
array of object
Always empty at level 3 (deepest level).
created_at
string
| date-time
Timestamp when the document was created.
updated_at
string
| date-time
Timestamp when the document was last updated.
__v
number
Mongoose version key.
error
object
Nullable
meta
object
Examples
Parameters
status:
"SHIPPED"
GET
/service/application/content/v1.0/dynamic-faq/mappings
Loading...
Response
Loading...
GET

Get Dynamic FAQ mapping by ID

FDK Method Name: getStorefrontDynamicFaqMappingById
Get a specific Dynamic FAQ mapping by its ID, including the full question tree.
Parameters
id
string
Required
Unique ID of the Dynamic FAQ mapping.
Response
200
404
Success. Returns the full question tree.
Properties
data
object (DynamicFaqMappingSchema)
DynamicFaqMappingSchema
_id
string
Unique identifier of the mapping document.
application
string
Application ID this mapping belongs to.
status_code
string
Order status code this mapping applies to (e.g. SHIPPED, DELIVERED, REFUND_INITIATED).
channel
string
Device channel this mapping targets.
Enum
quick_links
array of object (DynamicFaqQuickLinkL1)
Tree of question nodes (max 3 levels deep, answers only at leaf nodes).
Array of DynamicFaqQuickLinkL1
_id
string
Unique identifier of this node.
question
string
The top-level question text displayed to the customer.
priority
number
Display order priority (lower values appear first).
chat_enabled
boolean
Whether to show the chat option when this question is selected.
callback_enabled
boolean
Whether to show the callback option when this question is selected.
validation_enabled
boolean
Whether input validation is required before proceeding from this node.
restricted_payment_mode
string
Nullable
Show this question only for orders with this specific payment mode.
available_statuses
array of string
Show this question only for specific order sub-statuses.
answer
object (DynamicFaqAnswerItem)
Nullable
The answer content for leaf nodes. Null for branch nodes with children.
DynamicFaqAnswerItem
content
string
The answer text shown to the customer.
payment_mode_filter
string
Nullable
Show this answer only for a specific payment mode.
is_complaint
boolean
Whether this answer represents a customer complaint that may require escalation.
ticket_category
string
Nullable
Pre-fills ticket category when customer raises a support ticket.
ticket_sub_category
string
Nullable
Pre-fills ticket sub-category.
ticket_leaf_category
string
Nullable
Pre-fills ticket leaf category.
work_group
string
Nullable
Support work group to route the ticket to.
resolution_days
number
Nullable
Expected resolution time in days.
attachment_required
boolean
Whether the storefront should prompt the customer to upload an attachment.
children
array of object (DynamicFaqQuickLinkL2)
Sub-questions at level 2. Empty if this node is a leaf.
Array of DynamicFaqQuickLinkL2
_id
string
Unique identifier of this node.
question
string
The question text displayed to the customer at this tree level.
priority
number
Display order priority (lower values appear first).
chat_enabled
boolean
Whether to show the chat option when this question is selected.
callback_enabled
boolean
Whether to show the callback option when this question is selected.
validation_enabled
boolean
Whether input validation is required before proceeding from this node.
restricted_payment_mode
string
Nullable
Show this question only for orders with this specific payment mode.
available_statuses
array of string
Show this question only for specific order sub-statuses.
answer
object (DynamicFaqAnswerItem)
Nullable
The answer content for leaf nodes. Null for branch nodes with children.
DynamicFaqAnswerItem
content
string
The answer text shown to the customer.
payment_mode_filter
string
Nullable
Show this answer only for a specific payment mode.
is_complaint
boolean
Whether this answer represents a customer complaint that may require escalation.
ticket_category
string
Nullable
Pre-fills ticket category when customer raises a support ticket.
ticket_sub_category
string
Nullable
Pre-fills ticket sub-category.
ticket_leaf_category
string
Nullable
Pre-fills ticket leaf category.
work_group
string
Nullable
Support work group to route the ticket to.
resolution_days
number
Nullable
Expected resolution time in days.
attachment_required
boolean
Whether the storefront should prompt the customer to upload an attachment.
children
array of object (DynamicFaqQuickLinkL3)
Sub-questions at level 3. Empty if this node is a leaf.
Array of DynamicFaqQuickLinkL3
_id
string
Unique identifier of this node.
question
string
The question text displayed to the customer at this tree level.
priority
number
Display order priority (lower values appear first).
chat_enabled
boolean
Whether to show the chat option when this question is selected.
callback_enabled
boolean
Whether to show the callback option when this question is selected.
validation_enabled
boolean
Whether input validation is required before proceeding from this node.
restricted_payment_mode
string
Nullable
Show this question only for orders with this specific payment mode.
available_statuses
array of string
Show this question only for specific order sub-statuses.
answer
object (DynamicFaqAnswerItem)
Nullable
The answer content shown when the customer selects this leaf question. Null for branch nodes.
DynamicFaqAnswerItem
content
string
The answer text shown to the customer.
payment_mode_filter
string
Nullable
Show this answer only for a specific payment mode.
is_complaint
boolean
Whether this answer represents a customer complaint that may require escalation.
ticket_category
string
Nullable
Pre-fills ticket category when customer raises a support ticket.
ticket_sub_category
string
Nullable
Pre-fills ticket sub-category.
ticket_leaf_category
string
Nullable
Pre-fills ticket leaf category.
work_group
string
Nullable
Support work group to route the ticket to.
resolution_days
number
Nullable
Expected resolution time in days.
attachment_required
boolean
Whether the storefront should prompt the customer to upload an attachment.
children
array of object
Always empty at level 3 (deepest level).
created_at
string
| date-time
Timestamp when the document was created.
updated_at
string
| date-time
Timestamp when the document was last updated.
__v
number
Mongoose version key.
error
object
Nullable
meta
object
Examples
Parameters
id:
"60265b64e507768b168dee4d"
GET
/service/application/content/v1.0/dynamic-faq/mappings/{id}
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

FDK Method Name: getFaqs
List frequently asked questions and answers.
Parameters
No Parameters
Response
200
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
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
__v
number
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/faq
Loading...
Response
Loading...
GET

List FAQ Categories

FDK Method Name: getFaqCategories
List categories for organizing FAQs.
Parameters
No Parameters
Response
200
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
index
integer
title
string
description
string
children
array of string
_id
string
slug
string
application
string
icon_url
string
_custom_json
object
__v
number
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/faq/categories
Loading...
Response
Loading...
GET

Get FAQ

FDK Method Name: getFaqBySlug
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
400
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
__v
number
Examples
Parameters
slug:
"question-1"
GET
/service/application/content/v1.0/faq/{slug}
Loading...
Response
Loading...
GET

Get a FAQ category

FDK Method Name: getFaqCategoryBySlug
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
400
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
title
string
description
string
children
array of object (ChildrenSchema)
Array of ChildrenSchema
question
string
answer
string
slug
string
application
string
_id
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_id
string
slug
string
application
string
icon_url
string
_custom_json
object
__v
number
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
slug:
"testingslugfirsst"
GET
/service/application/content/v1.0/faq/category/{slug}
Loading...
Response
Loading...
GET

List FAQs by category

FDK Method Name: getFaqsByCategorySlug
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
404
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
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
__v
number
Examples
Parameters
slug:
"testingslugsecond"
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

FDK Method Name: getTags
Lists HTML tags to power additional functionalities within an application.
Parameters
No Parameters
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.
TagsSchema
application
string
_id
string
company
string
tags
array of object (TagSchema)
Array of TagSchema
name
string
url
string
type
string
Enum
sub_type
string
Enum
_id
string
position
string
Enum
attributes
object
Attributes related to tag
content
string
compatible_engines
array of string
pages
array of object
__source
object (TagSourceSchema)
TagSourceSchema
type
string
id
string
__v
number
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

FDK Method Name: getLandingPage
Gets the content of the application's landing page.
Parameters
No Parameters
Response
200
Success. Returns the landing page details. Check the example shown below or refer `LandingPageSchema` for more details.
LandingPageSchema
slug
string
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
value
string
The value for the action.
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
value
string
The value for the action.
platform
array of string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
_id
string
application
string
archived
boolean
_custom_json
object
__v
number
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

FDK Method Name: getLegalInformation
Get legal policies for an application which includes Terms and conditions, return policy, shipping policy and privacy policy.
Parameters
No Parameters
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.
ApplicationLegal
application
string
tnc
string
policy
string
shipping
string
returns
string
faq
array of object (ApplicationLegalFAQ)
Array of ApplicationLegalFAQ
question
string
answer
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_id
string
updated_at
string
| date-time
created_at
string
| date-time
__v
number
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
# Lists pages
GET
/service/application/content/v2.0/pages/{slug}
# Get page by slug
GET

Lists pages

FDK Method Name: getPages
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
Success. Returns a list of pages along with their details. Check the example shown below or refer `PageGetStorefrontResponse` for more details.
PageGetResponseSchema
items
array of object (PageSchema)
Array of 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
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
description
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
page_meta
array of object
_schedule
object (ScheduleSchema)
ScheduleSchema
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
_custom_json
object
orientation
string
platform
string
published
boolean
slug
string
tags
array of string
title
string
type
string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumbs
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
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
value
string
The value for the action.
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
value
string
The value for the action.
canonical_url
string
visibility
object
archived
boolean
__v
number
sanitized_content
array of object (SanitizedContent)
Array of SanitizedContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
next
string
Nullable
Cursor token for the next page (alias for next_id used by search services).
item_count
integer
| int32
The number of items returned on the current 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.
limit
integer
| int32
The maximum number of items to be returned per page.
total
integer
| int32
Total number of items.
Examples
Parameters
page_no:
1
page_size:
10
GET
/service/application/content/v2.0/pages
Loading...
Response
Loading...
GET

Get page by slug

FDK Method Name: getPage
Get detailed information about a specific page using its slug.
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
404
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
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
description
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
page_meta
array of object
_schedule
object (ScheduleSchema)
ScheduleSchema
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
_custom_json
object
orientation
string
platform
string
published
boolean
slug
string
tags
array of string
title
string
type
string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumbs
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
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
value
string
The value for the action.
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
value
string
The value for the action.
canonical_url
string
visibility
object
archived
boolean
__v
number
sanitized_content
array of object (SanitizedContent)
Array of SanitizedContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
slug:
"testing-slug-for-fetch"
GET
/service/application/content/v2.0/pages/{slug}
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

FDK Method Name: getSEOConfiguration
Get search engine optimization configurations of an application. Details include the title, description and an image.
Parameters
No Parameters
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.
SeoComponent
seo
object (SeoSchema)
SeoSchema
app
string
_id
string
robots_txt
string
sitemap_enabled
boolean
additional_sitemap
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
cannonical_enabled
boolean
Default Value : false
custom_meta_tags
array of object (CustomMetaTag)
Array of CustomMetaTag
name
string
content
string
_id
string
details
object (Detail)
Detail
title
string
description
string
image_url
string
created_at
string
| date-time
updated_at
string
| date-time
__v
number
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/seo
Loading...
Response
Loading...
GET

List SEO Markup schemas

FDK Method Name: getSEOMarkupSchemas
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
Success. Refer `SeoSchemaComponent` for more details.
SeoSchemaComponent
items
array of object (SEOSchemaMarkupTemplate)
Array of SEOSchemaMarkupTemplate
_id
string
title
string
page_type
string
Type of page under seo schema is to be created
Enum
description
string
schema
string
target_json
object
active
boolean
created_at
string
| date-time
updated_at
string
| date-time
application
string
__v
number
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
page_type:
"products"
GET
/service/application/content/v1.0/seo/schema
Loading...
Response
Loading...

Sitemap Configuration

Sitemap Configuration in Fynd Platform allows you to customize how your storefronts's sitemap is generated, optimizing your site's visibility to search engines. Control which pages are included, set update frequencies, and prioritize content to enhance your SEO performance. Easily exclude specific pages, products, or collections while ensuring your most important content gets indexed efficiently.

Operations
GET
/service/application/content/v1.0/seo/sitemap/default
# Get default sitemap configuration
GET
/service/application/content/v1.0/seo/sitemaps
# List sitemap configurations
GET
/service/application/content/v1.0/seo/sitemaps/{name}
# Get a specific sitemap configuration
GET

Get default sitemap configuration

FDK Method Name: getDefaultSitemapConfig
Retrieves the current default sitemap configuration settings
Parameters
No Parameters
Response
200
Successful operation
DefaultSitemapConfig
root
object (DefaultSitemapIndividualConfig)
DefaultSitemapIndividualConfig
enabled
boolean
Whether sitemap configuration is enabled or not for this sitemap configuration
Default Value : true
brand
object (DefaultSitemapIndividualConfig)
DefaultSitemapIndividualConfig
enabled
boolean
Whether sitemap configuration is enabled or not for this sitemap configuration
Default Value : true
collections
object (DefaultSitemapIndividualConfig)
DefaultSitemapIndividualConfig
enabled
boolean
Whether sitemap configuration is enabled or not for this sitemap configuration
Default Value : true
category_l1
object (DefaultSitemapIndividualConfig)
DefaultSitemapIndividualConfig
enabled
boolean
Whether sitemap configuration is enabled or not for this sitemap configuration
Default Value : true
category_l2
object (DefaultSitemapIndividualConfig)
DefaultSitemapIndividualConfig
enabled
boolean
Whether sitemap configuration is enabled or not for this sitemap configuration
Default Value : true
category_l3
object (DefaultSitemapIndividualConfig)
DefaultSitemapIndividualConfig
enabled
boolean
Whether sitemap configuration is enabled or not for this sitemap configuration
Default Value : true
pages
object (DefaultSitemapIndividualConfig)
DefaultSitemapIndividualConfig
enabled
boolean
Whether sitemap configuration is enabled or not for this sitemap configuration
Default Value : true
blog
object (DefaultSitemapIndividualConfig)
DefaultSitemapIndividualConfig
enabled
boolean
Whether sitemap configuration is enabled or not for this sitemap configuration
Default Value : true
section
object (DefaultSitemapIndividualConfig)
DefaultSitemapIndividualConfig
enabled
boolean
Whether sitemap configuration is enabled or not for this sitemap configuration
Default Value : true
faq
object (DefaultSitemapIndividualConfig)
DefaultSitemapIndividualConfig
enabled
boolean
Whether sitemap configuration is enabled or not for this sitemap configuration
Default Value : true
sitemap
object (DefaultSitemapIndividualConfig)
DefaultSitemapIndividualConfig
enabled
boolean
Whether sitemap configuration is enabled or not for this sitemap configuration
Default Value : true
Examples
Parameters
Parameters are not required.
GET
/service/application/content/v1.0/seo/sitemap/default
Loading...
Response
Loading...
GET

List sitemap configurations

FDK Method Name: getSitemaps
Retrieve a list of sitemap configurations for a specific company and application. Each configuration contains the sitemap XML data and its activation status.
Parameters
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
is_active
boolean
Boolean flag for checking if sitemap is active or not in storefront
name
string
Query parameter to search sitemaps with name
Response
200
Successfully retrieved sitemap configurations
SitemapConfigurationList
items
array of object (SitemapConfig)
List of all Sitemap configurations
Array of SitemapConfig
name
string
Unique identifier for the sitemap configuration
is_active
boolean
Indicates if the sitemap configuration is active or not in storefront
sitemap
string
XML string containing sitemap data in base64 encoding
created_at
string
| date-time
Timestamp when the configuration was created
updated_at
string
| date-time
Timestamp when the configuration was last updated
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.
next
string
Nullable
Cursor token for the next page (alias for next_id used by search services).
item_count
integer
| int32
The number of items returned on the current 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.
limit
integer
| int32
The maximum number of items to be returned per page.
total
integer
| int32
Total number of items.
Examples
Parameters
page_no:
1
page_size:
10
GET
/service/application/content/v1.0/seo/sitemaps
Loading...
Response
Loading...
GET

Get a specific sitemap configuration

FDK Method Name: getSitemap
Retrieve a specific sitemap configuration by its name. Returns the complete configuration including the sitemap XML data, activation status, and timestamps.
Parameters
name
string
Required
Unique identifier for the sitemap configuration
Response
200
400
Successfully retrieved sitemap configuration
SitemapConfig
name
string
Unique identifier for the sitemap configuration
is_active
boolean
Indicates if the sitemap configuration is active or not in storefront
sitemap
string
XML string containing sitemap data in base64 encoding
created_at
string
| date-time
Timestamp when the configuration was created
updated_at
string
| date-time
Timestamp when the configuration was last updated
Examples
Parameters
name:
"get-application-sitemap"
GET
/service/application/content/v1.0/seo/sitemaps/{name}
Loading...
Response
Loading...

Well known routes

Well-known URLs are standardized URLs and endpoints that help systems discover and interact with various service metadata, configuration files, and integration points. These routes handle the management of well-known URLs like assetlinks.json for Android App Links and apple-app-site-association for iOS Universal Links. These endpoints enable applications to create, read, update, and delete well-known URL configurations, ensuring proper discovery and validation mechanisms for mobile apps, security protocols, and other platform-specific integrations. The routes follow standard REST practices and require proper authentication to ensure secure management of these critical application resources.

Operations
GET
/service/application/content/v1.0/well-known/{slug}
# Get a specific well-known URL
GET

Get a specific well-known URL

FDK Method Name: getWellKnownUrl
Retrieves the details of a specific well-known URL by its slug.
Parameters
slug
string
Required
The unique identifier/path of the well-known URL (e.g., assetlinks.json)
Response
200
400
Well-known URL details retrieved successfully
WellKnownResponseSchema
_id
string
Unique identifier for the well-known URL configuration
slug
string
The path/identifier of the well-known URL
application_id
string
The ID of the application this well-known URL belongs to
content
string
The content being served at the well-known URL
content_type
string
The MIME type of the content
created_at
string
| date-time
Timestamp when the well-known URL was created
updated_at
string
| date-time
Timestamp when the well-known URL was last updated
Examples
Parameters
slug:
"assetlinks.json"
GET
/service/application/content/v1.0/well-known/{slug}
Loading...
Response
Loading...