Content
The Content service manages various types of content on the e-commerce platform, including Announcements, Blogs, Legal content, Navigation menus, Custom Pages, Path Redirection Rules, Customer Support information, and Slideshows.
Announcement
Announcements are banners or notifications that appear on top of your website or below the headers of navigation content in mobile applications. These will generally display any information that you wish to highlight to customers, such as a running or upcoming sale offer, vital notice information, or any user or business activities that need attention. This resource allows you to 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
GET
List announcements
Lists all announcements
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
Response
200
4XX
5XX
Success. Refer `GetAnnouncementListSchema` for more details.
GetAnnouncementListSchema
items
array of object (AdminAnnouncementSchema)
Optional
Array of AdminAnnouncementSchema
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
List announcements
getAnnouncementsList
POST
Create announcement
Generate and add a new announcement.
Parameters
body
object (AdminAnnouncementSchema)
Refer `AdminAnnouncementSchema` for more details.
AdminAnnouncementSchema
_id
string
Optional
platforms
array of string
Optional
title
string
Optional
announcement
string
Optional
pages
array of object (AnnouncementPageSchema)
Optional
Array of AnnouncementPageSchema
editor_meta
object (EditorMeta)
Optional
EditorMeta
author
object (AnnouncementAuthorSchema)
Optional
AnnouncementAuthorSchema
created_at
string
Optional
app
string
Optional
modified_at
string
Optional
_schedule
object (ScheduleSchema)
Optional
ScheduleSchema
Response
200
4XX
5XX
Success. Refer `CreateAnnouncementSchema` for more details.
CreateAnnouncementSchema
message
string
Optional
data
object (AdminAnnouncementSchema)
Optional
AdminAnnouncementSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Example response not available.
Create announcement
createAnnouncement
GET
Get announcement
Get detailed information about a specific announcement
Parameters
announcementId
string
ID allotted to the announcement.
Response
200
4XX
5XX
Success. Refer `AdminAnnouncementSchema` for more details.
AdminAnnouncementSchema
_id
string
Optional
platforms
array of string
Optional
title
string
Optional
announcement
string
Optional
pages
array of object (AnnouncementPageSchema)
Optional
Array of AnnouncementPageSchema
editor_meta
object (EditorMeta)
Optional
EditorMeta
author
object (AnnouncementAuthorSchema)
Optional
AnnouncementAuthorSchema
created_at
string
Optional
app
string
Optional
modified_at
string
Optional
_schedule
object (ScheduleSchema)
Optional
ScheduleSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get announcement
getAnnouncementById
PUT
Update announcement
Modify the content and settings of a specific announcement.
Parameters
announcementId
string
ID allotted to the announcement.
body
object (AdminAnnouncementSchema)
Refer `AdminAnnouncementSchema` for more details.
AdminAnnouncementSchema
_id
string
Optional
platforms
array of string
Optional
title
string
Optional
announcement
string
Optional
pages
array of object (AnnouncementPageSchema)
Optional
Array of AnnouncementPageSchema
editor_meta
object (EditorMeta)
Optional
EditorMeta
author
object (AnnouncementAuthorSchema)
Optional
AnnouncementAuthorSchema
created_at
string
Optional
app
string
Optional
modified_at
string
Optional
_schedule
object (ScheduleSchema)
Optional
ScheduleSchema
Response
200
4XX
5XX
Success. Refer `CreateAnnouncementSchema` for more details.
CreateAnnouncementSchema
message
string
Optional
data
object (AdminAnnouncementSchema)
Optional
AdminAnnouncementSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Loading...
Response
Example response not available.
Update announcement
updateAnnouncement
PATCH
Update announcement schedule
Modify the scheduling of a specific announcement.
Parameters
announcementId
string
ID allotted to the announcement.
body
object (ScheduleSchema)
Refer `ScheduleSchema` for knowing more about the request body for **Update Schedule** and **Unpublish Announcement** respectively.
ScheduleSchema
cron
string
Optional
start
string
Optional
end
string
Optional
duration
number
Optional
next_schedule
array of object (NextSchedule)
Optional
Array of NextSchedule
Response
200
4XX
5XX
Success. Refer `CreateAnnouncementSchema` for more details.
CreateAnnouncementSchema
message
string
Optional
data
object (AdminAnnouncementSchema)
Optional
AdminAnnouncementSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
PATCH
Loading...
Response
Example response not available.
Update announcement schedule
updateAnnouncementSchedule
DEL
Delete an announcement
Remove a specific announcement.
Parameters
announcementId
string
ID allotted to the announcement.
Response
200
4XX
5XX
Success.
CreateAnnouncementSchema
message
string
Optional
data
object (AdminAnnouncementSchema)
Optional
AdminAnnouncementSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Loading...
Response
Example response not available.
Delete an announcement
deleteAnnouncement
Blog
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 blog by slug
POST
Create blog
Generate and add a new blog.
Parameters
body
object (BlogRequest)
Pass the author details, content, feature image, title, SEO details, etc. in the request body. Refer `BlogRequest` for more details.
BlogRequest
application
string
Optional
_custom_json
object
Optional
author
object (Author)
Optional
Author
content
array of object (ResourceContent)
Optional
Array of ResourceContent
feature_image
object (Asset)
Optional
Asset
published
boolean
Optional
reading_time
string
Optional
slug
string
Optional
tags
array of string
Optional
title
string
Optional
seo
object (SEO)
Optional
SEO
_schedule
object (CronSchedule)
Optional
CronSchedule
Response
200
4XX
5XX
Success. Refer `BlogSchema` for more details.
BlogSchema
_id
string
Optional
_custom_json
object
Optional
application
string
Optional
archived
boolean
Optional
author
object (Author)
Optional
Author
content
array of object (ResourceContent)
Optional
Array of ResourceContent
feature_image
object (Asset)
Optional
Asset
published
boolean
Optional
reading_time
string
Optional
slug
string
Optional
tags
array of string
Optional
seo
object (SEO)
Optional
SEO
_schedule
object (CronSchedule)
Optional
CronSchedule
title
string
Optional
date_meta
object (DateMeta)
Optional
DateMeta
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Create blog
createBlog
GET
List blogs
List all blogs
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
Response
200
4XX
5XX
Success. Refer `BlogGetResponse` for more details.
BlogGetResponse
items
array of object (BlogSchema)
Optional
Array of BlogSchema
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
List blogs
getBlogs
PUT
Update a blog
Modify the content and settings of a specific blog.
Parameters
id
string
ID allotted to the blog.
body
object (BlogRequest)
Refer `BlogRequest` for more details.
BlogRequest
application
string
Optional
_custom_json
object
Optional
author
object (Author)
Optional
Author
content
array of object (ResourceContent)
Optional
Array of ResourceContent
feature_image
object (Asset)
Optional
Asset
published
boolean
Optional
reading_time
string
Optional
slug
string
Optional
tags
array of string
Optional
title
string
Optional
seo
object (SEO)
Optional
SEO
_schedule
object (CronSchedule)
Optional
CronSchedule
Response
200
4XX
5XX
Success.
BlogSchema
_id
string
Optional
_custom_json
object
Optional
application
string
Optional
archived
boolean
Optional
author
object (Author)
Optional
Author
content
array of object (ResourceContent)
Optional
Array of ResourceContent
feature_image
object (Asset)
Optional
Asset
published
boolean
Optional
reading_time
string
Optional
slug
string
Optional
tags
array of string
Optional
seo
object (SEO)
Optional
SEO
_schedule
object (CronSchedule)
Optional
CronSchedule
title
string
Optional
date_meta
object (DateMeta)
Optional
DateMeta
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Example response not available.
Update a blog
updateBlog
DEL
Delete a blog
Remove a specific blog.
Parameters
id
string
ID allotted to the blog.
Response
200
4XX
5XX
Success.
BlogSchema
_id
string
Optional
_custom_json
object
Optional
application
string
Optional
archived
boolean
Optional
author
object (Author)
Optional
Author
content
array of object (ResourceContent)
Optional
Array of ResourceContent
feature_image
object (Asset)
Optional
Asset
published
boolean
Optional
reading_time
string
Optional
slug
string
Optional
tags
array of string
Optional
seo
object (SEO)
Optional
SEO
_schedule
object (CronSchedule)
Optional
CronSchedule
title
string
Optional
date_meta
object (DateMeta)
Optional
DateMeta
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Loading...
Response
Example response not available.
Delete a blog
deleteBlog
GET
Get blog by slug
Retrieve detailed information about a specific blog using its slug.
Parameters
slug
string
A short, human-readable, URL-friendly identifier of a blog page. You can get slug value of a blog from `getBlogs` API.
Response
200
4XX
5XX
Success. Returns a a JSON object with components. Refer `BlogSchema` for more details.
BlogSchema
_id
string
Optional
_custom_json
object
Optional
application
string
Optional
archived
boolean
Optional
author
object (Author)
Optional
Author
content
array of object (ResourceContent)
Optional
Array of ResourceContent
feature_image
object (Asset)
Optional
Asset
published
boolean
Optional
reading_time
string
Optional
slug
string
Optional
tags
array of string
Optional
seo
object (SEO)
Optional
SEO
_schedule
object (CronSchedule)
Optional
CronSchedule
title
string
Optional
date_meta
object (DateMeta)
Optional
DateMeta
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get blog by slug
getBlogBySlug
Custom Fields
Custom fields are a flexible way to attach additional information to a resource (e.g. Product, promotions, etc.). Some examples of data stored using 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
POST
# Create custom field definition
GET
# Get custom fields definition
PUT
# Update custom field definition
DEL
# Delete custom fields definition
GET
# Get list of custom fields of given resource
GET
# Get list of custom fields of given resource and resource id
PUT
# Create custom field entries for gives resource and resource_id
GET
# Get custom field types
GET
# Get resources
GET
# Get custom fields definitions
POST
# Create custom field definition
GET
# Get custom fields definition
PUT
# Update custom field definition
DEL
# Delete custom fields definition
GET
# Get list of custom fields of gives resource
GET
# Get list of custom fields of given resource and resource id
PUT
# Create custom field entries for gives resource and resource_id
GET
Get custom field types
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
No Parameters
Response
200
400
500
Success. Returns all custom field types.
CustomObjectByIdSchema
_id
string
Optional
status
string
Optional
display_name
string
Optional
definition
object (CustomObjectListItemDefinationSchema)
Optional
CustomObjectListItemDefinationSchema
references
array of Undefined Type
Optional
fields
array of object (CustomObjectFieldSchema)
Optional
Array of CustomObjectFieldSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom field types
getCustomFieldTypes
GET
Get resources
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
No Parameters
Response
200
4XX
5XX
Success. Returns a JSON object of resources. Refer `ResourcesSchema` for more details.
ResourcesSchema
resources
array of object (ResourceSchema)
Optional
Array of ResourceSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get resources
getResources
GET
Get custom fields definitions
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
pageNo
string
This is the page number
pageSize
string
This is the page size
resource
string
Optional
This is the resource for which we are fetching definitions
type
string
Optional
This is the type of the custom fields definitions
search
string
Optional
This is the search text to filter custom fields definitions
Response
200
400
500
Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionsSchema
items
array of object (FieldDefinitionSchema)
Optional
Array of FieldDefinitionSchema
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
1
pageSize:
10
resource:
"product"
type:
"string_single_line"
search:
"sometext"
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get custom fields definitions
getCustomFieldDefinitions
POST
Create custom field definition
You can create custom fields definition to any resource so you can extend property of resource.
Parameters
body
object (CustomFieldDefinitionRequestSchema)
Custom field definition data
CustomFieldDefinitionRequestSchema
resource
string
Optional
type
string
Optional
key
string
Optional
namespace
string
Optional
multi_value
boolean
Optional
name
string
Optional
description
string
Optional
validations
array of object (FieldValidations)
Optional
Array of FieldValidations
Response
200
400
500
Custom field definition created.
CustomFieldDefinitionDetailResSchema
creator
string
Optional
resource
string
Optional
name
string
Optional
namespace
string
Optional
key
string
Optional
description
string
Optional
type
string
Optional
multi_value
boolean
Optional
company_id
string
| integer
Optional
application_id
string
Optional
created_by
string
Optional
updated_by
string
Optional
required
boolean
Optional
is_deleted
boolean
Optional
_id
string
Optional
validations
array of Undefined Type
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Create custom field definition
createCustomFieldDefinition
GET
Get custom fields definition
Custom field definitions can be fetch using definition id.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Success. Returns a object of custom field definition. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionDetailResSchema
creator
string
Optional
resource
string
Optional
name
string
Optional
namespace
string
Optional
key
string
Optional
description
string
Optional
type
string
Optional
multi_value
boolean
Optional
company_id
string
| integer
Optional
application_id
string
Optional
created_by
string
Optional
updated_by
string
Optional
required
boolean
Optional
is_deleted
boolean
Optional
_id
string
Optional
validations
array of object
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get custom fields definition
getCustomFieldDefinition
PUT
Update custom field definition
Custom fields definition can be update using this api, You can update custom field definition name and description.
Parameters
definitionId
string
This is definition id
body
object (CustomFieldDefinitionRequestSchema)
Custom field definition data
CustomFieldDefinitionRequestSchema
resource
string
Optional
type
string
Optional
key
string
Optional
namespace
string
Optional
multi_value
boolean
Optional
name
string
Optional
description
string
Optional
validations
array of object (FieldValidations)
Optional
Array of FieldValidations
Response
200
400
500
Custom field definition created.
CustomFieldDefinitionDetailResSchema
creator
string
Optional
resource
string
Optional
name
string
Optional
namespace
string
Optional
key
string
Optional
description
string
Optional
type
string
Optional
multi_value
boolean
Optional
company_id
string
| integer
Optional
application_id
string
Optional
created_by
string
Optional
updated_by
string
Optional
required
boolean
Optional
is_deleted
boolean
Optional
_id
string
Optional
validations
array of object
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
PUT
Loading...
Response
Example response not available.
Update custom field definition
updateCustomFieldDefinition
DEL
Delete custom fields definition
Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
Optional
message
string
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
DEL
Loading...
Response
Example response not available.
Delete custom fields definition
deleteCustomFieldDefinition
GET
Get list of custom fields of given resource
Retrieves a list of custom fields attached to a particular resource by using the resource.
Parameters
resource
string
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
Response
200
400
500
Success. Returns a list of custom fields. Refer `CustomFieldsResponseSchema` for more details.
CustomFieldsResponseSchema
items
array of object (CustomFieldSchema)
Optional
Array of CustomFieldSchema
page
object (Page)
Optional
Page
Examples
Parameters
resource:
"product"
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get list of custom fields of given resource
getCustomFields
GET
Get list of custom fields of given resource and resource id
Retrieves a list of custom fields attached to a particular resource by using the resource and resource id.
Parameters
resource
string
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resourceId
string
This is the resource id for which custom fields created
Response
200
400
500
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Optional
Array of CustomFieldSchema
Examples
Parameters
resource:
"product"
resourceId:
"64bb987e9a3c4b6c29d676bc"
Was this section helpful?
GET
Loading...
Response
Loading...
Get list of custom fields of given resource and resource id
getCustomFieldsByResourceId
PUT
Create custom field entries for gives resource and resource_id
You can add a custom field using this endpoint to any resource by providing the resource ID.
Parameters
resource
string
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resourceId
string
This is the resource id for which custom fields created
body
object (CustomFieldRequestSchema)
Custom field data
CustomFieldRequestSchema
fields
array of object (CustomField)
Optional
Array of CustomField
Response
200
400
500
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Optional
Array of CustomFieldSchema
Examples
Parameters
resource:
"product"
resourceId:
"64bb987e9a3c4b6c29d676bc"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Create custom field entries for gives resource and resource_id
createCustomFieldByResourceId
GET
Get custom field types
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
No Parameters
Response
200
400
500
Success. Returns all custom field types.
CustomObjectByIdSchema
_id
string
Optional
status
string
Optional
display_name
string
Optional
definition
object (CustomObjectListItemDefinationSchema)
Optional
CustomObjectListItemDefinationSchema
references
array of object
Optional
fields
array of object (CustomObjectFieldSchema)
Optional
Array of CustomObjectFieldSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom field types
getAppCustomFieldTypes
GET
Get resources
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
No Parameters
Response
200
4XX
5XX
Success. Returns a JSON object of resources. Refer `ResourcesSchema` for more details.
ResourcesSchema
resources
array of object (ResourceSchema)
Optional
Array of ResourceSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get resources
getAppResources
GET
Get custom fields definitions
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
pageNo
string
This is the page number
pageSize
string
This is the page size
resource
string
Optional
This is the resource for which we are fetching definitions
type
string
Optional
This is the type of the custom fields definitions
search
string
Optional
This is the search text to filter custom fields definitions
Response
200
400
500
Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionsSchema
items
array of object (FieldDefinitionSchema)
Optional
Array of FieldDefinitionSchema
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
1
pageSize:
10
resource:
"product"
type:
"string_single_line"
search:
"sometext"
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get custom fields definitions
getAppCustomFieldDefinitions
POST
Create custom field definition
You can create custom fields definition to any resource so you can extend property of resource.
Parameters
body
object (CustomFieldDefinitionRequestSchema)
Custom field definition data
CustomFieldDefinitionRequestSchema
resource
string
Optional
type
string
Optional
key
string
Optional
namespace
string
Optional
multi_value
boolean
Optional
name
string
Optional
description
string
Optional
validations
array of object (FieldValidations)
Optional
Array of FieldValidations
Response
200
400
500
Custom field definition created.
CustomFieldDefinitionDetailResSchema
creator
string
Optional
resource
string
Optional
name
string
Optional
namespace
string
Optional
key
string
Optional
description
string
Optional
type
string
Optional
multi_value
boolean
Optional
company_id
string
| integer
Optional
application_id
string
Optional
created_by
string
Optional
updated_by
string
Optional
required
boolean
Optional
is_deleted
boolean
Optional
_id
string
Optional
validations
array of object
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Create custom field definition
createAppCustomFieldDefinition
GET
Get custom fields definition
Custom field definitions can be fetch using definition id.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Success. Returns a object of custom field definition. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionDetailResSchema
creator
string
Optional
resource
string
Optional
name
string
Optional
namespace
string
Optional
key
string
Optional
description
string
Optional
type
string
Optional
multi_value
boolean
Optional
company_id
string
| integer
Optional
application_id
string
Optional
created_by
string
Optional
updated_by
string
Optional
required
boolean
Optional
is_deleted
boolean
Optional
_id
string
Optional
validations
array of object
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get custom fields definition
getAppCustomFieldDefinition
PUT
Update custom field definition
Custom fields definition can be update using this api, You can update custom field definition name and description.
Parameters
definitionId
string
This is definition id
body
object (CustomFieldDefinitionRequestSchema)
Custom field definition data
CustomFieldDefinitionRequestSchema
resource
string
Optional
type
string
Optional
key
string
Optional
namespace
string
Optional
multi_value
boolean
Optional
name
string
Optional
description
string
Optional
validations
array of object (FieldValidations)
Optional
Array of FieldValidations
Response
200
400
500
Custom field definition created.
CustomFieldDefinitionDetailResSchema
creator
string
Optional
resource
string
Optional
name
string
Optional
namespace
string
Optional
key
string
Optional
description
string
Optional
type
string
Optional
multi_value
boolean
Optional
company_id
string
| integer
Optional
application_id
string
Optional
created_by
string
Optional
updated_by
string
Optional
required
boolean
Optional
is_deleted
boolean
Optional
_id
string
Optional
validations
array of object
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
PUT
Loading...
Response
Example response not available.
Update custom field definition
updateAppCustomFieldDefinition
DEL
Delete custom fields definition
Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
Optional
message
string
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
DEL
Loading...
Response
Example response not available.
Delete custom fields definition
deleteAppCustomFieldDefinition
GET
Get list of custom fields of gives resource
Retrieves a list of custom fields attached to a particular resource by using the resource.
Parameters
resource
string
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
Response
200
400
500
Success. Returns a list of custom fields. Refer `CustomFieldsResponseSchema` for more details.
CustomFieldsResponseSchema
items
array of object (CustomFieldSchema)
Optional
Array of CustomFieldSchema
page
object (Page)
Optional
Page
Examples
Parameters
resource:
"product"
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get list of custom fields of gives resource
getAppCustomFields
GET
Get list of custom fields of given resource and resource id
Retrieves a list of custom fields attached to a particular resource by using the resource and resource id.
Parameters
resource
string
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resourceId
string
This is the resource id for which custom fields created
Response
200
400
500
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Optional
Array of CustomFieldSchema
Examples
Parameters
resource:
"product"
resourceId:
"64bb987e9a3c4b6c29d676bc"
Was this section helpful?
GET
Loading...
Response
Loading...
Get list of custom fields of given resource and resource id
getAppCustomFieldsByResourceId
PUT
Create custom field entries for gives resource and resource_id
You can add a custom field using this endpoint to any resource by providing the resource ID.
Parameters
resource
string
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resourceId
string
This is the resource id for which custom fields created
body
object (CustomFieldRequestSchema)
Custom field data
CustomFieldRequestSchema
fields
array of object (CustomField)
Optional
Array of CustomField
Response
200
400
500
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Optional
Array of CustomFieldSchema
Examples
Parameters
resource:
"product"
resourceId:
"64bb987e9a3c4b6c29d676bc"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Create custom field entries for gives resource and resource_id
createAppCustomFieldByResourceId
Custom Objects
Custom objects refer to entities that are not currently present on the platform. Sellers can create these custom data structures, allowing them to define the essential custom fields according to their preferences. These custom objects are introduced to address unique data requirements that fall outside the platform's standard features.
Operations
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
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
POST
Create custom object definition
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
body
object (CustomObjectDefinitionRequestSchema)
Custom object defintion data with custom fields in it
CustomObjectDefinitionRequestSchema
type
string
Optional
description
string
Optional
name
string
Optional
display_name_key
string
Optional
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
Optional
Array of CustomObjectCustomFieldDefinitions
Response
200
400
500
Success. Returns the saved custom object defintion
CustomObjectDefinitionSchema
_id
string
Optional
name
string
Optional
type
string
Optional
display_name_key
string
Optional
description
string
Optional
creator
string
Optional
created_by
string
Optional
updated_by
string
Optional
field_definitions
array of object (CustomObjectCustomFieldDefinitionResSchema)
Optional
Array of CustomObjectCustomFieldDefinitionResSchema
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create custom object definition
createCustomObjectDefinition
GET
Get custom object definitions
Custom object definition lists can be obtained using this endpoint.
Parameters
pageNo
string
This is the page number
pageSize
string
This is the page size
search
string
Optional
This is the search text to filter custom fields definitions
Response
200
400
500
Success. Returns a list custom object definitions.
CustomObjectDefinitionsSchema
items
array of object (CustomObjectEntry)
Optional
Array of CustomObjectEntry
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
1
pageSize:
10
search:
"sometext"
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom object definitions
getCustomObjectDefinitions
GET
Get custom object definition
Custom object definitions can be fetched using their definition ID.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Custom object definition details.
CustomObjectDefinitionSchema
_id
string
Optional
name
string
Optional
type
string
Optional
display_name_key
string
Optional
description
string
Optional
creator
string
Optional
created_by
string
Optional
updated_by
string
Optional
field_definitions
array of object (CustomObjectCustomFieldDefinitionResSchema)
Optional
Array of CustomObjectCustomFieldDefinitionResSchema
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom object definition
getCustomObjectDefinition
PUT
Update custom object definition
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
definitionId
string
This is definition id
body
object (CustomObjectDefinitionUpdateRequestSchema)
Custom object definition data
CustomObjectDefinitionUpdateRequestSchema
type
string
Optional
description
string
Optional
name
string
Optional
display_name_key
string
Optional
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
Optional
Array of CustomObjectCustomFieldDefinitions
Response
200
400
500
Custom field definition updated.
CustomObjectDefinitionSchema
_id
string
Optional
name
string
Optional
type
string
Optional
display_name_key
string
Optional
description
string
Optional
creator
string
Optional
created_by
string
Optional
updated_by
string
Optional
field_definitions
array of object (CustomObjectCustomFieldDefinitionResSchema)
Optional
Array of CustomObjectCustomFieldDefinitionResSchema
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
PUT
Loading...
Response
Loading...
Update custom object definition
updateCustomObjectDefinition
DEL
delete custom object definition
Custom object definitions can be deleted using this endpoint by providing the definition ID.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Custom object definition details.
CustomObjectDefinitionDeleteResponseSchema
success
boolean
Optional
message
string
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
DEL
Loading...
Response
Loading...
delete custom object definition
deleteCustomObjectDefinition
GET
Get list of custom objects
Custom object entries can fetch using this endpoint.
Parameters
definitionId
string
Optional
This is definition id
pageNo
string
This is the page number
pageSize
string
This is the page size
Response
200
400
500
Success. Returns a list of custom objects. Refer `CustomObjectsSchema` for more details.
CustomObjectsSchema
items
array of object (CustomObjectListItemSchema)
Optional
Array of CustomObjectListItemSchema
page
object (Page)
Optional
Page
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
pageNo:
1
pageSize:
10
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get list of custom objects
getCustomObjects
POST
Create custom object entries
Custom object entries against the custom object definition can be added using this API.
Parameters
body
object (CustomObjectRequestSchema)
Custom object data with field entry
CustomObjectRequestSchema
status
string
Optional
definition_id
string
Optional
fields
array of object (CustomObjectEntryFieldSchema)
Optional
Array of CustomObjectEntryFieldSchema
Response
200
400
500
Success. Returns a list of custom objects. Refer `CustomObjectSchema` for more details.
CustomObjectSchema
_id
string
Optional
creator
string
Optional
company_id
string
| integer
Optional
application_id
string
Optional
created_by
string
Optional
updated_by
string
Optional
status
string
Optional
type
string
Optional
display_name
string
Optional
definition_id
string
Optional
fields
array of object (CustomFieldSchema)
Optional
Array of CustomFieldSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Example response not available.
Create custom object entries
createCustomObject
GET
Get custom object details
Details of custom objects, their field details, definitions, and references can be obtained using this endpoint.
Parameters
metaobjectId
string
This is meta object id
Response
200
400
500
Success. Returns a custom object. Refer `CustomObjectByIdSchema` for more details.
CustomObjectByIdSchema
_id
string
Optional
status
string
Optional
display_name
string
Optional
definition
object (CustomObjectListItemDefinationSchema)
Optional
CustomObjectListItemDefinationSchema
references
array of object
Optional
fields
array of object (CustomObjectFieldSchema)
Optional
Array of CustomObjectFieldSchema
Examples
Parameters
metaobjectId:
"65392bd912376081aafa90ff"
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get custom object details
getCustomObject
DEL
Delete custom object
Custom object entries can be deleted by providing the delete ID using this endpoint.
Parameters
metaobjectId
string
This is meta object id
Response
200
400
500
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
Optional
message
string
Optional
Examples
Parameters
metaobjectId:
"65392bd912376081aafa90ff"
Was this section helpful?
DEL
Loading...
Response
Example response not available.
Delete custom object
deleteCustomObject
PUT
Update custom object details
Custom object entries can be updated using this endpoint.
Parameters
metaobjectId
string
This is meta object id
body
object (CustomObjectRequestSchema)
Custom object definition data
CustomObjectRequestSchema
status
string
Optional
definition_id
string
Optional
fields
array of object (CustomObjectEntryFieldSchema)
Optional
Array of CustomObjectEntryFieldSchema
Response
200
400
500
Custom field definition created.
CustomObjectByIdSchema
_id
string
Optional
status
string
Optional
display_name
string
Optional
definition
object (CustomObjectListItemDefinationSchema)
Optional
CustomObjectListItemDefinationSchema
references
array of object
Optional
fields
array of object (CustomObjectFieldSchema)
Optional
Array of CustomObjectFieldSchema
Examples
Parameters
metaobjectId:
"65392bd912376081aafa90ff"
Was this section helpful?
PUT
Loading...
Response
Loading...
Update custom object details
updateCustomObject
GET
Get bulk import and export job list
Custom object bulk import and export jobs status and details can be obtained using this endpoint.
Parameters
page
string
This is the page number
pageSize
string
This is the page size
actionType
string
This is the action type
Response
200
400
500
Success. Returns all bulk entries history.
CustomObjectBulkEntry
items
array of object (CustomObjectJobSchema)
Optional
Array of CustomObjectJobSchema
page
object (Page)
Optional
Page
Examples
Parameters
page:
1
pageSize:
10
actionType:
"upload"
Was this section helpful?
GET
Loading...
Response
Loading...
Get bulk import and export job list
getJobs
POST
Bulk custom object entries upload
Custom object bulk import of bulk entries can be performed using this endpoint.
Parameters
definitionId
string
This is definition id
body
object (CustomObjectBulkSchema)
Custom Object bulk entires url and total counts.
CustomObjectBulkSchema
url
string
Optional
total_records
integer
Optional
Response
200
400
500
Success. Returns confirmation that the upload has started
CustomObjectEntryBulkUploadResponse
url
string
Optional
total_records
integer
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Bulk custom object entries upload
importCustomObjectEntries
GET
Initiate download for bulk custom object entries
Custom object bulk export of bulk entries can be perform using this endpoint.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Success. Initiates bulk entries download
CustomObjectBulkEntryInitiateDownload
message
string
Optional
task_id
string
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Loading...
Initiate download for bulk custom object entries
exportCustomObjectEntries
GET
Download sample for custom object bulk entry
Sample files for custom object bulk import can be obtained from this endpoint.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Success. Get headers of custom object definition
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Loading...
Download sample for custom object bulk entry
sampleCustomObjectBulkEntry
POST
Create custom object definition
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
body
object (CustomObjectDefinitionRequestSchema)
Custom object defintion data with custom fields in it
CustomObjectDefinitionRequestSchema
type
string
Optional
description
string
Optional
name
string
Optional
display_name_key
string
Optional
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
Optional
Array of CustomObjectCustomFieldDefinitions
Response
200
400
500
Success. Returns the saved custom object defintion
CustomObjectDefinitionSchema
_id
string
Optional
name
string
Optional
type
string
Optional
display_name_key
string
Optional
description
string
Optional
creator
string
Optional
created_by
string
Optional
updated_by
string
Optional
field_definitions
array of object (CustomObjectCustomFieldDefinitionResSchema)
Optional
Array of CustomObjectCustomFieldDefinitionResSchema
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create custom object definition
createAppCustomObjectDefinition
GET
Get custom object definitions
Custom object definition lists can be obtained using this endpoint.
Parameters
pageNo
string
This is the page number
pageSize
string
This is the page size
search
string
Optional
This is the search text to filter custom fields definitions
Response
200
400
500
Success. Returns a list custom object definitions.
CustomObjectDefinitionsSchema
items
array of object (CustomObjectEntry)
Optional
Array of CustomObjectEntry
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
1
pageSize:
10
search:
"sometext"
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom object definitions
getAppCustomObjectDefinitions
GET
Get custom object definition
Custom object definitions can be fetched using their definition ID.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Success. It will returns the message for delete successfully.
CustomObjectDefinitionSchema
_id
string
Optional
name
string
Optional
type
string
Optional
display_name_key
string
Optional
description
string
Optional
creator
string
Optional
created_by
string
Optional
updated_by
string
Optional
field_definitions
array of object (CustomObjectCustomFieldDefinitionResSchema)
Optional
Array of CustomObjectCustomFieldDefinitionResSchema
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom object definition
getAppCustomObjectDefinition
PUT
Update custom object definition
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
definitionId
string
This is definition id
body
object (CustomObjectDefinitionUpdateRequestSchema)
Custom object definition data
CustomObjectDefinitionUpdateRequestSchema
type
string
Optional
description
string
Optional
name
string
Optional
display_name_key
string
Optional
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
Optional
Array of CustomObjectCustomFieldDefinitions
Response
200
400
500
Custom field definition updated.
CustomObjectDefinitionSchema
_id
string
Optional
name
string
Optional
type
string
Optional
display_name_key
string
Optional
description
string
Optional
creator
string
Optional
created_by
string
Optional
updated_by
string
Optional
field_definitions
array of object (CustomObjectCustomFieldDefinitionResSchema)
Optional
Array of CustomObjectCustomFieldDefinitionResSchema
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
PUT
Loading...
Response
Loading...
Update custom object definition
updateAppCustomObjectDefinition
DEL
Delete custom object definition
Custom object definitions can be deleted using this endpoint by providing the definition ID.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Custom object definition details.
CustomObjectDefinitionDeleteResponseSchema
success
boolean
Optional
message
string
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete custom object definition
deleteAppCustomObjectDefinition
GET
Get list of custom objects
Custom object entries can fetch using this endpoint.
Parameters
definitionId
string
Optional
This is definition id
pageNo
string
This is the page number
pageSize
string
This is the page size
Response
200
400
500
Success. Returns a list of custom objects. Refer `CustomObjectsSchema` for more details.
CustomObjectsSchema
items
array of object (CustomObjectListItemSchema)
Optional
Array of CustomObjectListItemSchema
page
object (Page)
Optional
Page
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
pageNo:
1
pageSize:
10
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get list of custom objects
getAppCustomObjects
POST
Create custom object entries
Custom object entries against the custom object definition can be added using this API.
Parameters
body
object (CustomObjectRequestSchema)
Custom object data with field entry
CustomObjectRequestSchema
status
string
Optional
definition_id
string
Optional
fields
array of object (CustomObjectEntryFieldSchema)
Optional
Array of CustomObjectEntryFieldSchema
Response
200
400
500
Success. Returns a list of custom objects. Refer `CustomObjectSchema` for more details.
CustomObjectSchema
_id
string
Optional
creator
string
Optional
company_id
string
| integer
Optional
application_id
string
Optional
created_by
string
Optional
updated_by
string
Optional
status
string
Optional
type
string
Optional
display_name
string
Optional
definition_id
string
Optional
fields
array of object (CustomFieldSchema)
Optional
Array of CustomFieldSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Example response not available.
Create custom object entries
createAppCustomObject
GET
Get custom object details
Details of custom objects, their field details, definitions, and references can be obtained using this endpoint.
Parameters
metaobjectId
string
This is meta object id
Response
200
400
500
Success. Returns a custom object. Refer `CustomObjectByIdSchema` for more details.
CustomObjectByIdSchema
_id
string
Optional
status
string
Optional
display_name
string
Optional
definition
object (CustomObjectListItemDefinationSchema)
Optional
CustomObjectListItemDefinationSchema
references
array of object
Optional
fields
array of object (CustomObjectFieldSchema)
Optional
Array of CustomObjectFieldSchema
Examples
Parameters
metaobjectId:
"65392bd912376081aafa90ff"
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get custom object details
getAppCustomObject
DEL
Delete custom object
Custom object entries can be deleted by providing the delete ID using this endpoint.
Parameters
metaobjectId
string
This is meta object id
Response
200
400
500
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
Optional
message
string
Optional
Examples
Parameters
metaobjectId:
"65392bd912376081aafa90ff"
Was this section helpful?
DEL
Loading...
Response
Example response not available.
Delete custom object
deleteAppCustomObject
PUT
Update custom object details
Custom object entries can be updated using this endpoint.
Parameters
metaobjectId
string
This is meta object id
body
object (CustomObjectRequestSchema)
Custom object definition data
CustomObjectRequestSchema
status
string
Optional
definition_id
string
Optional
fields
array of object (CustomObjectEntryFieldSchema)
Optional
Array of CustomObjectEntryFieldSchema
Response
200
400
500
Custom field definition created.
CustomObjectByIdSchema
_id
string
Optional
status
string
Optional
display_name
string
Optional
definition
object (CustomObjectListItemDefinationSchema)
Optional
CustomObjectListItemDefinationSchema
references
array of object
Optional
fields
array of object (CustomObjectFieldSchema)
Optional
Array of CustomObjectFieldSchema
Examples
Parameters
metaobjectId:
"65392bd912376081aafa90ff"
Was this section helpful?
PUT
Loading...
Response
Loading...
Update custom object details
updateAppCustomObject
GET
Get bulk import and export job list
Custom object bulk import and export jobs status and details can be obtained using this endpoint.
Parameters
page
string
This is the page number
pageSize
string
This is the page size
actionType
string
This is the action type
Response
200
400
500
Success. Returns all bulk entries history.
CustomObjectBulkEntry
items
array of object (CustomObjectJobSchema)
Optional
Array of CustomObjectJobSchema
page
object (Page)
Optional
Page
Examples
Parameters
page:
1
pageSize:
10
actionType:
"upload"
Was this section helpful?
GET
Loading...
Response
Loading...
Get bulk import and export job list
getAppJobs
POST
Bulk custom object entries upload
Custom object bulk import of bulk entries can be performed using this endpoint.
Parameters
definitionId
string
This is definition id
body
object (CustomObjectBulkSchema)
Custom Object bulk entires url and total counts.
CustomObjectBulkSchema
url
string
Optional
total_records
integer
Optional
Response
200
400
500
Success. Returns confirmation that the upload has started
CustomObjectEntryBulkUploadResponse
url
string
Optional
total_records
integer
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Bulk custom object entries upload
importAppCustomObjectEntries
GET
Initiate download for bulk custom object entries
Custom object bulk export of bulk entries can be perform using this endpoint.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Success. Initiates bulk entries download
CustomObjectBulkEntryInitiateDownload
message
string
Optional
task_id
string
Optional
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Loading...
Initiate download for bulk custom object entries
exportAppCustomObjectEntries
GET
Download sample for custom object bulk entry
Sample files for custom object bulk import can be obtained from this endpoint.
Parameters
definitionId
string
This is definition id
Response
200
400
500
Success. Get headers of custom object definition
Examples
Parameters
definitionId:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Loading...
Download sample for custom object bulk entry
sampleAppCustomObjectBulkEntry
Custom Page
Custom pages allow Sellers to create unique web pages tailored to specific purposes or content needs within. These pages can include essential elements such as an About Us section detailing the store's background and mission, a Contact Us page facilitating communication with customers, and additional pages tailored to promotional campaigns or product launches. Through custom pages, Sellers can enhance the user experience, provide valuable information, and strengthen their brand presence. This 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
GET
Get page meta
Use this API to Get metadata for a specific page.
Parameters
No Parameters
Response
200
4XX
5XX
Success. Refer `PageMetaSchema` for more details.
PageMetaSchema
system_pages
array of object (NavigationSchema)
Optional
Array of NavigationSchema
custom_pages
array of object (PageSchema)
Optional
Array of PageSchema
application_id
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get page meta
getPageMeta
GET
Get page specification
Use this API to Get specifications and details for a specific page
Parameters
No Parameters
Response
200
4XX
5XX
Success. Refer `PageSpec` for more details.
PageSpec
specifications
array of object (PageSpecItem)
Optional
Array of PageSpecItem
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get page specification
getPageSpec
POST
Create page preview
Generate and add a new page preview.
Parameters
body
object (PageRequest)
Refer `PageRequest` for more details.
PageRequest
_schedule
object (CronSchedule)
Optional
CronSchedule
application
string
Optional
author
object (Author)
Optional
Author
_custom_json
object
Optional
orientation
string
Optional
content
array of object
Optional
feature_image
object (Asset)
Optional
Asset
published
boolean
Optional
reading_time
string
Optional
slug
string
Optional
tags
array of string
Optional
seo
object (SEO)
Optional
SEO
title
string
Optional
Response
200
4XX
5XX
Success. Refer `PageSchema` for more details.
PageSchema
_id
string
Optional
application
string
Optional
component_ids
array of string
Optional
Components can be used to store multiple components
content
array of object
Optional
content_path
string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
description
string
Optional
feature_image
object (Asset)
Optional
Asset
page_meta
array of object
Optional
_schedule
object (ScheduleSchema)
Optional
ScheduleSchema
_custom_json
object
Optional
orientation
string
Optional
platform
string
Optional
published
boolean
Optional
slug
string
Optional
tags
array of string
Optional
title
string
Optional
type
string
Optional
seo
object (SEO)
Optional
SEO
visibility
object
Optional
archived
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Create page preview
createPagePreview
PUT
Update page preview
Modify the content and settings of a specific page preview.
Parameters
slug
string
A short, human-readable, URL-friendly identifier of a page. You can get slug value of a page from `getPages` API.
body
object (PagePublishRequest)
Pass a boolean value for a key named `publish` in the request body.
PagePublishRequest
publish
boolean
Optional
Response
200
4XX
5XX
Success.
PageSchema
_id
string
Optional
application
string
Optional
component_ids
array of string
Optional
Components can be used to store multiple components
content
array of object
Optional
content_path
string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
description
string
Optional
feature_image
object (Asset)
Optional
Asset
page_meta
array of object
Optional
_schedule
object (ScheduleSchema)
Optional
ScheduleSchema
_custom_json
object
Optional
orientation
string
Optional
platform
string
Optional
published
boolean
Optional
slug
string
Optional
tags
array of string
Optional
title
string
Optional
type
string
Optional
seo
object (SEO)
Optional
SEO
visibility
object
Optional
archived
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Example response not available.
Update page preview
updatePagePreview
DEL
Delete page
Remove a page from the platform.
Parameters
id
string
ID allotted to the page.
Response
200
4XX
5XX
Success.
PageSchema
_id
string
Optional
application
string
Optional
component_ids
array of string
Optional
Components can be used to store multiple components
content
array of object
Optional
content_path
string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
description
string
Optional
feature_image
object (Asset)
Optional
Asset
page_meta
array of object
Optional
_schedule
object (ScheduleSchema)
Optional
ScheduleSchema
_custom_json
object
Optional
orientation
string
Optional
platform
string
Optional
published
boolean
Optional
slug
string
Optional
tags
array of string
Optional
title
string
Optional
type
string
Optional
seo
object (SEO)
Optional
SEO
visibility
object
Optional
archived
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Loading...
Response
Example response not available.
Delete page
deletePage
POST
Create page
Generate and add a new page to the platform.
Parameters
body
object (PageRequest)
Refer `PageRequest` for more details.
PageRequest
_schedule
object (CronSchedule)
Optional
CronSchedule
application
string
Optional
author
object (Author)
Optional
Author
_custom_json
object
Optional
orientation
string
Optional
content
array of object
Optional
feature_image
object (Asset)
Optional
Asset
published
boolean
Optional
reading_time
string
Optional
slug
string
Optional
tags
array of string
Optional
seo
object (SEO)
Optional
SEO
title
string
Optional
Response
200
4XX
5XX
Success. Refer `PageSchema` for more details.
PageSchema
_id
string
Optional
application
string
Optional
component_ids
array of string
Optional
Components can be used to store multiple components
content
array of object
Optional
content_path
string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
description
string
Optional
feature_image
object (Asset)
Optional
Asset
page_meta
array of object
Optional
_schedule
object (ScheduleSchema)
Optional
ScheduleSchema
_custom_json
object
Optional
orientation
string
Optional
platform
string
Optional
published
boolean
Optional
slug
string
Optional
tags
array of string
Optional
title
string
Optional
type
string
Optional
seo
object (SEO)
Optional
SEO
visibility
object
Optional
archived
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Create page
createPage
GET
Get pages
Retrieve a list of available pages.
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
Response
200
4XX
5XX
Success. Refer `PageGetResponse` for more details.
PageGetResponse
items
array of object (PageSchema)
Optional
Array of PageSchema
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get pages
getPages
PUT
Update page
Modify and update the content of a page.
Parameters
id
string
ID allotted to the page.
body
object (PageSchema)
Refer `PageSchema` for more details.
PageSchema
_id
string
Optional
application
string
Optional
component_ids
array of string
Optional
Components can be used to store multiple components
content
array of object
Optional
content_path
string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
description
string
Optional
feature_image
object (Asset)
Optional
Asset
page_meta
array of object
Optional
_schedule
object (ScheduleSchema)
Optional
ScheduleSchema
_custom_json
object
Optional
orientation
string
Optional
platform
string
Optional
published
boolean
Optional
slug
string
Optional
tags
array of string
Optional
title
string
Optional
type
string
Optional
seo
object (SEO)
Optional
SEO
visibility
object
Optional
archived
boolean
Optional
Response
200
4XX
5XX
Success. Refer `PageSchema` for more details.
PageSchema
_id
string
Optional
application
string
Optional
component_ids
array of string
Optional
Components can be used to store multiple components
content
array of object
Optional
content_path
string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
description
string
Optional
feature_image
object (Asset)
Optional
Asset
page_meta
array of object
Optional
_schedule
object (ScheduleSchema)
Optional
ScheduleSchema
_custom_json
object
Optional
orientation
string
Optional
platform
string
Optional
published
boolean
Optional
slug
string
Optional
tags
array of string
Optional
title
string
Optional
type
string
Optional
seo
object (SEO)
Optional
SEO
visibility
object
Optional
archived
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Example response not available.
Update page
updatePage
GET
Get page by slug
Get detailed information about a specific page using its slug.
Parameters
slug
string
A short, human-readable, URL-friendly identifier of a page. You can get slug value of a page from `getPages` API.
Response
200
4XX
5XX
Success. Returns a JSON object of components. Refer `PageSchema` for more details.
PageSchema
_id
string
Optional
application
string
Optional
component_ids
array of string
Optional
Components can be used to store multiple components
content
array of object
Optional
content_path
string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
description
string
Optional
feature_image
object (Asset)
Optional
Asset
page_meta
array of object
Optional
_schedule
object (ScheduleSchema)
Optional
ScheduleSchema
_custom_json
object
Optional
orientation
string
Optional
platform
string
Optional
published
boolean
Optional
slug
string
Optional
tags
array of string
Optional
title
string
Optional
type
string
Optional
seo
object (SEO)
Optional
SEO
visibility
object
Optional
archived
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get page by slug
getPageBySlug
Customer Support
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
GET
Get support information
Retrieve information related to customer support.
Parameters
No Parameters
Response
200
4XX
5XX
Success. Refer `Support` for more details.
Support
created
boolean
Optional
_id
string
Optional
config_type
string
Optional
application
string
Optional
created_at
string
Optional
updated_at
string
Optional
contact
object (ContactSchema)
Optional
ContactSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get support information
getSupportInformation
POST
Update Customer Support Information
Modify information related to customer support.
Parameters
body
object (Support)
Refer `Support` for more details.
Support
created
boolean
Optional
_id
string
Optional
config_type
string
Optional
application
string
Optional
created_at
string
Optional
updated_at
string
Optional
contact
object (ContactSchema)
Optional
ContactSchema
Response
200
4XX
5XX
Success. Refer `Support` for more details.
Support
created
boolean
Optional
_id
string
Optional
config_type
string
Optional
application
string
Optional
created_at
string
Optional
updated_at
string
Optional
contact
object (ContactSchema)
Optional
ContactSchema
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Update Customer Support Information
updateSupportInformation
Data Loaders
Data loaders are a mechanism through which one can override the FDK(Fynd Platform SDK) method implementation. They are primarily used when you have better-managed data storage or faster data retrieval tools suited for a particular use case, or when you want your requests to not follow the predefined flow pattern provided by the 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
GET
# Get component
POST
# Create data loader
GET
# List data loaders
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
GET
Get component
Retrieve detailed information about a specific component.
Parameters
slug
string
A short, human-readable, URL-friendly identifier of a blog page. You can get slug value of a blog from `getBlogs` API.
Response
200
4XX
5XX
Success. Returns a a JSON object with components. Refer `BlogSchema` for more details.
BlogSchema
_id
string
Optional
_custom_json
object
Optional
application
string
Optional
archived
boolean
Optional
author
object (Author)
Optional
Author
content
array of object (ResourceContent)
Optional
Array of ResourceContent
feature_image
object (Asset)
Optional
Asset
published
boolean
Optional
reading_time
string
Optional
slug
string
Optional
tags
array of string
Optional
seo
object (SEO)
Optional
SEO
_schedule
object (CronSchedule)
Optional
CronSchedule
title
string
Optional
date_meta
object (DateMeta)
Optional
DateMeta
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get component
getComponentById
POST
Create data loader
Create and add a new data loader.
Parameters
body
object (DataLoaderSchema)
Pass the name, operation Id incluing type (url/function), url and service name in request body. Refer `DataLoaderSchema` for more details.
DataLoaderSchema
name
string
Optional
service
string
Optional
operation_id
string
Optional
type
string
Optional
Enum
url
string
Optional
content
string
Optional
__source
object (DataLoaderSourceSchema)
Optional
DataLoaderSourceSchema
_id
string
Optional
Response
200
4XX
5XX
Success.
DataLoaderResponseSchema
application
string
Optional
company
string
Optional
_id
string
Optional
name
string
Optional
service
string
Optional
operation_id
string
Optional
type
string
Optional
Enum
url
string
Optional
content
string
Optional
__source
object (DataLoaderSourceSchema)
Optional
DataLoaderSourceSchema
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create data loader
addDataLoader
GET
List data loaders
List all Dataloaders
Parameters
No Parameters
Response
200
4XX
5XX
Success. Refer `DataLoadersSchema` for more details.
DataLoadersSchema
items
array of object (DataLoaderSchema)
Optional
Array of DataLoaderSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List data loaders
getDataLoaders
DEL
Delete a data loader
Remove a specific data loader.
Parameters
dataLoaderId
string
ID allotted to the data loader.
Response
200
4XX
5XX
Success.
DataLoaderResponseSchema
application
string
Optional
company
string
Optional
_id
string
Optional
name
string
Optional
service
string
Optional
operation_id
string
Optional
type
string
Optional
Enum
url
string
Optional
content
string
Optional
__source
object (DataLoaderSourceSchema)
Optional
DataLoaderSourceSchema
Examples
Parameters
dataLoaderId:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete a data loader
deleteDataLoader
PUT
Update a data loader
Modify the settings of a specific data loader.
Parameters
dataLoaderId
string
ID allotted to the data loader.
body
object (DataLoaderSchema)
Data Loader. Refer `DataLoaderSchema` for more details.
DataLoaderSchema
name
string
Optional
service
string
Optional
operation_id
string
Optional
type
string
Optional
Enum
url
string
Optional
content
string
Optional
__source
object (DataLoaderSourceSchema)
Optional
DataLoaderSourceSchema
_id
string
Optional
Response
200
4XX
5XX
Success.
DataLoaderResponseSchema
application
string
Optional
company
string
Optional
_id
string
Optional
name
string
Optional
service
string
Optional
operation_id
string
Optional
type
string
Optional
Enum
url
string
Optional
content
string
Optional
__source
object (DataLoaderSourceSchema)
Optional
DataLoaderSourceSchema
Examples
Parameters
dataLoaderId:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update a data loader
editDataLoader
GET
List all data loaders
Use this to get all data loaders of an application by service name
Parameters
serviceName
string
Service name of the data loader..
Response
200
4XX
5XX
Success. Refer `DataLoaderResponseSchema` for more details.
DataLoaderResponseSchema
application
string
Optional
company
string
Optional
_id
string
Optional
name
string
Optional
service
string
Optional
operation_id
string
Optional
type
string
Optional
Enum
url
string
Optional
content
string
Optional
__source
object (DataLoaderSourceSchema)
Optional
DataLoaderSourceSchema
Examples
Parameters
serviceName:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List all data loaders
getDataLoadersByService
PUT
Select a data loader
Choose and set a data loader for use.
Parameters
dataLoaderId
string
ID allotted to the data loader.
Response
200
4XX
5XX
Success.
DataLoaderResponseSchema
application
string
Optional
company
string
Optional
_id
string
Optional
name
string
Optional
service
string
Optional
operation_id
string
Optional
type
string
Optional
Enum
url
string
Optional
content
string
Optional
__source
object (DataLoaderSourceSchema)
Optional
DataLoaderSourceSchema
Examples
Parameters
dataLoaderId:
"value"
Was this section helpful?
PUT
Loading...
Response
Loading...
Select a data loader
selectDataLoader
PUT
Reset a data loader
Clear and reset data loader settings.
Parameters
service
string
Name of service.
operationId
string
Name of operation id of the service.
Response
200
4XX
5XX
Success.
DataLoaderResetResponseSchema
reset
boolean
Optional
Examples
Parameters
service:
"value"
operationId:
"value"
Was this section helpful?
PUT
Loading...
Response
Loading...
Reset a data loader
resetDataLoader
FAQs
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
GET
List FAQ Categories
List all FAQ Categories
Parameters
No Parameters
Response
200
4XX
5XX
Success. Refer `GetFaqCategoriesSchema` for more details.
GetFaqCategoriesSchema
categories
array of object (CategorySchema)
Optional
Array of CategorySchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List FAQ Categories
getFaqCategories
GET
Get FAQ category
Get detailed information about a specific FAQ category
Parameters
idOrSlug
string
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
4XX
5XX
Success. Refer `GetFaqCategoryBySlugSchema` for more details.
GetFaqCategoryBySlugSchema
category
object (FAQCategorySchema)
Optional
FAQCategorySchema
Examples
Parameters
idOrSlug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get FAQ category
getFaqCategoryBySlugOrId
POST
Create FAQ Category
Generate and add a new FAQ category.
Parameters
body
object (CreateFaqCategoryRequestSchema)
Pass the title and slug of the FAQ category in a category object, in the request body. Refer `CreateFaqCategoryRequestSchema` for more details.
CreateFaqCategoryRequestSchema
category
object (CategoryRequestSchema)
Optional
CategoryRequestSchema
Response
200
4XX
5XX
Success.
CreateFaqCategorySchema
category
object (CategorySchema)
Optional
CategorySchema
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create FAQ Category
createFaqCategory
PUT
Update FAQ category
Modify the content and settings of a specific FAQ category.
Parameters
id
string
ID allotted to an FAQ category.
body
object (UpdateFaqCategoryRequestSchema)
Refer `UpdateFaqCategoryRequestSchema` for more details.
UpdateFaqCategoryRequestSchema
category
object (CategorySchema)
Optional
CategorySchema
Response
200
4XX
5XX
Success.
CreateFaqCategorySchema
category
object (CategorySchema)
Optional
CategorySchema
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update FAQ category
updateFaqCategory
DEL
Delete FAQ category
Remove a specific FAQ category.
Parameters
id
string
ID allotted to an FAQ category.
Response
200
4XX
5XX
Success.
FaqSchema
slug
string
Optional
application
string
Optional
_id
string
Optional
question
string
Optional
answer
string
Optional
tags
array of string
Optional
Examples
Parameters
id:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete FAQ category
deleteFaqCategory
GET
List FAQs
Retrieve a list of FAQs within a specific category.
Parameters
idOrSlug
string
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
4XX
5XX
Success. Refer `GetFaqSchema` for more details.
GetFaqSchema
faqs
array of object (FaqSchema)
Optional
Array of FaqSchema
Examples
Parameters
idOrSlug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List FAQs
getFaqsByCategoryIdOrSlug
POST
Create FAQ
Create and add a new FAQ.
Parameters
categoryId
string
ID allotted to an FAQ category.
body
object (CreateFaqSchema)
Pass the question, answer and slug in the request body. Refer `CreateFaqSchema` for more details.
CreateFaqSchema
faq
object (FAQ)
Optional
FAQ
Response
200
4XX
5XX
Success.
CreateFaqResponseSchema
faq
object (FaqSchema)
Optional
FaqSchema
Examples
Parameters
categoryId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create FAQ
addFaq
PUT
Update FAQ
Modify the content and settings of a specific FAQ.
Parameters
categoryId
string
ID allotted to an FAQ category.
faqId
string
ID allotted to an FAQ.
body
object (CreateFaqSchema)
Pass the updated question, answer or slug in the request body. Refer `CreateFaqSchema` for more details.
CreateFaqSchema
faq
object (FAQ)
Optional
FAQ
Response
200
4XX
5XX
Success.
CreateFaqResponseSchema
faq
object (FaqSchema)
Optional
FaqSchema
Examples
Parameters
categoryId:
"value"
faqId:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update FAQ
updateFaq
DEL
Delete FAQ
Remove a specific FAQ.
Parameters
categoryId
string
ID allotted to an FAQ category.
faqId
string
ID allotted to an FAQ.
Response
200
4XX
5XX
Success.
CreateFaqResponseSchema
faq
object (FaqSchema)
Optional
FaqSchema
Examples
Parameters
categoryId:
"value"
faqId:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete FAQ
deleteFaq
GET
Get FAQ or slug
Get detailed information about a specific FAQ
Parameters
idOrSlug
string
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
4XX
5XX
Success. Refer `CreateFaqResponseSchema` for more details.
CreateFaqResponseSchema
faq
object (FaqSchema)
Optional
FaqSchema
Examples
Parameters
idOrSlug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get FAQ or slug
getFaqByIdOrSlug
HTML Tags
Third-party HTML tags encompass external HTML elements sourced from outside the application or website environment, often integrated via Sales Channel Settings or extensions. These tags can include script elements, enabling the integration of external functionalities such as analytics tracking, live chat services, or e-commerce tools. Similarly, style elements may be incorporated to leverage external CSS frameworks or design libraries, enhancing the visual presentation and user experience of the application. 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
# Update HTML tag
GET
# Get all HTML tags
PUT
# Create HTML tag
PUT
# Remove HTML tag
PUT
# Update HTML tag
PUT
Update HTML tag
Modify settings for an injectable tag.
Parameters
body
object (CreateTagRequestSchema)
Pass the updated name, tag type (css/js), url and position of the tag in the request body. Refer `CreateTagRequestSchema` for more details.
CreateTagRequestSchema
tags
array of object (CreateTagSchema)
Optional
Array of CreateTagSchema
Response
200
4XX
5XX
Success.
TagsSchema
application
string
Optional
_id
string
Optional
tags
array of object (TagSchema)
Optional
Array of TagSchema
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update HTML tag
updateInjectableTag
GET
Get all HTML tags
Retrieve a list of injectable tags.
Parameters
all
boolean
Optional
Get all tags irrespective of the creator of tags
Default Value : false
Response
200
4XX
5XX
Success. Refer `TagsSchema` for more details.
TagsSchema
application
string
Optional
_id
string
Optional
tags
array of object (TagSchema)
Optional
Array of TagSchema
Examples
Parameters
all:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get all HTML tags
getInjectableTags
PUT
Create HTML tag
Create and add a new injectable tag.
Parameters
body
object (CreateTagRequestSchema)
Pass the name, tag type (css/js), url and position of the tag in the request body. Refer `CreateTagRequestSchema` for more details.
CreateTagRequestSchema
tags
array of object (CreateTagSchema)
Optional
Array of CreateTagSchema
Response
200
4XX
5XX
Success.
TagsSchema
application
string
Optional
_id
string
Optional
tags
array of object (TagSchema)
Optional
Array of TagSchema
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Create HTML tag
addInjectableTag
PUT
Remove HTML tag
Delete a specific injectable tag.
Parameters
body
object (RemoveHandpickedSchema)
Refer `RemoveHandpickedSchema` for more details.
RemoveHandpickedSchema
tags
array of string
Optional
Response
200
4XX
5XX
Success.
TagDeleteSuccessResponse
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Remove HTML tag
removeInjectableTag
PUT
Update HTML tag
Modify settings for an injectable tag.
Parameters
tagId
string
ID allotted to the tag.
body
object (UpdateHandpickedSchema)
Tag. Refer `UpdateHandpickedSchema` for more details.
UpdateHandpickedSchema
tag
object (HandpickedTagSchema)
Optional
HandpickedTagSchema
Response
200
4XX
5XX
Success.
TagsSchema
application
string
Optional
_id
string
Optional
tags
array of object (TagSchema)
Optional
Array of TagSchema
Examples
Parameters
tagId:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update HTML tag
editInjectableTag
Landing Page
The landing Page Selection module extends versatility by enabling sellers to designate specific landing pages as the home page for different types of devices and platforms, including websites, Android, and iOS. This functionality offers unprecedented customization, allowing sellers to tailor the browsing experience based on the preferences and behaviours of their audience across various devices. By selecting dedicated landing pages optimized for each platform, sellers can ensure consistency in branding and messaging while maximizing engagement and conversions. Whether visitors are accessing the site from a desktop browser, Android device, or iOS device, Fynd Platform's Landing Page Selection empowers sellers to deliver a seamless and tailored experience that resonates with their audience, ultimately driving success in their e-commerce endeavours.
Operations
GET
# Get landing pages
POST
# Create landing page
PUT
# Update landing page
DEL
# Delete landing page
GET
Get landing pages
Lists a list landing pages as per device types
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
Response
200
4XX
5XX
Success. Refer `LandingPageGetResponse` for more details.
LandingPageGetResponse
items
array of object (LandingPageSchema)
Optional
Array of LandingPageSchema
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get landing pages
getLandingPages
POST
Create landing page
Generate and add a new landing page.
Parameters
body
object (LandingPageSchema)
Refer `LandingPageSchema` for more details.
LandingPageSchema
slug
string
Optional
action
object (Action)
Optional
Action
platform
array of string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
_id
string
Optional
application
string
Optional
archived
boolean
Optional
_custom_json
object
Optional
Response
200
4XX
5XX
Success.
LandingPageSchema
slug
string
Optional
action
object (Action)
Optional
Action
platform
array of string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
_id
string
Optional
application
string
Optional
archived
boolean
Optional
_custom_json
object
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Create landing page
createLandingPage
PUT
Update landing page
Modify the content and settings of a specific landing page.
Parameters
id
string
ID allotted to a landing page.
body
object (LandingPageSchema)
Refer `LandingPageSchema` for more details.
LandingPageSchema
slug
string
Optional
action
object (Action)
Optional
Action
platform
array of string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
_id
string
Optional
application
string
Optional
archived
boolean
Optional
_custom_json
object
Optional
Response
200
4XX
5XX
Success.
LandingPageSchema
slug
string
Optional
action
object (Action)
Optional
Action
platform
array of string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
_id
string
Optional
application
string
Optional
archived
boolean
Optional
_custom_json
object
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Example response not available.
Update landing page
updateLandingPage
DEL
Delete landing page
Remove a specific landing page.
Parameters
id
string
ID allotted to a landing page.
Response
200
4XX
5XX
Success.
LandingPageSchema
slug
string
Optional
action
object (Action)
Optional
Action
platform
array of string
Optional
created_by
object (CreatedBySchema)
Optional
CreatedBySchema
date_meta
object (DateMeta)
Optional
DateMeta
_id
string
Optional
application
string
Optional
archived
boolean
Optional
_custom_json
object
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete landing page
deleteLandingPage
Legal Page
Legal pages encompass essential documents required for e-commerce businesses to comply with legal regulations and establish transparent policies. These pages include a Privacy Policy detailing data handling practices, Terms & Conditions of Service outlining user responsibilities and transaction terms, Return Policy specifying refund procedures, and Shipping Policy detailing shipping terms and conditions. These documents help build trust with customers, mitigate legal risks, and ensure compliance with relevant laws and regulations, ultimately contributing to a positive shopping experience and legal protection for the business. Using this resource, you can retrieve all such information that has been set up on the platform to display it over websites and mobile applications.
Operations
GET
# Get Legal Pages
POST
# Update Legal Pages
GET
Get Legal Pages
Get legal information and terms
Parameters
No Parameters
Response
200
4XX
5XX
Success. Refer `ApplicationLegal` for more details.
ApplicationLegal
application
string
Optional
tnc
string
Optional
policy
string
Optional
shipping
string
Optional
returns
string
Optional
faq
array of object (ApplicationLegalFAQ)
Optional
Array of ApplicationLegalFAQ
_id
string
Optional
updated_at
string
| date-time
Optional
created_at
string
| date-time
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get Legal Pages
getLegalInformation
POST
Update Legal Pages
Modify legal information and terms.
Parameters
body
object (ApplicationLegal)
Pass the updated tnc, policy, shipping and faq information in the request body. Refer `ApplicationLegal` for more details.
ApplicationLegal
application
string
Optional
tnc
string
Optional
policy
string
Optional
shipping
string
Optional
returns
string
Optional
faq
array of object (ApplicationLegalFAQ)
Optional
Array of ApplicationLegalFAQ
_id
string
Optional
updated_at
string
| date-time
Optional
created_at
string
| date-time
Optional
Response
200
4XX
5XX
Success. Refer `ApplicationLegal` for more details.
ApplicationLegal
application
string
Optional
tnc
string
Optional
policy
string
Optional
shipping
string
Optional
returns
string
Optional
faq
array of object (ApplicationLegalFAQ)
Optional
Array of ApplicationLegalFAQ
_id
string
Optional
updated_at
string
| date-time
Optional
created_at
string
| date-time
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update Legal Pages
updateLegalInformation
Path Redirection Rules
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
POST
Create path redirection rules
Create and add rules for path redirection.
Parameters
body
object (PathMappingSchema)
Pass new redirection rules object. Refer `PathMappingSchema` for more details.
PathMappingSchema
application
string
Optional
_id
string
Optional
redirect_from
string
Optional
redirect_to
string
Optional
updated_at
string
| date-time
Optional
created_at
string
| date-time
Optional
__source
object (PathSourceSchema)
Optional
PathSourceSchema
Response
200
4XX
5XX
Success. Refer `PathMappingSchema` for more details.
PathMappingSchema
application
string
Optional
_id
string
Optional
redirect_from
string
Optional
redirect_to
string
Optional
updated_at
string
| date-time
Optional
created_at
string
| date-time
Optional
__source
object (PathSourceSchema)
Optional
PathSourceSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Example response not available.
Create path redirection rules
addPathRedirectionRules
GET
List Path Redirection Rules
Use this API to List Path Redirection Rules
Parameters
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 5.
Default Value : 5
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
Response
200
4XX
5XX
Success. Refer `PathMappingSchema` for more details.
PathMappingSchema
application
string
Optional
_id
string
Optional
redirect_from
string
Optional
redirect_to
string
Optional
updated_at
string
| date-time
Optional
created_at
string
| date-time
Optional
__source
object (PathSourceSchema)
Optional
PathSourceSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
List Path Redirection Rules
getPathRedirectionRules
GET
Get Path Redirection Rule
Use this API to Get detailed information about a specific path redirection rule
Parameters
pathId
string
ID allotted to the path redirection rule.
Response
200
4XX
5XX
Success. Refer `PathMappingSchema` for more details.
PathMappingSchema
application
string
Optional
_id
string
Optional
redirect_from
string
Optional
redirect_to
string
Optional
updated_at
string
| date-time
Optional
created_at
string
| date-time
Optional
__source
object (PathSourceSchema)
Optional
PathSourceSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get Path Redirection Rule
getPathRedirectionRule
PUT
Update path redirection rule
Modify settings for path redirection rules.
Parameters
pathId
string
ID allotted to the path redirection rule.
body
object (PathMappingSchema)
Pass updated redirection rules object. Refer `PathMappingSchema` for more details.
PathMappingSchema
application
string
Optional
_id
string
Optional
redirect_from
string
Optional
redirect_to
string
Optional
updated_at
string
| date-time
Optional
created_at
string
| date-time
Optional
__source
object (PathSourceSchema)
Optional
PathSourceSchema
Response
200
4XX
5XX
Success. Refer `PathMappingSchema` for more details.
PathMappingSchema
application
string
Optional
_id
string
Optional
redirect_from
string
Optional
redirect_to
string
Optional
updated_at
string
| date-time
Optional
created_at
string
| date-time
Optional
__source
object (PathSourceSchema)
Optional
PathSourceSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Loading...
Response
Example response not available.
Update path redirection rule
updatePathRedirectionRules
DEL
Delete path redirection rule
Remove specific path redirection rules.
Parameters
pathId
string
ID allotted to the path redirection rule.
Response
200
4XX
5XX
Success.
Examples
Parameters
pathId:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete path redirection rule
deletePathRedirectionRules
Sales Channel SEO
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
# Get SEO Markup Schema
DEL
# Delete SEO Markup Schema
POST
Generate SEO title
Create an SEO-friendly title for content.
Parameters
type
object (GenerationEntityType)
String representing the type of SEO content to be generated. Possible values are: title, description
Enum
body
object (GenerateSEOContent)
Payload to generate SEO title
GenerateSEOContent
text
string
Optional
existing_text
string
Optional
keywords
array of string
Optional
type
string
Optional
Response
200
4XX
5XX
Returns the generated SEO title
GeneratedSEOContent
title
string
Optional
description
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Generate SEO title
generateSEOTitle
GET
Get sales channel SEO
Retrieve configuration settings for SEO.
Parameters
No Parameters
Response
200
4XX
5XX
Success. Refer `SeoComponent` for more details.
SeoComponent
seo
object (SeoSchema)
Optional
SeoSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get sales channel SEO
getSEOConfiguration
POST
Update sales channel SEO information
Modify configuration settings for SEO.
Parameters
body
object (SeoComponent)
Refer `SeoComponent` for more details.
SeoComponent
seo
object (SeoSchema)
Optional
SeoSchema
Response
200
4XX
5XX
Success. Refer `SeoSchema` for more details.
SeoSchema
app
string
Optional
_id
string
Optional
robots_txt
string
Optional
sitemap_enabled
boolean
Optional
additional_sitemap
string
Optional
cannonical_enabled
boolean
Optional
Default Value : false
custom_meta_tags
array of object (CustomMetaTag)
Optional
Array of CustomMetaTag
details
object (Detail)
Optional
Detail
created_at
string
Optional
updated_at
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update sales channel SEO information
updateSEOConfiguration
GET
List default SEO Markup Schemas
Use this API to List default SEO Markup Schemas
Parameters
pageType
string
Optional
The type of page against which schema template was created
Response
200
4XX
5XX
Success. Refer `DefaultSchemaComponent` for more details.
DefaultSchemaComponent
items
array of object (DefaultSEOSchemaMarkupTemplate)
Optional
Array of DefaultSEOSchemaMarkupTemplate
Examples
Parameters
pageType:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List default SEO Markup Schemas
getDefaultSEOMarkupSchema
GET
List default SEO Markup Schemas
Use this API to List default SEO Markup Schemas
Parameters
title
string
Optional
Title of the seo schema.
active
string
Optional
Boolean value for fetching seo schema.
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
Response
200
4XX
5XX
Success. Refer `SeoSchemaComponent` for more details.
SeoSchemaComponent
items
array of object (SEOSchemaMarkupTemplate)
Optional
Array of SEOSchemaMarkupTemplate
page
object (Page)
Optional
Page
Examples
Parameters
title:
"value"
active:
"value"
pageNo:
0
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List default SEO Markup Schemas
getSEOMarkupSchemas
POST
Create SEO Markup Schema
Use this API to Create SEO Markup Schema
Parameters
body
object (SEOSchemaMarkupTemplateRequestBody)
Refer `SEOSchemaMarkupTemplateRequestBody` for more details.
SEOSchemaMarkupTemplateRequestBody
title
string
Optional
page_type
string
Optional
schema
string
| byte
Optional
description
string
Optional
target_json
object
Optional
active
boolean
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
Response
200
4XX
5XX
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
id
string
Optional
title
string
Optional
page_type
string
Optional
schema
string
Optional
description
string
Optional
active
boolean
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
application
string
Optional
target_json
object
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create SEO Markup Schema
createSEOMarkupSchema
GET
Get SEO Markup Schema
Use this API to Get SEO Markup Schema
Parameters
id
string
Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.
Response
200
4XX
5XX
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
id
string
Optional
title
string
Optional
page_type
string
Optional
schema
string
Optional
description
string
Optional
active
boolean
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
application
string
Optional
target_json
object
Optional
Examples
Parameters
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get SEO Markup Schema
getSEOMarkupSchema
PUT
Get SEO Markup Schema
Use this API to Get SEO Markup Schema
Parameters
id
string
Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.
body
object (SEOSchemaMarkupTemplateRequestBody)
Refer `SEOSchemaMarkupTemplateRequestBody` for more details.
SEOSchemaMarkupTemplateRequestBody
title
string
Optional
page_type
string
Optional
schema
string
| byte
Optional
description
string
Optional
target_json
object
Optional
active
boolean
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
Response
200
4XX
5XX
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
id
string
Optional
title
string
Optional
page_type
string
Optional
schema
string
Optional
description
string
Optional
active
boolean
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
application
string
Optional
target_json
object
Optional
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Get SEO Markup Schema
editSEOMarkupSchema
DEL
Delete SEO Markup Schema
Use this API to Delete SEO Markup Schema
Parameters
id
string
Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.
Response
200
400
500
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
id
string
Optional
title
string
Optional
page_type
string
Optional
schema
string
Optional
description
string
Optional
active
boolean
Optional
created_at
string
| date-time
Optional
updated_at
string
| date-time
Optional
application
string
Optional
target_json
object
Optional
Examples
Parameters
id:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete SEO Markup Schema
deleteSEOMarkupSchema
Slideshow
With Slideshow module, users can enhance the visual appeal of their storefronts during idle times. They have the flexibility to display static images or videos, allowing them to showcase their best-selling products, promotions, or brand messaging. Whether it's a captivating product image or an engaging brand video, users can easily upload and manage their content through the Platform panel. This module helps them make a lasting impression on potential customers, even when they're not actively browsing the store.
Operations
GET
# List Slideshows
POST
# Create a slideshow
GET
# Get Slideshow
PUT
# Update a slideshow
DEL
# Delete a slideshow
GET
List Slideshows
Use this API to list all Slideshows
Parameters
devicePlatform
string
Filter slideshows by platform. Acceptable values are: web, android, ios and all
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
Response
200
4XX
5XX
Success. Refer `SlideshowGetResponse` for more details.
SlideshowGetResponse
items
array of object (SlideshowSchema)
Optional
Array of SlideshowSchema
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
List Slideshows
getSlideshows
POST
Create a slideshow
Use this API to create a slideshow.
Parameters
body
object (SlideshowRequest)
Refer `SlideshowRequest` for more details.
SlideshowRequest
slug
string
Optional
platform
string
Optional
configuration
object (ConfigurationSchema)
Optional
ConfigurationSchema
media
object (SlideshowMedia)
Optional
SlideshowMedia
active
boolean
Optional
Response
200
4XX
5XX
Success. Refer `SlideshowSchema` for more details.
SlideshowSchema
_id
string
Optional
slug
string
Optional
date_meta
object (DateMeta)
Optional
DateMeta
application
string
Optional
platform
string
Optional
configuration
object (ConfigurationSchema)
Optional
ConfigurationSchema
media
array of object (SlideshowMedia)
Optional
Array of SlideshowMedia
active
boolean
Optional
archived
boolean
Optional
_custom_json
object
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Create a slideshow
createSlideshow
GET
Get Slideshow
Use this API to get the details of a slideshow by its slug.
Parameters
slug
string
A short, human-readable, URL-friendly identifier of a slideshow. You can get slug value of a page from `getSlideshows` API.
devicePlatform
string
Filter slideshows by platform. Acceptable values are: web, android, ios and all
Response
200
4XX
5XX
Success. Refer `SlideshowSchema` for more details.
SlideshowSchema
_id
string
Optional
slug
string
Optional
date_meta
object (DateMeta)
Optional
DateMeta
application
string
Optional
platform
string
Optional
configuration
object (ConfigurationSchema)
Optional
ConfigurationSchema
media
array of object (SlideshowMedia)
Optional
Array of SlideshowMedia
active
boolean
Optional
archived
boolean
Optional
_custom_json
object
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get Slideshow
getSlideshowBySlug
PUT
Update a slideshow
Use this API to Update Slideshow
Parameters
id
string
ID allotted to the slideshow.
body
object (SlideshowRequest)
Refer `SlideshowRequest` for more details.
SlideshowRequest
slug
string
Optional
platform
string
Optional
configuration
object (ConfigurationSchema)
Optional
ConfigurationSchema
media
object (SlideshowMedia)
Optional
SlideshowMedia
active
boolean
Optional
Response
200
4XX
5XX
Success. Refer `SlideshowSchema` for more details.
SlideshowSchema
_id
string
Optional
slug
string
Optional
date_meta
object (DateMeta)
Optional
DateMeta
application
string
Optional
platform
string
Optional
configuration
object (ConfigurationSchema)
Optional
ConfigurationSchema
media
array of object (SlideshowMedia)
Optional
Array of SlideshowMedia
active
boolean
Optional
archived
boolean
Optional
_custom_json
object
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Example response not available.
Update a slideshow
updateSlideshow
DEL
Delete a slideshow
Use this API to delete an existing slideshow.
Parameters
id
string
ID allotted to the slideshow.
Response
200
4XX
5XX
Success.
SlideshowSchema
_id
string
Optional
slug
string
Optional
date_meta
object (DateMeta)
Optional
DateMeta
application
string
Optional
platform
string
Optional
configuration
object (ConfigurationSchema)
Optional
ConfigurationSchema
media
array of object (SlideshowMedia)
Optional
Array of SlideshowMedia
active
boolean
Optional
archived
boolean
Optional
_custom_json
object
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Loading...
Response
Loading...