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.
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 edit announcement related information such as its content and appearance, and moreover schedule it to appear on website or mobile application.
Operations
GET
# List announcements
POST
# Create announcement
GET
# Get announcement
PUT
# Update announcement
PATCH
# Update announcement schedule
DEL
# Delete an announcement
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
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 is 10.
Default Value : 10
Response
200
Success. Refer `GetAnnouncementListSchema` for more details.
GetAnnouncementListSchema
items
array of object (AdminAnnouncementSchema)
Array of AdminAnnouncementSchema
_id
string
platforms
array of string
title
string
announcement
string
pages
array of object (AnnouncementPageSchema)
Array of AnnouncementPageSchema
page_slug
string
type
string
Enum
editor_meta
object (EditorMeta)
EditorMeta
foreground_color
string
background_color
string
content_type
string
Enum
content
string
author
object (AnnouncementAuthorSchema)
AnnouncementAuthorSchema
created_by
string
modified_by
string
created_at
string
| date-time
app
string
modified_at
string
| date-time
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
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.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
page_no:
1
page_size:
10
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
_id
string
platforms
array of string
title
string
announcement
string
pages
array of object (AnnouncementPageSchema)
Array of AnnouncementPageSchema
page_slug
string
type
string
Enum
editor_meta
object (EditorMeta)
EditorMeta
foreground_color
string
background_color
string
content_type
string
Enum
content
string
author
object (AnnouncementAuthorSchema)
AnnouncementAuthorSchema
created_by
string
modified_by
string
created_at
string
| date-time
app
string
modified_at
string
| date-time
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
201
400
Success. Refer `CreateAnnouncementSchema` for more details.
CreateAnnouncementSchema
message
string
data
object (AdminAnnouncementSchema)
AdminAnnouncementSchema
_id
string
platforms
array of string
title
string
announcement
string
pages
array of object (AnnouncementPageSchema)
Array of AnnouncementPageSchema
page_slug
string
type
string
Enum
editor_meta
object (EditorMeta)
EditorMeta
foreground_color
string
background_color
string
content_type
string
Enum
content
string
author
object (AnnouncementAuthorSchema)
AnnouncementAuthorSchema
created_by
string
modified_by
string
created_at
string
| date-time
app
string
modified_at
string
| date-time
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64b797b588e073911f7ce125"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
announcement_id
string
Required
ID allotted to the announcement.
Response
200
400
Success. Refer `AdminAnnouncementSchema` for more details.
AdminAnnouncementSchema
_id
string
platforms
array of string
title
string
announcement
string
pages
array of object (AnnouncementPageSchema)
Array of AnnouncementPageSchema
page_slug
string
type
string
Enum
editor_meta
object (EditorMeta)
EditorMeta
foreground_color
string
background_color
string
content_type
string
Enum
content
string
author
object (AnnouncementAuthorSchema)
AnnouncementAuthorSchema
created_by
string
modified_by
string
created_at
string
| date-time
app
string
modified_at
string
| date-time
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64b797b588e073911f7ce125"
announcement_id:
"64b797c45668f80946275899"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
announcement_id
string
Required
ID allotted to the announcement.
Request body
_id
string
platforms
array of string
title
string
announcement
string
pages
array of object (AnnouncementPageSchema)
Array of AnnouncementPageSchema
page_slug
string
type
string
Enum
editor_meta
object (EditorMeta)
EditorMeta
foreground_color
string
background_color
string
content_type
string
Enum
content
string
author
object (AnnouncementAuthorSchema)
AnnouncementAuthorSchema
created_by
string
modified_by
string
created_at
string
| date-time
app
string
modified_at
string
| date-time
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Success. Refer `CreateAnnouncementSchema` for more details.
CreateAnnouncementSchema
message
string
data
object (AdminAnnouncementSchema)
AdminAnnouncementSchema
_id
string
platforms
array of string
title
string
announcement
string
pages
array of object (AnnouncementPageSchema)
Array of AnnouncementPageSchema
page_slug
string
type
string
Enum
editor_meta
object (EditorMeta)
EditorMeta
foreground_color
string
background_color
string
content_type
string
Enum
content
string
author
object (AnnouncementAuthorSchema)
AnnouncementAuthorSchema
created_by
string
modified_by
string
created_at
string
| date-time
app
string
modified_at
string
| date-time
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64b797b588e073911f7ce125"
announcement_id:
"64b797c45668f80946275899"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
announcement_id
string
Required
ID allotted to the announcement.
Request body
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
Response
200
400
Success. Refer `CreateAnnouncementSchema` for more details.
CreateAnnouncementSchema
message
string
data
object (AdminAnnouncementSchema)
AdminAnnouncementSchema
_id
string
platforms
array of string
title
string
announcement
string
pages
array of object (AnnouncementPageSchema)
Array of AnnouncementPageSchema
page_slug
string
type
string
Enum
editor_meta
object (EditorMeta)
EditorMeta
foreground_color
string
background_color
string
content_type
string
Enum
content
string
author
object (AnnouncementAuthorSchema)
AnnouncementAuthorSchema
created_by
string
modified_by
string
created_at
string
| date-time
app
string
modified_at
string
| date-time
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64b797b588e073911f7ce125"
announcement_id:
"64b797c45668f80946275899"
body:
body
Was this section helpful?
PATCH
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
announcement_id
string
Required
ID allotted to the announcement.
Response
200
Success.
CreateAnnouncementSchema
message
string
data
object (AdminAnnouncementSchema)
AdminAnnouncementSchema
_id
string
platforms
array of string
title
string
announcement
string
pages
array of object (AnnouncementPageSchema)
Array of AnnouncementPageSchema
page_slug
string
type
string
Enum
editor_meta
object (EditorMeta)
EditorMeta
foreground_color
string
background_color
string
content_type
string
Enum
content
string
author
object (AnnouncementAuthorSchema)
AnnouncementAuthorSchema
created_by
string
modified_by
string
created_at
string
| date-time
app
string
modified_at
string
| date-time
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64b797b588e073911f7ce125"
announcement_id:
"64b798c55668f819c52758e9"
Was this section helpful?
DEL
Response
Blogs serve as a multifaceted tool to engage with their audience, enhance their brand image, and drive sales. Through informative and engaging content, one can attract potential customers, improve their website's search engine rankings, and establish themselves as authorities in their 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 their blog with relevant content, one can foster a sense of community, provide value to their audience, and ultimately increase conversions on their store. This resource allows you to edit blog-related information such as its content, appearance, author details, related SEO information, and even schedule it to appear on the website or mobile application.
Operations
POST
# Create blog
GET
# List blogs
PUT
# Update a blog
DEL
# Delete a blog
GET
# Get component
GET
# Get blog by slug.
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
application
string
_custom_json
object
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
title
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)
Required
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
canonical_url
string
summary
string
Response
200
400
Success. 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
publish_date
string
| date-time
tags
array of 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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
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 is 10.
Default Value : 10
tags
string
Blogs retrieve based on the list of tags passed.
q
string
Blogs retrieve based on the title or slug passed.
slug
string
Blogs retrieve based on the slug passed.
title
string
Blogs retrieve based on the title passed.
status
string
Blogs retrieve based on the status passed.
Response
200
Success. 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
publish_date
string
| date-time
tags
array of 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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
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.
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.
total
integer
| int32
Total number of items.
filters
object (BlogFilters)
BlogFilters
tags
array of string
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to the blog.
Request body
application
string
_custom_json
object
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
title
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)
Required
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
canonical_url
string
summary
string
Response
200
400
Success.
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
publish_date
string
| date-time
tags
array of 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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
id:
"64bcbf6789abcdef01234567"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to the blog.
Response
200
400
Success.
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
publish_date
string
| date-time
tags
array of 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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
id:
"64bcbf6789abcdef01234567"
Was this section helpful?
DEL
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
slug
string
Required
A short, human-readable, URL-friendly identifier of a blog page. You can get slug value of a blog from `getBlogs` API.
Response
200
404
Success. Returns a a JSON object with components. 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
publish_date
string
| date-time
tags
array of 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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"Test5"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
slug
string
Required
A short, human-readable, URL-friendly identifier of a blog page. You can get slug value of a blog from `getBlogs` API.
Response
200
404
Success. Returns a a JSON object with components. 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
publish_date
string
| date-time
tags
array of 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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"Test5"
Was this section helpful?
GET
Response
Custom fields are a flexible way to attach additional information to a resource (e.g. Product, promotions, etc.). Some examples of data stored using customfields 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
# Get custom field types
GET
# Get resources
GET
# Get custom fields definitions
GET
# Get custom fields definitions for a given resource type
POST
# Create custom field definition for a given resource type
GET
# Get custom fields definition by resource, slug and namespace
PUT
# Update custom field definition
DEL
# Delete custom fields definition
GET
# Get list of custom fields of given resource and resource slug
PUT
# Create custom field entries for gives resource and resource slug
Each custom field and custom field definition has a type, which defines the type of information that it can store. The custom field types have built-in validation. This api will give list of supported custom fields types
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Response
200
400
Success. Returns all custom field types.
MetafieldTypesSchema
metafield_types
object (CustomFieldTypeSchema)
CustomFieldTypeSchema
string_single_line
object (StringSingleLine)
StringSingleLine
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
string_multi_line
object (StringMultiLine)
StringMultiLine
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
dropdown
object (Dropdown)
Dropdown
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
integer
object (Integer)
Integer
name
string
list_enabled
boolean
type
string
category
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
float_type
object (FloatType)
FloatType
name
string
list_enabled
boolean
type
string
category
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
boolean_type
object (BooleanType)
BooleanType
name
string
category
string
list_enabled
boolean
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
date
object (Date)
Date
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
datetime
object (Datetime)
Datetime
name
string
category
string
list_enabled
boolean
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
json
object (Json)
Json
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
file
object (File)
File
name
string
category
string
list_enabled
boolean
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
url
object (Url)
Url
name
string
list_enabled
boolean
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
metaobject
object (Metaobject)
Metaobject
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
product
object (Product)
Product
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
scope
array of string
html
object (HTML)
HTML
name
string
list_enabled
boolean
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
duration
object (Duration)
Duration
name
string
list_enabled
boolean
type
string
category
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
Was this section helpful?
GET
Response
Each custom fields is assosiated with a resource such as product, promotion, coupon, selling location etc, This will gives list of supported resource list.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Response
200
400
Success. Returns a JSON object of resources. Refer `ResourcesSchema` for more details.
ResourcesSchema
resources
array of object (ResourceSchema)
Array of ResourceSchema
name
string
Resource name
key
string
Resource key
definitions_count
number
Number of definitions
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
Was this section helpful?
GET
Response
Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
resources
string
This is the resource for which we are fetching definitions
types
string
This is the type of the custom fields definitions
search
string
This is the search text to filter custom fields definitions
slugs
string
This is the slug list to filter custom fields definitions, it will come comma separated
namespaces
string
This is the namespace list to filter custom fields definitions, it needs to be comma separated
Response
200
400
Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionsSchema
items
array of object (FieldDefinitionSchema)
Array of FieldDefinitionSchema
resource
string
name
string
namespace
string
slug
string
description
string
type
string
multi_value
boolean
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
company_id
string
| integer
required
boolean
is_deleted
boolean
type_name
string
invalid_fields_count
integer
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.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
page_no:
"1"
page_size:
"10"
resources:
"product"
types:
"string_single_line"
search:
"sometext"
Was this section helpful?
GET
Response
Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
types
string
This is the type of the custom fields definitions
search
string
This is the search text to filter custom fields definitions
slugs
string
This is the slug list to filter custom fields definitions, it will come comma separated
namespaces
string
This is the namespace list to filter custom fields definitions, it needs to be comma separated
Response
200
400
Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionsSchema
items
array of object (FieldDefinitionSchema)
Array of FieldDefinitionSchema
resource
string
name
string
namespace
string
slug
string
description
string
type
string
multi_value
boolean
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
company_id
string
| integer
required
boolean
is_deleted
boolean
type_name
string
invalid_fields_count
integer
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.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
page_no:
"1"
page_size:
"10"
resource:
"product"
types:
"string_single_line"
search:
"sometext"
Was this section helpful?
GET
Response
You can create custom fields definition to any resource so you can extend property of resource.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
Request body
resource
string
type
string
key
string
namespace
string
slug
string
multi_value
boolean
name
string
description
string
creator
string
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Custom field definition created.
CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
application_id
string
created_by
string
updated_by
string
required
boolean
is_deleted
boolean
_id
string
validations
array of Undefined Type
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
resource:
"product"
body:
body
Was this section helpful?
POST
Response
Custom field definitions can be retrived from this using its slug, namespace and resource
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom field definition slug
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
namespace
string
Required
This is namespace for a custom field
Response
200
404
Success. Returns a custom field definition. Refer `MetaFieldDefinitionDetailResSchema` for more details.
MetaFieldDefinitionDetailResSchema
resource
string
resource to which meta field is associated
name
string
name of meta field
namespace
string
namespace of meta field
slug
string
slug of meta field
description
string
description regarding meta field
type
string
data type of meta field
multi_value
boolean
flag to denote whether meta field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the field is required or not
is_deleted
boolean
is meta field deleted
id
string
Unique system generated id
validations
array of Undefined Type
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
4072
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"material_type"
resource:
"product"
namespace:
"custom"
Was this section helpful?
GET
Response
Custom fields definition can be update using this api, You can update custom field definition name and description.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom field definition slug
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
namespace
string
Required
This is namespace for a custom field
Request body
resource
string
type
string
key
string
namespace
string
slug
string
multi_value
boolean
name
string
description
string
creator
string
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Custom field definition updated.
CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
application_id
string
created_by
string
updated_by
string
required
boolean
is_deleted
boolean
_id
string
validations
array of object
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
4072
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"demo_link"
resource:
"product"
namespace:
"custom"
body:
body
Was this section helpful?
PUT
Response
Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom field definition slug
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
namespace
string
Required
This is namespace for a custom field
Response
200
404
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
message
string
Examples
Parameters
company_id:
4072
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"product-app-delete-v2-route"
resource:
"product"
namespace:
"custom"
Was this section helpful?
DEL
Response
Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resource_slug
string
Required
This is the resource slug for which custom fields created
Response
200
400
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Array of CustomFieldSchema
_id
string
namespace
string
key
string
resource
string
creator
string
resource_id
string
type
string
Enum
multi_value
boolean
company_id
string
| integer
definition_id
string
has_invalid_values
boolean
invalid_value_errors
array of Undefined Type
created_by
string
is_deleted
boolean
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
4072
application_id:
"64d37ebf989a52a3b43ea28b"
resource:
"product"
resource_slug:
12345678
Was this section helpful?
GET
Response
You can add a custom field using this endpoint to any resource by providing the resource slug.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resource_slug
string
Required
This is the resource slug for which custom fields created
Request body
fields
array of object
Response
200
400
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Array of CustomFieldSchema
_id
string
namespace
string
key
string
resource
string
creator
string
resource_id
string
type
string
Enum
multi_value
boolean
company_id
string
| integer
definition_id
string
has_invalid_values
boolean
invalid_value_errors
array of object
created_by
string
is_deleted
boolean
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
4072
application_id:
"64d37ebf989a52a3b43ea28b"
resource:
"product"
resource_slug:
12345678
body:
body
Was this section helpful?
PUT
Response
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
POST
# Create custom object definition
GET
# Get custom object definitions
GET
# Get custom object definition
PUT
# Update custom object definition
DEL
# Delete custom object definition
GET
# Get list of custom objects
POST
# Create custom object entries
GET
# Get custom object details
DEL
# Delete custom object
PUT
# Update custom object details
GET
# Get bulk import and export job list
POST
# Bulk custom object entries upload
GET
# Initiate download for bulk custom object entries
GET
# Download sample for custom object bulk entry
Create a custom object that will have a collection of custom fields and can be used anywhere in the custom field for any resource.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
type
string
description
string
slug
string
name
string
display_name_key
string
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
Array of CustomObjectCustomFieldDefinitions
_id
string
type
string
Required
Enum
description
string
name
string
multi_value
boolean
required
boolean
key
string
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
action
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Success. Returns the saved custom object defintion
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
application_id
string
created_by
string
updated_by
string
required
boolean
is_deleted
boolean
_id
string
validations
array of object
created_at
string
| date-time
updated_at
string
| date-time
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
search
string
This is the search text to filter custom fields definitions
Response
200
400
Success. Returns a list custom object definitions.
CustomObjectDefinitionsSchema
items
array of object (CustomObjectEntry)
Array of CustomObjectEntry
name
string
type
string
updated_at
string
| date-time
entries_count
integer
fields_count
integer
slug
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
page_no:
"1"
page_size:
"10"
search:
"sometext"
Was this section helpful?
GET
Response
Custom object definitions can be fetched using their custom object definition slug.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Response
200
400
Success. It will returns the message for delete successfully.
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
application_id
string
created_by
string
updated_by
string
required
boolean
is_deleted
boolean
_id
string
validations
array of object
created_at
string
| date-time
updated_at
string
| date-time
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"address"
Was this section helpful?
GET
Response
Custom object definitions can be updated using this endpoint. You can update the name and description of the custom object and add more custom field definitions to the existing custom object.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Request body
type
string
description
string
name
string
display_name_key
string
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Array of CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
application_id
string
created_by
string
updated_by
string
required
boolean
is_deleted
boolean
_id
string
validations
array of object
created_at
string
| date-time
updated_at
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Custom field definition updated.
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
application_id
string
created_by
string
updated_by
string
required
boolean
is_deleted
boolean
_id
string
validations
array of object
created_at
string
| date-time
updated_at
string
| date-time
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"address-edit"
body:
body
Was this section helpful?
PUT
Response
Custom object definitions can be deleted using this endpoint by providing the definition ID.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Response
200
404
Custom object definition details.
CustomObjectDefinitionDeleteResponseSchema
success
boolean
message
string
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"address-delete"
Was this section helpful?
DEL
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
definition_slug
string
Required
This is custom object definition slug
Response
200
400
Success. Returns a list of custom objects. Refer `CustomObjectsSchema` for more details.
CustomObjectsSchema
items
array of object (CustomObjectListItemSchema)
Array of CustomObjectListItemSchema
_id
string
definition_id
string
type
string
status
string
slug
string
updated_at
string
| date-time
display_name
string
definition
object (CustomObjectListItemDefinationSchema)
CustomObjectListItemDefinationSchema
_id
string
name
string
type
string
display_name_key
string
references
integer
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
page_no:
"1"
page_size:
"10"
Was this section helpful?
GET
Response
Custom object entries against the custom object definition can be added using this API.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_slug
string
Required
This is custom object definition slug
Request body
slug
string
status
string
status of the custom object entry.
fields
array of object (CustomObjectEntryFieldSchemaWithoutID)
list of custom fields
Array of CustomObjectEntryFieldSchemaWithoutID
slug
string
custom fields belonging to a 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.
Response
200
400
Success. Returns a list of custom objects. Refer `CustomObjectSchema` for more details.
CustomObjectSchema
id
string
name
string
creator
string
company_id
string
| integer
created_by
string
updated_by
string
status
string
slug
string
type
string
display_name
string
definition_id
string
is_deleted
boolean
created_at
string
| date-time
updated_at
string
| date-time
fields
array of object (CustomFieldSchema)
Array of CustomFieldSchema
_id
string
namespace
string
key
string
resource
string
creator
string
resource_id
string
type
string
Enum
multi_value
boolean
company_id
string
| integer
definition_id
string
has_invalid_values
boolean
invalid_value_errors
array of object
created_by
string
is_deleted
boolean
created_at
string
| date-time
updated_at
string
| date-time
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
definition_slug:
"address"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
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 `CustomObjectBySlugSchema` for more details.
CustomObjectBySlugSchema
id
string
Unique system generated identifer for a Custom Object
status
string
status of Custom Object
display_name
string
Display name for the Custom Object
definition
object (CustomObjectListItemDefinitionModel)
CustomObjectListItemDefinitionModel
id
string
Unique system generated id
name
string
Name of custom object
type
string
Type of custom object entry
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
references
array of Undefined Type
Places where the custom object has been used as a custom field
slug
string
slug of custom object entry
definition_slug
string
slug of custom object definition
fields
array of object (CustomObjectFieldDefinition)
List of custom fields inside the custom object
Array of CustomObjectFieldDefinition
id
string
Unique system generate id
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
type
string
data type of the custom field
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
definition_slug:
"address"
slug:
"jaipur"
Was this section helpful?
GET
Response
A Custom object entry can be deleted by providing the custom object definition slug and custom object entry slug using this endpoint.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_slug
string
Required
This is custom object definition slug
slug
string
Required
This is custom object entry slug
Response
200
404
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
message
string
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
definition_slug:
"address"
slug:
"kota"
Was this section helpful?
DEL
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_slug
string
Required
This is custom object definition slug
slug
string
Required
This is custom object entry slug
Request body
slug
string
status
string
status of the custom object entry.
fields
array of object (CustomObjectEntryFieldSchemaWithoutID)
list of custom fields
Array of CustomObjectEntryFieldSchemaWithoutID
slug
string
custom fields belonging to a 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.
Response
200
400
Custom field definition created.
CustomObjectBySlugSchema
id
string
Unique system generated identifer for a Custom Object
status
string
status of Custom Object
display_name
string
Display name for the Custom Object
definition
object (CustomObjectListItemDefinitionModel)
CustomObjectListItemDefinitionModel
id
string
Unique system generated id
name
string
Name of custom object
type
string
Type of custom object entry
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
references
array of object
Places where the custom object has been used as a custom field
slug
string
slug of custom object entry
definition_slug
string
slug of custom object definition
fields
array of object (CustomObjectFieldDefinition)
List of custom fields inside the custom object
Array of CustomObjectFieldDefinition
id
string
Unique system generate id
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
type
string
data type of the custom field
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
definition_slug:
"address"
slug:
"jodhpur"
body:
body
Was this section helpful?
PUT
Response
Custom object bulk import and export jobs status and details can be obtained using this endpoint.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
action_type
string
Required
This is the action type
Enum
Response
200
400
Success. Returns all bulk entries history.
CustomObjectBulkEntry
items
array of object (JobSchema)
Array of JobSchema
_id
string
jobs
array of string
finished_jobs
array of string
error_jobs
array of string
errors_occured
array of string
company_id
string
creator
string
status
string
action_type
string
Enum
entity
string
error_url
string
finished_count
integer
error_count
integer
success_count
integer
total_jobs
integer
meta
object (CustomObjectMetaSchema)
CustomObjectMetaSchema
mo_total_count
integer
mo_success_count
integer
mo_error_count
integer
mo_defintion_type
string
created_by
string
created_at
string
| date-time
updated_at
string
| date-time
application_id
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.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
page_no:
"1"
page_size:
"10"
action_type:
"upload"
Was this section helpful?
GET
Response
Custom object bulk import of bulk entries can be performed using this endpoint.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Request body
url
string
total_records
integer
Response
200
400
Success. Returns confirmation that the upload has started
CustomObjectEntryBulkUploadDetails
url
string
Signed url of csv
total_records
integer
Total no of records in csv file
message
string
task_id
string
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"address"
body:
body
Was this section helpful?
POST
Response
Custom object bulk export of bulk entries can be perform using this endpoint.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Response
200
400
Success. Initiates bulk entries download
CustomObjectBulkEntryInitiateDownload
message
string
task_id
string
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"address"
Was this section helpful?
GET
Response
Sample files for custom object bulk import can be obtained from this endpoint.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Response
200
400
Success. Get headers of custom object definition
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"address"
Was this section helpful?
GET
Response
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 resources allows you to create and alter content of custom pages. There are four types of editor to create pages - befree, grapeJS, markup and rawHTML. Based on the editor type the content can vary.
Operations
GET
# Get page meta
GET
# Get page specification
POST
# Create page preview
PUT
# Update page preview
DEL
# Delete page
POST
# Create page
GET
# Get pages.
PUT
# Update page
GET
# Get page by slug
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Response
200
Success. Refer `PageMetaSchema` for more details.
PageMetaSchema
system_pages
array of object (SystemPages)
Array of SystemPages
display
string
action
object (SystemPagesAction)
SystemPagesAction
page
object (SystemPagesActionPage)
SystemPagesActionPage
type
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
page_type
string
custom_pages
array of object (CustomePages)
Array of CustomePages
display
string
slug
string
application_id
string
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Response
200
Success. Refer `PageSpec` for more details.
PageSpec
specifications
array of object (PageSpecItem)
Array of PageSpecItem
page_type
string
display_name
string
params
array of object (PageSpecParam)
Array of PageSpecParam
key
string
required
boolean
query
array of object (PageSpecParam)
Array of PageSpecParam
key
string
required
boolean
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
_schedule
object (CronSchedule)
CronSchedule
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
application
string
author
object (Author)
Author
designation
string
id
string
name
string
_custom_json
object
orientation
string
content
array of object (PageContent)
Array of PageContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
tags
array of 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)
Required
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
canonical_url
string
title
string
platform
string
type
string
description
string
visibility
object
Visibility of Page.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Success. Refer `PageSchema` for more details.
PageSchema
_id
string
application
string
platform
string
title
string
slug
string
type
string
tags
array of string
content_path
string
orientation
string
description
string
published
boolean
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
page_meta
array of object (PageMeta)
Array of PageMeta
key
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
component_ids
array of string
archived
boolean
__v
integer
content
array of object (PageContent)
Array of PageContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
slug
string
Required
A short, human-readable, URL-friendly identifier of a page. You can get slug value of a page from `getPages` API.
Request body
publish
boolean
Response
200
Success.
PageSchema
_id
string
application
string
platform
string
title
string
slug
string
type
string
tags
array of string
content_path
string
orientation
string
description
string
published
boolean
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
page_meta
array of object (PageMeta)
Array of PageMeta
key
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
component_ids
array of string
archived
boolean
__v
integer
content
array of object (PageContent)
Array of PageContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"otvxvpazyaefiadccggwrxotimfvuzfkknp"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to the page.
Response
200
400
Success.
PageSchema
_id
string
application
string
platform
string
title
string
slug
string
type
string
tags
array of string
content_path
string
orientation
string
description
string
published
boolean
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
page_meta
array of object (PageMeta)
Array of PageMeta
key
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
component_ids
array of string
archived
boolean
__v
integer
content
array of object (PageContent)
Array of PageContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
id:
"64af00a447af028b76c97e6f"
Was this section helpful?
DEL
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
_schedule
object (CronSchedule)
CronSchedule
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
application
string
author
object (Author)
Author
designation
string
id
string
name
string
_custom_json
object
orientation
string
content
array of object (PageContent)
Array of PageContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
tags
array of 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)
Required
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
canonical_url
string
title
string
platform
string
type
string
description
string
visibility
object
Visibility of Page.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Success. Refer `PageSchema` for more details.
PageSchema
_id
string
application
string
platform
string
title
string
slug
string
type
string
tags
array of string
content_path
string
orientation
string
description
string
published
boolean
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
page_meta
array of object (PageMeta)
Array of PageMeta
key
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
component_ids
array of string
archived
boolean
__v
integer
content
array of object (PageContent)
Array of PageContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
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 is 10.
Default Value : 10
Response
200
Success. Refer `PageGetResponseSchema` for more details.
PageGetResponseSchema
items
array of object (PageSchema)
Array of PageSchema
_id
string
application
string
platform
string
title
string
slug
string
type
string
tags
array of string
content_path
string
orientation
string
description
string
published
boolean
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
page_meta
array of object (PageMeta)
Array of PageMeta
key
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
component_ids
array of string
archived
boolean
__v
integer
content
array of object (PageContent)
Array of PageContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
page_no:
1
page_size:
10
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to the page.
Request body
_id
string
application
string
platform
string
title
string
slug
string
type
string
tags
array of string
content_path
string
orientation
string
description
string
published
boolean
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
page_meta
array of object (PageMeta)
Array of PageMeta
key
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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)
Required
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
canonical_url
string
component_ids
array of string
archived
boolean
__v
integer
content
array of object (PageContent)
Array of PageContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
Response
200
400
Success. Refer `PageSchema` for more details.
PageSchema
_id
string
application
string
platform
string
title
string
slug
string
type
string
tags
array of string
content_path
string
orientation
string
description
string
published
boolean
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
page_meta
array of object (PageMeta)
Array of PageMeta
key
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
component_ids
array of string
archived
boolean
__v
integer
content
array of object (PageContent)
Array of PageContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
id:
"64af00b447af02792fc97e75"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
slug
string
Required
A short, human-readable, URL-friendly identifier of a page. You can get slug value of a page from `getPages` API.
Response
200
404
Success. Returns a JSON object of components. Refer `PageSchema` for more details.
PageSchema
_id
string
application
string
platform
string
title
string
slug
string
type
string
tags
array of string
content_path
string
orientation
string
description
string
published
boolean
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
_schedule
object (ScheduleSchema)
ScheduleSchema
published
boolean
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
page_meta
array of object (PageMeta)
Array of PageMeta
key
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
component_ids
array of string
archived
boolean
__v
integer
content
array of object (PageContent)
Array of PageContent
type
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
slug:
"testing_slug_for_fetch"
Was this section helpful?
GET
Response
Customer support information on an ecommerce 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. By providing comprehensive customer support information, sellers aim to enhance the overall customer experience, build trust and credibility, and effectively address customer needs and inquiries. This resource allows you to add, remove or alter customer support related information. This information can be either phone number or email id.
Operations
GET
# Get support information
POST
# Update Customer Support Information
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Response
200
Success. 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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
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
Response
200
Success. 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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
POST
Response
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 Fynd 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
POST
# Create data loader
GET
# List data loaders
GET
# Get data loaders api specs.
DEL
# Delete a data loader
PUT
# Update a data loader
GET
# List all data loaders
PUT
# Select a data loader
PUT
# Reset a data loader
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
_id
string
url
string
created_at
string
| date-time
modified_at
string
| date-time
application
string
company
string
name
string
service
string
operation_id
string
is_selected
boolean
type
string
__source
object (DataLoaderSourceSchema)
DataLoaderSourceSchema
type
string
id
string
Response
200
400
Success.
DataLoaderResponseSchema
application
string
company
string
_id
string
name
string
service
string
operation_id
string
type
string
Enum
url
string
content
string
created_at
string
| date-time
modified_at
string
| date-time
__v
number
is_selected
boolean
__source
object (DataLoaderSourceSchema)
DataLoaderSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Response
200
Success. Refer `DataLoadersSchema` for more details.
DataLoadersSchema
items
array of object (DataLoaderSchema)
Array of DataLoaderSchema
_id
string
url
string
created_at
string
| date-time
modified_at
string
| date-time
application
string
company
string
name
string
service
string
operation_id
string
is_selected
boolean
type
string
__source
object (DataLoaderSourceSchema)
DataLoaderSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
data_loader
string
Required
Alphanumeric ID allotted to an application created within a business account.
Response
200
400
Success. Refer `DataLoadersApiSpecSchema` for more details.
DataLoadersApiSpecSchema
info
object
servers
array of object (ServerSchema)
Array of ServerSchema
url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
tags
array of object (TagSpecSchema)
Array of TagSpecSchema
name
string
description
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
openapi
string
paths
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
data_loader:
"content"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
data_loader_id
string
Required
ID allotted to the data loader.
Response
200
404
Success.
DataLoaderResponseSchema
application
string
company
string
_id
string
name
string
service
string
operation_id
string
type
string
Enum
url
string
content
string
created_at
string
| date-time
modified_at
string
| date-time
__v
number
is_selected
boolean
__source
object (DataLoaderSourceSchema)
DataLoaderSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"22"
application_id:
"64d37ebf989a52a3b43ea28b"
data_loader_id:
"64bf91c93ccab7b93c4539c9"
Was this section helpful?
DEL
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
data_loader_id
string
Required
ID allotted to the data loader.
Request body
_id
string
url
string
created_at
string
| date-time
modified_at
string
| date-time
application
string
company
string
name
string
service
string
operation_id
string
is_selected
boolean
type
string
__source
object (DataLoaderSourceSchema)
DataLoaderSourceSchema
type
string
id
string
Response
200
404
Success.
DataLoaderResponseSchema
application
string
company
string
_id
string
name
string
service
string
operation_id
string
type
string
Enum
url
string
content
string
created_at
string
| date-time
modified_at
string
| date-time
__v
number
is_selected
boolean
__source
object (DataLoaderSourceSchema)
DataLoaderSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"22"
application_id:
"64d37ebf989a52a3b43ea28b"
data_loader_id:
"64bf91c93ccab71ef74539c7"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
service_name
string
Required
Service name of the data loader..
Response
200
Success. Refer `DataLoaderItemsResponseSchema` for more details.
DataLoaderItemsResponseSchema
items
array of object (DataLoaderResponseSchema)
Array of DataLoaderResponseSchema
application
string
company
string
_id
string
name
string
service
string
operation_id
string
type
string
Enum
url
string
content
string
created_at
string
| date-time
modified_at
string
| date-time
__v
number
is_selected
boolean
__source
object (DataLoaderSourceSchema)
DataLoaderSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"22"
application_id:
"64d37ebf989a52a3b43ea28b"
service_name:
"catalog"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
data_loader_id
string
Required
ID allotted to the data loader.
Response
200
404
Success.
DataLoaderResponseSchema
application
string
company
string
_id
string
name
string
service
string
operation_id
string
type
string
Enum
url
string
content
string
created_at
string
| date-time
modified_at
string
| date-time
__v
number
is_selected
boolean
__source
object (DataLoaderSourceSchema)
DataLoaderSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"22"
application_id:
"64d37ebf989a52a3b43ea28b"
data_loader_id:
"64bf91c93ccab71ef74539c7"
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
service
string
Required
Name of service.
operation_id
string
Required
Name of operation id of the service.
Response
200
404
Success.
DataLoaderResetResponseSchema
resetted
boolean
Examples
Parameters
company_id:
"22"
application_id:
"64d37ebf989a52a3b43ea28b"
service:
"cart"
operation_id:
"getCart"
Was this section helpful?
PUT
Response
FAQs (Frequently Asked Questions) and FAQ Categories are features 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. By utilizing FAQs and FAQ Categories, one can improve customer satisfaction, reduce support ticket volume, and enhance the overall shopping experience. You can use this resource to access all information pertaining to FAQs and FAQ Categories.
Operations
GET
# List FAQ Categories
GET
# Get FAQ category
POST
# Create FAQ Category
PUT
# Update FAQ category
DEL
# Delete FAQ category
GET
# List FAQs
POST
# Create FAQ
PUT
# Update FAQ
DEL
# Delete FAQ
GET
# Get FAQ or slug
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Response
200
Success. 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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id_or_slug
string
Required
ID or the slug allotted to an FAQ category. Slug is a short, human-readable, URL-friendly identifier of an object. You can get slug value of an FAQ category from `getFaqCategories` API.
Response
200
400
Success. Refer `GetFaqCategoryBySlugSchema` for more details.
GetFaqCategoryBySlugSchema
category
object (FAQCategorySchema)
FAQCategorySchema
_id
string
application
string
title
string
description
string
index
integer
slug
string
children
array of object (ChildrenSchema)
Array of ChildrenSchema
question
string
answer
string
slug
string
application
string
_id
string
icon_url
string
| uri
__v
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
id_or_slug:
"64d1eef9f76a12ff011ca3af"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
category
object (CategoryRequestSchema)
CategoryRequestSchema
slug
string
title
string
Response
200
400
Success.
CreateFaqCategorySchema
category
object (CategorySchema)
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to an FAQ category.
Request body
category
object (CategorySchema)
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.
Response
200
400
Success.
CreateFaqCategorySchema
category
object (CategorySchema)
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
id:
"64d1eef9f76a12ff011ca3af"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to an FAQ category.
Response
200
400
Success.
CreateFaqCategorySchema
category
object (CategorySchema)
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
id:
"64cb9372698007a9493545fa"
Was this section helpful?
DEL
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id_or_slug
string
Required
ID or the slug allotted to an FAQ category. Slug is a short, human-readable, URL-friendly identifier of an object. You can get slug value of an FAQ category from `getFaqCategories` API.
Response
200
400
Success. 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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
id_or_slug:
"64d1eef9f76a12ff011ca3af"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
category_id
string
Required
ID allotted to an FAQ category.
Request body
faq
object (FAQ)
FAQ
slug
string
question
string
answer
string
Response
200
400
Success.
CreateFaqResponseSchema
faq
object (FaqSchema)
FaqSchema
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
__v
number
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
category_id:
"64d1eef9f76a12ff011ca3af"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
category_id
string
Required
ID allotted to an FAQ category.
faq_id
string
Required
ID allotted to an FAQ.
Request body
faq
object (FAQ)
FAQ
slug
string
question
string
answer
string
Response
200
400
Success.
CreateFaqResponseSchema
faq
object (FaqSchema)
FaqSchema
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
__v
number
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
category_id:
"64d1eef9f76a12ff011ca3cd"
faq_id:
"64b7d7515668f85a50275bfd"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
category_id
string
Required
ID allotted to an FAQ category.
faq_id
string
Required
ID allotted to an FAQ.
Response
200
400
Success.
CreateFaqResponseSchema
faq
object (FaqSchema)
FaqSchema
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
__v
number
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
category_id:
"64d1eef9f76a12ff011ca3af"
faq_id:
"64b7d7515668f85a50275bfd"
Was this section helpful?
DEL
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id_or_slug
string
Required
ID or the slug allotted to an FAQ category. Slug is a short, human-readable, URL-friendly identifier of an object. You can get slug value of an FAQ category from `getFaqCategories` API.
Response
200
400
Success. Refer `CreateFaqResponseSchema` for more details.
CreateFaqResponseSchema
faq
object (FaqSchema)
FaqSchema
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
__v
number
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
id_or_slug:
"optimizeaccountr"
Was this section helpful?
GET
Response
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. By incorporating these third-party HTML tags, developers can extend the functionality, performance, and aesthetics of their application or website, enriching the overall user experience and expanding the range of features available to users. This resource allows you to fetch all such Tags that are setup for an application.
Operations
PUT
# Create HTML tag
PUT
# Remove HTML tag
PUT
# Update HTML tag
POST
# Create HTML tags
PUT
# Update HTML Tags
DEL
# Delete HTML tags in application
GET
# Get all the tags in an application
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
tags
array of object (CreateTagSchema)
Array of CreateTagSchema
name
string
sub_type
string
Enum
_id
string
type
string
Enum
url
string
position
string
Enum
attributes
object
pages
array of object
content
string
Response
200
400
Success.
TagsSchema
application
string
_id
string
company
string
__v
number
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
content
string
compatible_engines
array of object
pages
array of object
__source
object (TagSourceSchema)
TagSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
tags
array of string
Response
200
Success.
TagDeleteSuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
"1"
application_id:
"64af9b71ea52c9414e6c53aa"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
tag_id
string
Required
ID allotted to the tag.
Request body
tag
object (HandpickedTagSchema)
HandpickedTagSchema
position
string
attributes
object
name
string
url
string
type
string
sub_type
string
Enum
content
string
Response
200
Success.
TagsSchema
application
string
_id
string
company
string
__v
number
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
content
string
compatible_engines
array of object
pages
array of object
__source
object (TagSourceSchema)
TagSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
tag_id:
"64bf91c903a7203e31c79e6d"
body:
body
Was this section helpful?
PUT
Response
Use this API to create HTML tags. This includes a list of tags with name, tag type (css/js), url and position of the tag
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
tags
array of object (CreateTagSchema)
Array of CreateTagSchema
name
string
sub_type
string
Enum
_id
string
type
string
Enum
url
string
position
string
Enum
attributes
object
pages
array of object
content
string
Response
200
400
Success.
TagsSchema
application
string
_id
string
company
string
__v
number
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
content
string
compatible_engines
array of object
pages
array of object
__source
object (TagSourceSchema)
TagSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28c"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
tags
array of object (CreateTagSchema)
Array of CreateTagSchema
name
string
sub_type
string
Enum
_id
string
type
string
Enum
url
string
position
string
Enum
attributes
object
pages
array of object
content
string
Response
200
400
Success.
TagsSchema
application
string
_id
string
company
string
__v
number
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
content
string
compatible_engines
array of object
pages
array of object
__source
object (TagSourceSchema)
TagSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Response
200
400
Success.
TagsSchema
application
string
_id
string
company
string
__v
number
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
content
string
compatible_engines
array of object
pages
array of object
__source
object (TagSourceSchema)
TagSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
Was this section helpful?
DEL
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Response
200
Success. Refer `TagsSchema` for more details.
TagsSchema
application
string
_id
string
company
string
__v
number
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
content
string
compatible_engines
array of object
pages
array of object
__source
object (TagSourceSchema)
TagSourceSchema
type
string
id
string
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
Was this section helpful?
GET
Response
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
# Get landing pages
POST
# Create landing page
PUT
# Update landing page
DEL
# Delete landing page
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
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 is 10.
Default Value : 10
Response
200
Success. Refer `LandingPageGetResponseSchema` for more details.
LandingPageGetResponseSchema
items
array of object (LandingPageSchema)
Array of LandingPageSchema
slug
string
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
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.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
slug
string
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Success.
LandingPageSchema
slug
string
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"652fd4e9a847c951b210e0ac"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to a landing page.
Request body
slug
string
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Success.
LandingPageSchema
slug
string
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
id:
"64d37ef579ad7c33813dbcba"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to a landing page.
Response
200
400
Success.
LandingPageSchema
slug
string
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ef579ad7c33813dbcba"
id:
"64d37f88e714cb1c9319655e"
Was this section helpful?
DEL
Response
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
# Get Legal Pages
POST
# Update Legal Pages
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Response
200
Success. 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
Examples
Parameters
company_id:
"1"
application_id:
"64d37ef579ad7c33813dbcba"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
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
Response
200
Success. 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
Examples
Parameters
company_id:
"1"
application_id:
"651bb68abe986218d0874b7e"
body:
body
Was this section helpful?
POST
Response
Path redirections are a functionality provided by Fynd Platform that enables you to redirect a customer visiting your website from one URL path to another, for example, from "/path-1" to "/path-2". This feature is particularly useful when a seller is transitioning from another e-commerce platform to Fynd Platform, as it allows for seamless redirection from URLs used by other platforms. This resource allows addition of such redirection rules.
Operations
POST
# Create path redirection rules
GET
# List Path Redirection Rules
GET
# Get Path Redirection Rule
PUT
# Update path redirection rule
DEL
# Delete path redirection rule
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
application
string
_id
string
redirect_from
string
redirect_to
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.
Response
200
400
Success. Refer `PathMappingSchema` for more details.
CreatePathMappingSchema
message
string
data
object (PathMappingSchema)
PathMappingSchema
application
string
_id
string
redirect_from
string
redirect_to
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
page_size
integer
The number of items to retrieve in each page. Default value is 5.
Default Value : 5
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
Response
200
Success. Refer `GetAllPathMappingSchema` for more details.
GetAllPathMappingSchema
message
string
data
object (GetPathSchema)
GetPathSchema
docs
array of object (PathMappingSchema)
Array of PathMappingSchema
application
string
_id
string
redirect_from
string
redirect_to
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.
page
number
limit
number
pages
number
total
number
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
page_size:
10
page_no:
1
Was this section helpful?
GET
Response
Use this API to Get detailed information about a specific path redirection rule
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
path_id
string
Required
ID allotted to the path redirection rule.
Response
200
404
Success. Refer `PathMappingSchema` for more details.
DeletPathMappingSchema
message
string
data
object (PathMappingSchema)
PathMappingSchema
application
string
_id
string
redirect_from
string
redirect_to
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
path_id:
"64ba64ec8c59b57b5e3458d2"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
path_id
string
Required
ID allotted to the path redirection rule.
Request body
application
string
_id
string
redirect_from
string
redirect_to
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.
Response
200
400
Success. Refer `PathMappingSchema` for more details.
CreatePathMappingSchema
message
string
data
object (PathMappingSchema)
PathMappingSchema
application
string
_id
string
redirect_from
string
redirect_to
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
path_id:
"64ba64ec8c59b57b5e3458d2"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
path_id
string
Required
ID allotted to the path redirection rule.
Response
200
404
Success.
DeletPathMappingSchema
message
string
data
object (PathMappingSchema)
PathMappingSchema
application
string
_id
string
redirect_from
string
redirect_to
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
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
path_id:
"64e34708fdaf26c49dc9e360"
Was this section helpful?
DEL
Response
SEO (Search Engine Optimization) in Fynd Platform 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. By integrating these practices seamlessly into their Fynd Platform websites, sellers can bolster organic traffic, elevate search rankings, and cultivate a robust online presence. This resource facilitates the use of retrieving all such content setup for an application into website or mobile applications.
Operations
POST
# Generate SEO title
GET
# Get sales channel SEO
POST
# Update sales channel SEO information
GET
# List default SEO Markup Schemas
GET
# List default SEO Markup Schemas
POST
# Create SEO Markup Schema
GET
# Get SEO Markup Schema
PUT
# Edit SEO Markup Schema
DEL
# Delete SEO Markup Schema
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
type
string
Required
String representing the type of SEO content to be generated. Possible values are: title, description
Request body
text
string
existing_text
string
keywords
array of string
type
string
Response
200
Returns the generated SEO title
GeneratedSEOContent
title
string
description
string
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
type:
"title"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Response
200
Success. Refer `SeoComponent` for more details.
SeoComponent
seo
object (SeoSchema)
SeoSchema
_id
string
app
string
robots_txt
string
sitemap_enabled
boolean
additional_sitemap
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
integer
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
seo
object (SeoSchema)
SeoSchema
_id
string
app
string
robots_txt
string
sitemap_enabled
boolean
additional_sitemap
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
integer
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Success. Refer `SeoSchema` for more details.
SeoSchema
_id
string
app
string
robots_txt
string
sitemap_enabled
boolean
additional_sitemap
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
integer
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
page_type
string
The type of page against which schema template was created
Enum
Response
200
Success. Refer `DefaultSchemaComponent` for more details.
DefaultSchemaComponent
items
array of object (DefaultSEOSchemaMarkupTemplate)
Array of DefaultSEOSchemaMarkupTemplate
page_type
string
Enum
schema
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
page_type:
"product"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
title
string
Title of the seo schema.
active
string
Boolean value for fetching seo schema.
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 is 10.
Default Value : 10
Response
200
Success. Refer `SeoSchemaComponent` for more details.
SeoSchemaComponent
items
array of object (SEOSchemaMarkupTemplate)
Array of SEOSchemaMarkupTemplate
_id
string
title
string
page_type
string
Enum
schema
string
description
string
active
boolean
application
string
created_at
string
| date-time
updated_at
string
| date-time
target_json
object
__v
number
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.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
title
string
page_type
string
Enum
description
string
schema
string
| byte
target_json
object
active
boolean
created_at
string
| date-time
Response
200
400
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
_id
string
title
string
page_type
string
Enum
schema
string
description
string
active
boolean
application
string
created_at
string
| date-time
updated_at
string
| date-time
target_json
object
__v
number
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
schema_id
string
Required
Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.
Response
200
400
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
_id
string
title
string
page_type
string
Enum
schema
string
description
string
active
boolean
application
string
created_at
string
| date-time
updated_at
string
| date-time
target_json
object
__v
number
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
schema_id:
"652d683312367c1560778fbc"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
schema_id
string
Required
Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.
Request body
title
string
page_type
string
Enum
description
string
schema
string
| byte
target_json
object
active
boolean
created_at
string
| date-time
Response
200
400
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
_id
string
title
string
page_type
string
Enum
schema
string
description
string
active
boolean
application
string
created_at
string
| date-time
updated_at
string
| date-time
target_json
object
__v
number
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
schema_id:
"60c1d88e8f045b0019b18f90"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
schema_id
string
Required
Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.
Response
200
400
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
_id
string
title
string
page_type
string
Enum
schema
string
description
string
active
boolean
application
string
created_at
string
| date-time
updated_at
string
| date-time
target_json
object
__v
number
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"1"
application_id:
"64d37ebf989a52a3b43ea28b"
schema_id:
"652d683312367c1560778fbc"
Was this section helpful?
DEL
Response
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
# Get default sitemap configuration
PUT
# Update default sitemap configuration
GET
# List sitemap configurations
POST
# Create a new sitemap configuration
GET
# Get a specific sitemap configuration
PUT
# Update a specific sitemap configuration
DEL
# Delete a specific sitemap configuration
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
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
Response
200
400
Configuration updated successfully
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
PUT
Response
Retrieve a list of sitemap configurations for a specific company and application. Each configuration contains the sitemap XML data and its activation status.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
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.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
page_no:
"1"
page_size:
"10"
Was this section helpful?
GET
Response
Create a new sitemap configuration for a specific company and application. The name must be unique within the scope of the application. The sitemap XML data must be valid XML following the sitemap protocol specification. Once created, the configuration can be activated or deactivated using the is_active flag.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
name
string
Unique identifier for the sitemap configuration
is_active
boolean
Indicates if the sitemap configuration is active
sitemap
string
XML string containing sitemap data in base64 encoding
Response
200
400
Sitemap configuration created successfully
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
body:
body
Was this section helpful?
POST
Response
Retrieve a specific sitemap configuration by its name. Returns the complete configuration including the sitemap XML data, activation status, and timestamps.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
name:
"main-sitemap"
Was this section helpful?
GET
Response
Update an existing sitemap configuration identified by its name. You can update the activation status and/or the sitemap XML data. The name cannot be modified once the configuration is created. The updated sitemap XML data must be valid XML following the sitemap protocol specification.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
name
string
Required
Unique identifier for the sitemap configuration
Request body
is_active
boolean
Indicates if the sitemap configuration is active
sitemap
string
XML string containing sitemap data
Response
200
400
Sitemap configuration updated successfully
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
name:
"main-sitemap"
body:
body
Was this section helpful?
PUT
Response
Permanently delete a sitemap configuration identified by its name. This action cannot be undone. All associated data including the sitemap XML data will be removed.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
name
string
Required
Unique identifier for the sitemap configuration
Response
200
Sitemap configuration deleted successfully
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
company_id:
1
application_id:
"64d37ebf989a52a3b43ea28b"
name:
"delete-sitemap"
Was this section helpful?
DEL
Response