Content
API for managing languages and translations of Fynd Commerce
Operations
POST
# Create blog
GET
# List blogs
PUT
# Update a blog
DEL
# Delete a blog
GET
# Get blog by slug
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
application
string
_custom_json
object
author
object (Author)
Author
designation
string
id
string
name
string
Name of the author
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
tags
array of string
title
string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
canonical_url
string
summary
string
Response
200
Success. Refer `BlogSchema` for more details.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
Name of the author
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
| date-time
tags
array of string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
title
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
summary
string
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Create blog
createBlog
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_size
integer
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
tags
string
Blogs retrieve based on the list of tags passed.
q
string
Blogs retrieve based on the title or slug passed.
slug
string
Blogs retrieve based on the slug passed.
title
string
Blogs retrieve based on the title passed.
status
string
Blogs retrieve based on the status passed.
Response
200
Success. Refer `BlogGetDetails` for more details.
BlogGetDetails
items
array of object (BlogSchema)
Array of BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
Name of the author
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
| date-time
tags
array of string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
title
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
summary
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
filters
object (BlogFilters)
BlogFilters
tags
array of string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
List blogs
getBlogs
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to the blog.
Request body
application
string
_custom_json
object
author
object (Author)
Author
designation
string
id
string
name
string
Name of the author
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
tags
array of string
title
string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
canonical_url
string
summary
string
Response
200
Success.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
Name of the author
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
| date-time
tags
array of string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
title
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
summary
string
Examples
Parameters
body:
body
Was this section helpful?
PUT
Response
Update a blog
updateBlog
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to the blog.
Response
200
Success.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
Name of the author
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
| date-time
tags
array of string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
title
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
summary
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Response
Delete a blog
deleteBlog
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
slug
string
Required
A short, human-readable, URL-friendly identifier of a blog page. You can get slug value of a blog from `getBlogs` API.
Response
200
Success. Returns a a JSON object with components. Refer `BlogSchema` for more details.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
Name of the author
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
| date-time
tags
array of string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
title
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
summary
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get blog by slug
getBlogBySlug
Custom fields are a flexible way to attach additional information to a resource (e.g. Product, promotions, etc.). Some examples of data stored using customfields include specifications, size charts, downloadable documents, release dates, images, or part numbers. Custom fields are identified by an owner resource, a namespace, and a key and they store a value along with type information for that context.
Operations
GET
# Get custom field types
GET
# Get resources
GET
# Get custom fields definitions
GET
# Get custom fields definitions for a given resource type
POST
# Create custom field definition for a given resource type
GET
# Get custom fields definition by resource, slug and namespace
PUT
# Update custom field definition
DEL
# Delete custom fields definition
GET
# Get list of custom fields of given resource and resource slug
PUT
# Create custom field entries for gives resource and resource slug
Each custom field and custom field definition has a type, which defines the type of information that it can store. The custom field types have built-in validation. This api will give list of supported custom fields types
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Response
200
400
Success. Returns all custom field types.
MetafieldTypesSchema
metafield_types
object (CustomFieldTypeSchema)
CustomFieldTypeSchema
string_single_line
object (StringSingleLine)
StringSingleLine
name
string
Name data type of custom field
list_enabled
boolean
Flag for listing enabled or not
category
string
Category of custom field
type
string
type of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
string_multi_line
object (StringMultiLine)
StringMultiLine
name
string
Name data type of custom field
list_enabled
boolean
Flag for listing enabled or not
category
string
Category of custom field
type
string
type of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
dropdown
object (Dropdown)
Dropdown
name
string
Name data type of custom field
list_enabled
boolean
Flag for listing enabled or not
category
string
Category of custom field
type
string
Category of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
integer
object (Integer)
Integer
name
string
Name data type of custom field
list_enabled
boolean
Flag for listing enabled or not
type
string
type of custom field
category
string
Category of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
float_type
object (FloatType)
FloatType
name
string
Name data type of custom field
list_enabled
boolean
Flag for listing enabled or not
type
string
type of custom field
category
string
Category of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
boolean_type
object (BooleanType)
BooleanType
name
string
Name data type of custom field
category
string
Category of custom field
list_enabled
boolean
Flag for listing enabled or not
type
string
Category of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
date
object (Date)
Date
name
string
Name data type of custom field
list_enabled
boolean
Flag for listing enabled or not
category
string
Category of custom field
type
string
type of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
datetime
object (Datetime)
Datetime
name
string
Name data type of custom field
category
string
Category of custom field
list_enabled
boolean
Flag for listing enabled or not
type
string
type of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
json
object (Json)
Json
name
string
Name data type of custom field
list_enabled
boolean
Flag for listing enabled or not
category
string
Category of custom field
type
string
type of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
file
object (File)
File
name
string
Name data type of custom field
category
string
Category of custom field
list_enabled
boolean
Flag for listing enabled or not
type
string
type of custom field
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
url
object (Url)
Url
name
string
Name data type of custom field
list_enabled
boolean
Flag for listing enabled or not
type
string
type of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
metaobject
object (Metaobject)
Metaobject
name
string
Name of Custom Object
list_enabled
boolean
Whether the field is allowed to have multiple list items
category
string
Category of Custom Object Definition that Custom Object belongs to
type
string
Type of Custom Object Definition
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
product
object (Product)
Product
name
string
Name of Product
list_enabled
boolean
Whether the field is allowed to have multiple list items
category
string
Category of Custom Object Definition that Product is associated with
type
string
Custom Object Definition that Product is associated with
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
html
object (HTML)
HTML
name
string
Name data type of custom field
list_enabled
boolean
Flag for listing enabled or not
type
string
type of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
duration
object (Duration)
Duration
name
string
Name data type of custom field
list_enabled
boolean
Flag for listing enabled or not
type
string
type of custom field
category
string
Category of custom field
supported_validations
array of object (SupportedValidationsSchema)
list of validations available for the field
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
meta
object (SupportedValidationsMetaSchema)
SupportedValidationsMetaSchema
examples
array of object (SupportedValidationsMetaExampleSchema)
Array of SupportedValidationsMetaExampleSchema
name
string
value
string
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
Was this section helpful?
GET
Response
Get custom field types
getAppCustomFieldTypes
Each custom fields is assosiated with a resource such as product, promotion, coupon, selling location etc, This will gives list of supported resource list.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Response
200
400
Success. Returns a JSON object of resources. Refer `ResourcesSchema` for more details.
ResourcesSchema
resources
array of object (ResourceSchema)
Array of ResourceSchema
name
string
Resource name
key
string
Resource key
definitions_count
number
Number of definitions
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
Was this section helpful?
GET
Response
Get resources
getAppResources
Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
resources
string
This is the resource for which we are fetching definitions
types
string
This is the type of the custom fields definitions
search
string
This is the search text to filter custom fields definitions
slugs
string
This is the slug list to filter custom fields definitions, it will come comma separated
namespaces
string
This is the namespace list to filter custom fields definitions, it needs to be comma separated
Response
200
400
Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionsSchema
items
array of object (FieldDefinitionSchema)
list of custom field definitions
Array of FieldDefinitionSchema
id
string
Unique system generated id
resource
string
resource type to which custom field belongs
name
string
name of custom field
namespace
string
Namespace of custom field
slug
string
slug of custom field
description
string
description of custom field definition
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multivalued or not
validations
array of object (FieldValidations)
list of validations applied
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
Undefined Type
anyOf Schema from below
company_id
string
| integer
id of company
required
boolean
whether the custom field is required or not
is_deleted
boolean
whether the custom field is deleted or not
type_name
string
type of type field
invalid_fields_count
integer
count of invalid fields after validation
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
slugs:
"new-meta-object,single-image"
Was this section helpful?
GET
Response
Get custom fields definitions
getAppCustomFieldDefinitions
Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
types
string
This is the type of the custom fields definitions
search
string
This is the search text to filter custom fields definitions
slugs
string
This is the slug list to filter custom fields definitions, it will come comma separated
namespaces
string
This is the namespace list to filter custom fields definitions, it needs to be comma separated
Response
200
400
Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionsSchema
items
array of object (FieldDefinitionSchema)
list of custom field definitions
Array of FieldDefinitionSchema
id
string
Unique system generated id
resource
string
resource type to which custom field belongs
name
string
name of custom field
namespace
string
Namespace of custom field
slug
string
slug of custom field
description
string
description of custom field definition
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multivalued or not
validations
array of object (FieldValidations)
list of validations applied
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
object
anyOf Schema from below
company_id
string
| integer
id of company
required
boolean
whether the custom field is required or not
is_deleted
boolean
whether the custom field is deleted or not
type_name
string
type of type field
invalid_fields_count
integer
count of invalid fields after validation
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
slugs:
"new-meta-object,single-image"
Was this section helpful?
GET
Response
Get custom fields definitions for a given resource type
getAppCustomFieldDefinitionByResource
You can create custom fields definition to any resource so you can extend property of resource.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
Request body
type
string
data type of custom field
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
multi_value
boolean
flag to denote whether custom field is multi valued or not
name
string
name of custom field definition
description
string
description of a custom field definition
validations
array of object (FieldValidations)
validations for a custom field
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
object
anyOf Schema from below
Response
200
400
Custom field definition created.
CustomFieldDefinitionDetailResSchema
resource
string
resource to which custom field is associated
name
string
name of custom field
namespace
string
namespace of custom field
slug
string
slug of custom field
description
string
description regarding custom field
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the customfield is required or not
is_deleted
boolean
is custom field deleted
id
string
Unique system generated id
validations
array of Undefined Type
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create custom field definition for a given resource type
createAppCustomFieldDefinition
Custom field definitions can be retrived from this using its slug, namespace and resource
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom field definition slug
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
namespace
string
Required
This is namespace for a custom field
Response
200
400
Success. Returns a custom field definition. Refer `MetaFieldDefinitionDetailResSchema` for more details.
MetaFieldDefinitionDetailResSchema
resource
string
resource to which meta field is associated
name
string
name of meta field
namespace
string
namespace of meta field
slug
string
slug of meta field
description
string
description regarding meta field
type
string
data type of meta field
multi_value
boolean
flag to denote whether meta field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the field is required or not
is_deleted
boolean
is meta field deleted
id
string
Unique system generated id
validations
array of Undefined Type
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
slug:
"65369afad436ae0e54147e86"
resource:
"product"
Was this section helpful?
GET
Response
Get custom fields definition by resource, slug and namespace
getAppCustomFieldDefinitionBySlug
Custom fields definition can be update using this api, You can update custom field definition name and description.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom field definition slug
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
namespace
string
Required
This is namespace for a custom field
Request body
type
string
data type of custom field
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
multi_value
boolean
flag to denote whether custom field is multi valued or not
name
string
name of custom field definition
description
string
description of a custom field definition
validations
array of object (FieldValidations)
validations for a custom field
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
object
anyOf Schema from below
Response
200
400
Custom field definition updated.
CustomFieldDefinitionDetailResSchema
resource
string
resource to which custom field is associated
name
string
name of custom field
namespace
string
namespace of custom field
slug
string
slug of custom field
description
string
description regarding custom field
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the customfield is required or not
is_deleted
boolean
is custom field deleted
id
string
Unique system generated id
validations
array of object
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
slug:
"65369afad436ae0e54147e86"
resource:
"product"
body:
body
Was this section helpful?
PUT
Response
Update custom field definition
updateAppCustomFieldDefinitionBySlug
Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom field definition slug
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
namespace
string
Required
This is namespace for a custom field
Response
200
400
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
denotes the success of the delete operation
message
string
denotes the message of delete operation
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
slug:
"65369afad436ae0e54147e86"
resource:
"product"
Was this section helpful?
DEL
Response
Delete custom fields definition
deleteAppCustomFieldDefinitionBySlug
Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resource_slug
string
Required
This is the resource slug for which custom fields created
Response
200
400
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Array of CustomFieldSchema
id
string
Unique system generated id
namespace
string
namespace of custom field definition
slug
string
slug of custom field definition
resource
string
the resource for which custom field is being created
value
array of object (CustomFieldValue)
Array of CustomFieldValue
value
Undefined Type
anyOf Schema from below
resource_slug
string
unique identifier of the resource
type
string
data type of custom field
multi_value
boolean
whether custom field is multi valued
company_id
string
| integer
identifer for a company
has_invalid_values
boolean
invalid_value_errors
array of Undefined Type
is_deleted
boolean
indicates whether custom field is deleted
created_at
string
| date-time
time at which customer field was created
updated_at
string
| date-time
time at which custom field was updated
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
resource:
"product"
resource_slug:
"64bb987e9a3c4b6c29d676bc"
Was this section helpful?
GET
Response
Get list of custom fields of given resource and resource slug
getAppCustomFieldsByResourceSlug
You can add a custom field using this endpoint to any resource by providing the resource slug.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resource_slug
string
Required
This is the resource slug for which custom fields created
Request body
fields
array of object (CustomField)
Array of CustomField
value
array of object
anyOf Schema from below
namespace
string
This is the namespace to which custom field belongs
slug
string
This is the slug of custom field used while creating a custom field definition
Response
200
400
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Array of CustomFieldSchema
id
string
Unique system generated id
namespace
string
namespace of custom field definition
slug
string
slug of custom field definition
resource
string
the resource for which custom field is being created
value
array of object (CustomFieldValue)
Array of CustomFieldValue
value
object
anyOf Schema from below
resource_slug
string
unique identifier of the resource
type
string
data type of custom field
multi_value
boolean
whether custom field is multi valued
company_id
string
| integer
identifer for a company
has_invalid_values
boolean
invalid_value_errors
array of object
is_deleted
boolean
indicates whether custom field is deleted
created_at
string
| date-time
time at which customer field was created
updated_at
string
| date-time
time at which custom field was updated
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
resource:
"product"
resource_slug:
"64bb987e9a3c4b6c29d676bc"
body:
body
Was this section helpful?
PUT
Response
Create custom field entries for gives resource and resource slug
updateAppCustomFieldByResourceSlug
Custom objects refer to entities that are not currently present on the platform. Sellers can create these custom data structures, allowing them to define the essential custom fields according to their preferences. These custom objects are introduced to address unique data requirements that fall outside the platform's standard features.
Operations
POST
# Create custom object definition
GET
# Get custom object definitions
GET
# Get custom object definition
PUT
# Update custom object definition
DEL
# Delete custom object definition
GET
# Get list of custom objects
POST
# Create custom object entries
GET
# Get custom object details
DEL
# Delete custom object
PUT
# Update custom object details
GET
# Get bulk import and export job list
POST
# Bulk custom object entries upload
GET
# Initiate download for bulk custom object entries
GET
# Download sample for custom object bulk entry
Create a custom object that will have a collection of custom fields and can be used anywhere in the custom field for any resource.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
type
string
Namespace/Slug of Custom object definition
definition_slug
string
Unique slug for a custom object definition
description
string
description of custom object definition
name
string
name of custom object
display_name_key
string
denotes which custom field to be used for displaying custom object
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
list of custom field definitions belonging to this custom object definition
Array of CustomObjectCustomFieldDefinitions
id
string
Unique identifer for a custom field
type
string
data type of custom field
description
string
description of custom field
name
string
name of custom field
multi_value
boolean
flag to denote if cusom field is multi valued or not
required
boolean
whether the field is required or not
slug
string
slug of custom field definition
validations
array of object (FieldValidations)
validations added against the custom field
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
object
anyOf Schema from below
action
string
Response
200
400
Success. Returns the saved custom object defintion
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
definition_slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
resource
string
resource to which custom field is associated
name
string
name of custom field
namespace
string
namespace of custom field
slug
string
slug of custom field
description
string
description regarding custom field
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the customfield is required or not
is_deleted
boolean
is custom field deleted
id
string
Unique system generated id
validations
array of object
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Response
Create custom object definition
createAppCustomObjectDefinition
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
search
string
This is the search text to filter custom fields definitions
Response
200
400
Success. Returns a list custom object definitions.
CustomObjectDefinitionsSchema
items
array of object (CustomObjectEntry)
Array of CustomObjectEntry
id
string
Unique system generated id
name
string
Name of Custom Object definition
type
string
Type of Custom Object Definition
updated_at
string
| date-time
Updation time of a Custom Object
entries_count
integer
Number of entries against the Custom Object definition
fields_count
integer
Number of fields against a Custom Object definition
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
page_no:
1
page_size:
10
search:
"sometext"
Was this section helpful?
GET
Response
Get custom object definitions
getAppCustomObjectDefinitions
Custom object definitions can be fetched using their custom object definition slug.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Response
200
400
Success. It will returns the message for delete successfully.
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
definition_slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
resource
string
resource to which custom field is associated
name
string
name of custom field
namespace
string
namespace of custom field
slug
string
slug of custom field
description
string
description regarding custom field
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the customfield is required or not
is_deleted
boolean
is custom field deleted
id
string
Unique system generated id
validations
array of object
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
slug:
"address-success"
Was this section helpful?
GET
Response
Get custom object definition
getAppCustomObjectDefinitionBySlug
Custom object definitions can be updated using this endpoint. You can update the name and description of the custom object and add more custom field definitions to the existing custom object.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Request body
description
string
description of custom object definiton
name
string
name of custom object definition
display_name_key
string
custom field slug which is used as a display key in
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
Array of CustomObjectCustomFieldDefinitions
id
string
Unique identifer for a custom field
type
string
data type of custom field
description
string
description of custom field
name
string
name of custom field
multi_value
boolean
flag to denote if cusom field is multi valued or not
required
boolean
whether the field is required or not
slug
string
slug of custom field definition
validations
array of object (FieldValidations)
validations added against the custom field
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
object
anyOf Schema from below
action
string
Response
200
400
Custom field definition updated.
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
definition_slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
resource
string
resource to which custom field is associated
name
string
name of custom field
namespace
string
namespace of custom field
slug
string
slug of custom field
description
string
description regarding custom field
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the customfield is required or not
is_deleted
boolean
is custom field deleted
id
string
Unique system generated id
validations
array of object
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
slug:
"address-success"
Was this section helpful?
PUT
Response
Update custom object definition
updateAppCustomObjectDefinitionBySlug
Custom object definitions can be deleted using this endpoint by providing the definition ID.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Response
200
400
Custom object definition details.
CustomObjectDefinitionDeleteResponseSchema
success
boolean
Success status of delete custom object definition.
message
string
Response message when custom object definition is deleted.
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
slug:
"address-success"
Was this section helpful?
DEL
Response
Delete custom object definition
deleteAppCustomObjectDefinitionBySlug
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
definition_slug
string
Required
This is custom object definition slug
Response
200
400
Success. Returns a list of custom objects. Refer `CustomObjectsSchema` for more details.
CustomObjectsSchema
items
array of object (CustomObjectListItemSchema)
list of paginated custom object entries
Array of CustomObjectListItemSchema
id
string
Unique system generated id
status
string
Status of custom object
created_at
string
| date-time
Creation time of custom object document
updated_at
string
| date-time
Updation time of custom object document
display_name
string
Display name of custom object
definition
object (CustomObjectListItemDefinitionModel)
CustomObjectListItemDefinitionModel
id
string
Unique system generated id
name
string
Name of custom object
type
string
Type of custom object entry
references
integer
references of the custom object entry
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
page_no:
1
page_size:
10
definition_slug:
"address-success"
Was this section helpful?
GET
Response
Get list of custom objects
getAppCustomObjectsBySlug
Custom object entries against the custom object definition can be added using this API.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_slug
string
Required
This is custom object definition slug
Request body
status
string
status of the custom object entry.
fields
array of object (CustomObjectEntryFieldSchemaWithoutID)
list of custom fields
Array of CustomObjectEntryFieldSchemaWithoutID
slug
string
custom fields belonging to a custom object
value
object
value of custom field inside a custom object
anyOf Schema from below
Response
200
400
Success. Returns a list of custom objects. Refer `CustomObjectSchema` for more details.
CustomObjectSchema
id
string
Unique system generated id
company_id
string
| integer
Identifer for a company
application_id
string
Identifer for a sales channel
status
string
Status of custom object
type
string
Slug of custom object definition
definition_slug
string
Slug for custom object definition
display_name
string
Value of custom field used for displaying custom object
fields
array of object (CustomFieldSchema)
Fields associated to the custom object
Array of CustomFieldSchema
id
string
Unique system generated id
namespace
string
namespace of custom field definition
slug
string
slug of custom field definition
resource
string
the resource for which custom field is being created
value
array of object (CustomFieldValue)
Array of CustomFieldValue
value
object
anyOf Schema from below
resource_slug
string
unique identifier of the resource
type
string
data type of custom field
multi_value
boolean
whether custom field is multi valued
company_id
string
| integer
identifer for a company
has_invalid_values
boolean
invalid_value_errors
array of object
is_deleted
boolean
indicates whether custom field is deleted
created_at
string
| date-time
time at which customer field was created
updated_at
string
| date-time
time at which custom field was updated
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
definition_slug:
"address-success"
Was this section helpful?
POST
Response
Create custom object entries
createAppCustomObjectBySlug
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_slug
string
Required
This is custom object definition slug
slug
string
Required
This is custom object entry slug
Response
200
400
Success. Returns a custom object. Refer `CustomObjectBySlugSchema` for more details.
CustomObjectBySlugSchema
id
string
Unique system generated identifer for a Custom Object
status
string
status of Custom Object
display_name
string
Display name for the Custom Object
definition
object (CustomObjectListItemDefinitionModel)
CustomObjectListItemDefinitionModel
id
string
Unique system generated id
name
string
Name of custom object
type
string
Type of custom object entry
references
array of Undefined Type
Places where the custom object has been used as a custom field
slug
string
slug of custom object entry
definition_slug
string
slug of custom object definition
fields
array of object (CustomObjectFieldDefinition)
List of custom fields inside the custom object
Array of CustomObjectFieldDefinition
id
string
Unique system generate id
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
value
array of Undefined Type
value of custom field
anyOf Schema from below
type
string
data type of the custom field
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
definition_slug:
"address-success"
slug:
"address-1-success"
Was this section helpful?
GET
Response
Get custom object details
getAppCustomObjectBySlug
A Custom object entry can be deleted by providing the custom object definition slug and custom object entry slug using this endpoint.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_slug
string
Required
This is custom object definition slug
slug
string
Required
This is custom object entry slug
Response
200
400
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
denotes the success of the delete operation
message
string
denotes the message of delete operation
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
definition_slug:
"address-success"
slug:
"address-1-success"
Was this section helpful?
DEL
Response
Delete custom object
deleteAppCustomObjectBySlug
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_slug
string
Required
This is custom object definition slug
slug
string
Required
This is custom object entry slug
Request body
status
string
status of the custom object entry.
fields
array of object (CustomObjectEntryFieldSchemaWithoutID)
list of custom fields
Array of CustomObjectEntryFieldSchemaWithoutID
slug
string
custom fields belonging to a custom object
value
object
value of custom field inside a custom object
anyOf Schema from below
Response
200
400
Custom field definition created.
CustomObjectBySlugSchema
id
string
Unique system generated identifer for a Custom Object
status
string
status of Custom Object
display_name
string
Display name for the Custom Object
definition
object (CustomObjectListItemDefinitionModel)
CustomObjectListItemDefinitionModel
id
string
Unique system generated id
name
string
Name of custom object
type
string
Type of custom object entry
references
array of object
Places where the custom object has been used as a custom field
slug
string
slug of custom object entry
definition_slug
string
slug of custom object definition
fields
array of object (CustomObjectFieldDefinition)
List of custom fields inside the custom object
Array of CustomObjectFieldDefinition
id
string
Unique system generate id
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
value
array of object
value of custom field
anyOf Schema from below
type
string
data type of the custom field
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
definition_slug:
"address-success"
slug:
"address-1-success"
Was this section helpful?
PUT
Response
Update custom object details
updateAppCustomObjectBySlug
Custom object bulk import and export jobs status and details can be obtained using this endpoint.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page
string
Required
This is the page number
page_size
string
Required
This is the page size
action_type
string
Required
This is the action type
Enum
Response
200
400
Success. Returns all bulk entries history.
CustomObjectBulkEntry
items
array of object (JobSchema)
Array of JobSchema
id
string
Unique system generated id
jobs
array of string
list of total jobs
finished_jobs
array of string
list of finished jobs
error_jobs
array of string
list of jobs which resulted in an error
errors_occured
array of string
list of errors occurred in the job
company_id
string
Company Identifer
status
string
status of job
action_type
string
Type of job
Enum
entity
string
Entity against which job is running
error_url
string
URL which contains the file with errors
finished_count
integer
number of items successfully finished
error_count
integer
number of items in error
success_count
integer
number of successful items
total_jobs
integer
total number of jobs
meta
object (CustomObjectMetaSchema)
CustomObjectMetaSchema
mo_total_count
integer
total number of entries in the bulk entry
mo_success_count
integer
number of entries which were successful
mo_error_count
integer
number of entries which were failed
mo_defintion_type
string
type of object
created_by
string
source from where the bulk job is created
created_at
string
| date-time
Date/Time when the job was created
updated_at
string
| date-time
Date/Time when the job was updated
application_id
string
Sales Channel Identifier
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
page:
1
page_size:
10
action_type:
"upload"
Was this section helpful?
GET
Response
Get bulk import and export job list
getAppJobs
Custom object bulk import of bulk entries can be performed using this endpoint.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Request body
url
string
Full URL for the bulk operations data
total_records
integer
Total records in the upload.
Response
200
400
Success. Returns confirmation that the upload has started
CustomObjectEntryBulkUploadDetails
url
string
Signed url of csv
total_records
integer
Total no of records in csv file
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
slug:
"address-success"
body:
body
Was this section helpful?
POST
Response
Bulk custom object entries upload
importAppCustomObjectEntriesBySlug
Custom object bulk export of bulk entries can be perform using this endpoint.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Response
200
400
Success. Initiates bulk entries download
CustomObjectBulkEntryInitiateDownload
message
string
message for the user
task_id
string
Identifer for a task
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
slug:
"address-success"
Was this section helpful?
GET
Response
Initiate download for bulk custom object entries
exportAppCustomObjectEntriesBySlug
Sample files for custom object bulk import can be obtained from this endpoint.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
slug
string
Required
This is custom object definition slug
Response
200
400
Success. Get headers of custom object definition
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
slug:
"address-success"
Was this section helpful?
GET
Response
Download sample for custom object bulk entry
sampleAppCustomObjectBulkEntryBySlug
Operations
GET
# Get page meta
GET
# Get page specification
PUT
# Update page preview
GET
# Get pages
GET
# Get page by slug
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Response
200
Success. Refer `PageMetaSchema` for more details.
PageMetaSchema
system_pages
array of object (NavigationSchema)
Array of NavigationSchema
_id
string
application
string
archived
boolean
name
string
slug
string
platform
array of string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
orientation
object (Orientation)
Orientation
portrait
array of string
landscape
array of string
version
number
navigation
array of object (NavigationReference)
Array of NavigationReference
acl
array of string
tags
array of string
_locale_language
object (LocaleLanguage)
LocaleLanguage
hi
object (Language)
Language
display
string
ar
object (Language)
Language
display
string
en_us
object (Language)
Language
display
string
image
string
type
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
active
boolean
display
string
sort_order
integer
schedule
object (CronBasedScheduleSchema)
CronBasedScheduleSchema
enabled
boolean
cron
string
start
string
| date-time
end
string
| date-time
sub_navigation
array of object (NavigationReference)
Array of NavigationReference
custom_pages
array of object (PageSchema)
Array of PageSchema
_id
string
application
string
component_ids
array of string
Components can be used to store multiple components
content
array of object
content_path
string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
description
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
page_meta
array of object
_schedule
object (ScheduleSchema)
ScheduleSchema
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
_custom_json
object
orientation
string
platform
string
published
boolean
slug
string
tags
array of string
title
string
type
string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
visibility
object
archived
boolean
application_id
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get page meta
getPageMeta
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Response
200
Success. Refer `PageSpec` for more details.
PageSpec
specifications
array of object (PageSpecItem)
Array of PageSpecItem
page_type
string
display_name
string
params
array of object (PageSpecParam)
Array of PageSpecParam
key
string
required
boolean
query
array of object (PageSpecParam)
Array of PageSpecParam
key
string
required
boolean
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get page specification
getPageSpec
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
slug
string
Required
A short, human-readable, URL-friendly identifier of a page. You can get slug value of a page from `getPages` API.
Request body
publish
boolean
Response
200
Success.
PageSchema
_id
string
application
string
component_ids
array of string
Components can be used to store multiple components
content
array of object
content_path
string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
description
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
page_meta
array of object
_schedule
object (ScheduleSchema)
ScheduleSchema
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
_custom_json
object
orientation
string
platform
string
published
boolean
slug
string
tags
array of string
title
string
type
string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
visibility
object
archived
boolean
Examples
Parameters
body:
body
Was this section helpful?
PUT
Response
Update page preview
updatePagePreview
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_size
integer
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
Response
200
Success. Refer `PageGetDetails` for more details.
PageGetDetails
items
array of object (PageSchema)
Array of PageSchema
_id
string
application
string
component_ids
array of string
Components can be used to store multiple components
content
array of object
content_path
string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
description
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
page_meta
array of object
_schedule
object (ScheduleSchema)
ScheduleSchema
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
_custom_json
object
orientation
string
platform
string
published
boolean
slug
string
tags
array of string
title
string
type
string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
visibility
object
archived
boolean
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get pages
getPages
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
slug
string
Required
A short, human-readable, URL-friendly identifier of a page. You can get slug value of a page from `getPages` API.
Response
200
Success. Returns a JSON object of components. Refer `PageSchema` for more details.
PageSchema
_id
string
application
string
component_ids
array of string
Components can be used to store multiple components
content
array of object
content_path
string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
description
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
page_meta
array of object
_schedule
object (ScheduleSchema)
ScheduleSchema
cron
string
start
string
end
string
duration
number
next_schedule
array of object (NextSchedule)
Array of NextSchedule
start
string
end
string
_custom_json
object
orientation
string
platform
string
published
boolean
slug
string
tags
array of string
title
string
type
string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
breadcrumb
array of object (SEObreadcrumb)
Array of SEObreadcrumb
url
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
canonical_url
string
visibility
object
archived
boolean
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get page by slug
getPageBySlug
Operations
GET
# Get support information
POST
# Update Customer Support Information
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Response
200
Success. Refer `Support` for more details.
Support
created
boolean
_id
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
contact
object (ContactSchema)
ContactSchema
phone
object (PhoneSchema)
PhoneSchema
active
boolean
phone
array of object (PhoneProperties)
Array of PhoneProperties
key
string
code
string
number
string
phone_type
string
Enum
email
object (EmailSchema)
EmailSchema
active
boolean
email
array of object (EmailProperties)
Array of EmailProperties
key
string
value
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get support information
getSupportInformation
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
created
boolean
_id
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
contact
object (ContactSchema)
ContactSchema
phone
object (PhoneSchema)
PhoneSchema
active
boolean
phone
array of object (PhoneProperties)
Array of PhoneProperties
key
string
code
string
number
string
phone_type
string
Enum
email
object (EmailSchema)
EmailSchema
active
boolean
email
array of object (EmailProperties)
Array of EmailProperties
key
string
value
string
Response
200
Success. Refer `Support` for more details.
Support
created
boolean
_id
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
contact
object (ContactSchema)
ContactSchema
phone
object (PhoneSchema)
PhoneSchema
active
boolean
phone
array of object (PhoneProperties)
Array of PhoneProperties
key
string
code
string
number
string
phone_type
string
Enum
email
object (EmailSchema)
EmailSchema
active
boolean
email
array of object (EmailProperties)
Array of EmailProperties
key
string
value
string
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Update Customer Support Information
updateSupportInformation
Operations
GET
# List FAQ Categories
GET
# Get FAQ category
POST
# Create FAQ Category
PUT
# Update FAQ category
DEL
# Delete FAQ category
GET
# List FAQs
POST
# Create FAQ
PUT
# Update FAQ
DEL
# Delete FAQ
GET
# Get FAQ or slug
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Response
200
Success. Refer `GetFaqCategoriesSchema` for more details.
GetFaqCategoriesSchema
categories
array of object (CategorySchema)
Array of CategorySchema
index
integer
title
string
description
string
children
array of string
_id
string
slug
string
application
string
icon_url
string
_custom_json
object
Examples
Parameters
company_id:
"value"
application_id:
"value"
Was this section helpful?
GET
Response
List FAQ Categories
getFaqCategories
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id_or_slug
string
Required
ID or the slug allotted to an FAQ category. Slug is a short, human-readable, URL-friendly identifier of an object. You can get slug value of an FAQ category from `getFaqCategories` API.
Response
200
Success. Refer `GetFaqCategoryBySlugSchema` for more details.
GetFaqCategoryBySlugSchema
category
object (FAQCategorySchema)
FAQCategorySchema
index
integer
title
string
description
string
children
array of object (ChildrenSchema)
Array of ChildrenSchema
question
string
answer
string
slug
string
application
string
_id
string
_id
string
slug
string
application
string
icon_url
string
_custom_json
object
Examples
Parameters
company_id:
"value"
application_id:
"value"
id_or_slug:
"value"
Was this section helpful?
GET
Response
Get FAQ category
getFaqCategoryBySlugOrId
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
category
object (CategoryRequestSchema)
CategoryRequestSchema
slug
string
title
string
Response
200
Success.
CreateFaqCategorySchema
category
object (CategorySchema)
CategorySchema
index
integer
title
string
description
string
children
array of string
_id
string
slug
string
application
string
icon_url
string
_custom_json
object
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
POST
Response
Create FAQ Category
createFaqCategory
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to an FAQ category.
Request body
category
object (CategorySchema)
CategorySchema
index
integer
title
string
description
string
children
array of string
_id
string
slug
string
application
string
icon_url
string
_custom_json
object
Response
200
Success.
CreateFaqCategorySchema
category
object (CategorySchema)
CategorySchema
index
integer
title
string
description
string
children
array of string
_id
string
slug
string
application
string
icon_url
string
_custom_json
object
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Was this section helpful?
PUT
Response
Update FAQ category
updateFaqCategory
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to an FAQ category.
Response
200
Success.
FaqSchema
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Was this section helpful?
DEL
Response
Delete FAQ category
deleteFaqCategory
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id_or_slug
string
Required
ID or the slug allotted to an FAQ category. Slug is a short, human-readable, URL-friendly identifier of an object. You can get slug value of an FAQ category from `getFaqCategories` API.
Response
200
Success. Refer `GetFaqSchema` for more details.
GetFaqSchema
faqs
array of object (FaqSchema)
Array of FaqSchema
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
Examples
Parameters
company_id:
"value"
application_id:
"value"
id_or_slug:
"value"
Was this section helpful?
GET
Response
List FAQs
getFaqsByCategoryIdOrSlug
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
category_id
string
Required
ID allotted to an FAQ category.
Request body
faq
object (FAQ)
FAQ
slug
string
question
string
answer
string
Response
200
Success.
CreateFaqResponseSchema
faq
object (FaqSchema)
FaqSchema
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
Examples
Parameters
company_id:
"value"
application_id:
"value"
category_id:
"value"
body:
body
Was this section helpful?
POST
Response
Create FAQ
addFaq
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
category_id
string
Required
ID allotted to an FAQ category.
faq_id
string
Required
ID allotted to an FAQ.
Request body
faq
object (FAQ)
FAQ
slug
string
question
string
answer
string
Response
200
Success.
CreateFaqResponseSchema
faq
object (FaqSchema)
FaqSchema
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
Examples
Parameters
company_id:
"value"
application_id:
"value"
category_id:
"value"
faq_id:
"value"
body:
body
Was this section helpful?
PUT
Response
Update FAQ
updateFaq
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
category_id
string
Required
ID allotted to an FAQ category.
faq_id
string
Required
ID allotted to an FAQ.
Response
200
Success.
CreateFaqResponseSchema
faq
object (FaqSchema)
FaqSchema
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
Examples
Parameters
company_id:
"value"
application_id:
"value"
category_id:
"value"
faq_id:
"value"
Was this section helpful?
DEL
Response
Delete FAQ
deleteFaq
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id_or_slug
string
Required
ID or the slug allotted to an FAQ category. Slug is a short, human-readable, URL-friendly identifier of an object. You can get slug value of an FAQ category from `getFaqCategories` API.
Response
200
Success. Refer `CreateFaqResponseSchema` for more details.
CreateFaqResponseSchema
faq
object (FaqSchema)
FaqSchema
slug
string
application
string
_id
string
question
string
answer
string
tags
array of string
Examples
Parameters
company_id:
"value"
application_id:
"value"
id_or_slug:
"value"
Was this section helpful?
GET
Response
Get FAQ or slug
getFaqByIdOrSlug
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
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
tags
array of object (CreateTagSchema)
A list of tags to be created or updated, each containing details such as name, type, and attributes.
Array of CreateTagSchema
name
string
The name of the tag to be created, used for identification purposes.
sub_type
string
Indicates if the tag is external (linked) or inline (embedded within the page).
Enum
_id
string
The unique identifier for the tag.
type
string
The type of the tag, either JavaScript ('js') or CSS ('css').
Enum
url
string
The external URL pointing to the script or stylesheet resource.
position
string
The position on the webpage where the tag will be injected, such as 'head', 'body-top', or 'body-bottom'.
Enum
attributes
object
Additional attributes for the tag to define its behavior or compatibility.
Supported attributes may vary based on the tag type for example:
- For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
- For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
- For `style` tags: `media`, `type`, `scoped`.
- Custom data attributes like `data-*` can also be added.
compatible_engines
array of string
List of UI frameworks where this third-party tag can be injected or supported.
Enum
pages
array of object
Pages or environments where the tag should be injected or active.
content
string
The inline content for tags of type 'inline' (e.g., JavaScript or CSS code).
Response
200
Success.
TagsSchema
application
string
The ID of the application that owns the tags.
_id
string
The unique identifier for the tag set.
tags
array of object (TagSchema)
A list of tags (HTML resources like scripts or stylesheets) that are configured for the application.
Array of TagSchema
name
string
The name of the tag used to identify it.
url
string
The URL where the external tag resource (such as a script or stylesheet) is located.
type
string
Specifies whether the tag is a JavaScript ('js') or CSS ('css') tag.
Enum
sub_type
string
Indicates whether the tag is an external resource (external) or inline content (inline).
Enum
_id
string
The unique identifier for the tag in the system.
position
string
The position within the page where the tag should be injected.
Enum
attributes
object
Additional attributes for the tag to define its behavior or compatibility.
Supported attributes may vary based on the tag type for example:
- For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
- For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
- For `style` tags: `media`, `type`, `scoped`.
- Custom data attributes like `data-*` can also be added.
content
string
Content of the tag if it is inline, such as JavaScript or CSS code.
compatible_engines
array of string
List of UI frameworks where this third-party tag can be injected or supported.
Enum
pages
array of object
Pages or environments where the tag should be active.
__source
object (TagSourceSchema)
TagSourceSchema
type
string
The type of source, such as 'extension'
id
string
The identifier of the source that created or provided the tag.
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
PUT
Response
Update HTML tag
updateInjectableTag
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
all
boolean
Get all tags irrespective of the creator of tags
Default Value : false
Response
200
Success. Refer `TagsSchema` for more details.
TagsSchema
application
string
The ID of the application that owns the tags.
_id
string
The unique identifier for the tag set.
tags
array of object (TagSchema)
A list of tags (HTML resources like scripts or stylesheets) that are configured for the application.
Array of TagSchema
name
string
The name of the tag used to identify it.
url
string
The URL where the external tag resource (such as a script or stylesheet) is located.
type
string
Specifies whether the tag is a JavaScript ('js') or CSS ('css') tag.
Enum
sub_type
string
Indicates whether the tag is an external resource (external) or inline content (inline).
Enum
_id
string
The unique identifier for the tag in the system.
position
string
The position within the page where the tag should be injected.
Enum
attributes
object
Additional attributes for the tag to define its behavior or compatibility.
Supported attributes may vary based on the tag type for example:
- For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
- For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
- For `style` tags: `media`, `type`, `scoped`.
- Custom data attributes like `data-*` can also be added.
content
string
Content of the tag if it is inline, such as JavaScript or CSS code.
compatible_engines
array of string
List of UI frameworks where this third-party tag can be injected or supported.
Enum
pages
array of object
Pages or environments where the tag should be active.
__source
object (TagSourceSchema)
TagSourceSchema
type
string
The type of source, such as 'extension'
id
string
The identifier of the source that created or provided the tag.
Examples
Parameters
company_id:
"value"
application_id:
"value"
all:
false
Was this section helpful?
GET
Response
Get all HTML tags
getInjectableTags
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
tags
array of object (CreateTagSchema)
A list of tags to be created or updated, each containing details such as name, type, and attributes.
Array of CreateTagSchema
name
string
The name of the tag to be created, used for identification purposes.
sub_type
string
Indicates if the tag is external (linked) or inline (embedded within the page).
Enum
_id
string
The unique identifier for the tag.
type
string
The type of the tag, either JavaScript ('js') or CSS ('css').
Enum
url
string
The external URL pointing to the script or stylesheet resource.
position
string
The position on the webpage where the tag will be injected, such as 'head', 'body-top', or 'body-bottom'.
Enum
attributes
object
Additional attributes for the tag to define its behavior or compatibility.
Supported attributes may vary based on the tag type for example:
- For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
- For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
- For `style` tags: `media`, `type`, `scoped`.
- Custom data attributes like `data-*` can also be added.
compatible_engines
array of string
List of UI frameworks where this third-party tag can be injected or supported.
Enum
pages
array of object
Pages or environments where the tag should be injected or active.
content
string
The inline content for tags of type 'inline' (e.g., JavaScript or CSS code).
Response
200
Success.
TagsSchema
application
string
The ID of the application that owns the tags.
_id
string
The unique identifier for the tag set.
tags
array of object (TagSchema)
A list of tags (HTML resources like scripts or stylesheets) that are configured for the application.
Array of TagSchema
name
string
The name of the tag used to identify it.
url
string
The URL where the external tag resource (such as a script or stylesheet) is located.
type
string
Specifies whether the tag is a JavaScript ('js') or CSS ('css') tag.
Enum
sub_type
string
Indicates whether the tag is an external resource (external) or inline content (inline).
Enum
_id
string
The unique identifier for the tag in the system.
position
string
The position within the page where the tag should be injected.
Enum
attributes
object
Additional attributes for the tag to define its behavior or compatibility.
Supported attributes may vary based on the tag type for example:
- For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
- For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
- For `style` tags: `media`, `type`, `scoped`.
- Custom data attributes like `data-*` can also be added.
content
string
Content of the tag if it is inline, such as JavaScript or CSS code.
compatible_engines
array of string
List of UI frameworks where this third-party tag can be injected or supported.
Enum
pages
array of object
Pages or environments where the tag should be active.
__source
object (TagSourceSchema)
TagSourceSchema
type
string
The type of source, such as 'extension'
id
string
The identifier of the source that created or provided the tag.
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
PUT
Response
Create HTML tag
addInjectableTag
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
tags
array of string
A list of tag IDs to remove from the system.
Response
200
Success.
TagDeleteSuccessDetails
success
boolean
Indicates whether the tag removal operation was successful.
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
PUT
Response
Remove HTML tag
removeInjectableTag
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
tag_id
string
Required
ID allotted to the tag.
Request body
tag
object (HandpickedTagSchema)
HandpickedTagSchema
position
string
The location in the page where the tag should be injected, such as 'head', 'body-top', or 'body-bottom'.
Enum
attributes
object
Additional attributes for the tag to define its behavior or compatibility.
Supported attributes may vary based on the tag type for example:
- For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
- For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
- For `style` tags: `media`, `type`, `scoped`.
- Custom data attributes like `data-*` can also be added.
compatible_engines
array of string
List of UI frameworks where this third-party tag can be injected or supported.
Enum
name
string
The name of the tag used to identify it in the system. Example: 'Google External Script' or 'Bootstrap CSS'.
url
string
The URL where the external tag resource (such as a script or stylesheet) is hosted.
type
string
The type of the tag, such as 'script' (for JavaScript) or 'link' (for CSS).
sub_type
string
Defines whether the tag is embedded within the HTML (inline) or linked externally (external).
Enum
content
string
The actual content of the inline tag, such as JavaScript or CSS code if the tag is inline.
Response
200
Success.
TagsSchema
application
string
The ID of the application that owns the tags.
_id
string
The unique identifier for the tag set.
tags
array of object (TagSchema)
A list of tags (HTML resources like scripts or stylesheets) that are configured for the application.
Array of TagSchema
name
string
The name of the tag used to identify it.
url
string
The URL where the external tag resource (such as a script or stylesheet) is located.
type
string
Specifies whether the tag is a JavaScript ('js') or CSS ('css') tag.
Enum
sub_type
string
Indicates whether the tag is an external resource (external) or inline content (inline).
Enum
_id
string
The unique identifier for the tag in the system.
position
string
The position within the page where the tag should be injected.
Enum
attributes
object
Additional attributes for the tag to define its behavior or compatibility.
Supported attributes may vary based on the tag type for example:
- For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
- For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
- For `style` tags: `media`, `type`, `scoped`.
- Custom data attributes like `data-*` can also be added.
content
string
Content of the tag if it is inline, such as JavaScript or CSS code.
compatible_engines
array of string
List of UI frameworks where this third-party tag can be injected or supported.
Enum
pages
array of object
Pages or environments where the tag should be active.
__source
object (TagSourceSchema)
TagSourceSchema
type
string
The type of source, such as 'extension'
id
string
The identifier of the source that created or provided the tag.
Examples
Parameters
company_id:
"value"
application_id:
"value"
tag_id:
"value"
body:
body
Was this section helpful?
PUT
Response
Update HTML tag
editInjectableTag
The landing Page Selection module extends versatility by enabling sellers to designate specific landing pages as the home page for different types of devices and platforms, including websites, Android, and iOS. This functionality offers unprecedented customization, allowing sellers to tailor the browsing experience based on the preferences and behaviours of their audience across various devices. By selecting dedicated landing pages optimized for each platform, sellers can ensure consistency in branding and messaging while maximizing engagement and conversions. Whether visitors are accessing the site from a desktop browser, Android device, or iOS device, Fynd Platform's Landing Page Selection empowers sellers to deliver a seamless and tailored experience that resonates with their audience, ultimately driving success in their e-commerce endeavours.
Operations
GET
# Get landing pages
POST
# Create landing page
PUT
# Update landing page
DEL
# Delete landing page
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_size
integer
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
Response
200
Success. Refer `LandingPageGetDetails` for more details.
LandingPageGetDetails
items
array of object (LandingPageSchema)
Array of LandingPageSchema
slug
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
platform
array of string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
_id
string
application
string
archived
boolean
_custom_json
object
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get landing pages
getLandingPages
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
slug
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
platform
array of string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
_id
string
application
string
archived
boolean
_custom_json
object
Response
200
Success.
LandingPageSchema
slug
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
platform
array of string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
_id
string
application
string
archived
boolean
_custom_json
object
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Create landing page
createLandingPage
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to a landing page.
Request body
slug
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
platform
array of string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
_id
string
application
string
archived
boolean
_custom_json
object
Response
200
Success.
LandingPageSchema
slug
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
platform
array of string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
_id
string
application
string
archived
boolean
_custom_json
object
Examples
Parameters
body:
body
Was this section helpful?
PUT
Response
Update landing page
updateLandingPage
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to a landing page.
Response
200
Success.
LandingPageSchema
slug
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
platform
array of string
created_by
object (CreatedBySchema)
CreatedBySchema
id
string
date_meta
object (DateMeta)
DateMeta
created_on
string
| date-time
modified_on
string
| date-time
_id
string
application
string
archived
boolean
_custom_json
object
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Response
Delete landing page
deleteLandingPage
Legal pages encompass essential documents required for e-commerce businesses to comply with legal regulations and establish transparent policies. These pages include a Privacy Policy detailing data handling practices, Terms & Conditions of Service outlining user responsibilities and transaction terms, Return Policy specifying refund procedures, and Shipping Policy detailing shipping terms and conditions. These documents help build trust with customers, mitigate legal risks, and ensure compliance with relevant laws and regulations, ultimately contributing to a positive shopping experience and legal protection for the business. Using this resource, you can retrieve all such information that has been set up on the platform to display it over websites and mobile applications.
Operations
GET
# Get Legal Pages
POST
# Update Legal Pages
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Response
200
Success. Refer `ApplicationLegal` for more details.
ApplicationLegal
application
string
tnc
string
policy
string
shipping
string
returns
string
faq
array of object (ApplicationLegalFAQ)
Array of ApplicationLegalFAQ
question
string
answer
string
_id
string
updated_at
string
| date-time
created_at
string
| date-time
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get Legal Pages
getLegalInformation
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
application
string
tnc
string
policy
string
shipping
string
returns
string
faq
array of object (ApplicationLegalFAQ)
Array of ApplicationLegalFAQ
question
string
answer
string
_id
string
updated_at
string
| date-time
created_at
string
| date-time
Response
200
Success. Refer `ApplicationLegal` for more details.
ApplicationLegal
application
string
tnc
string
policy
string
shipping
string
returns
string
faq
array of object (ApplicationLegalFAQ)
Array of ApplicationLegalFAQ
question
string
answer
string
_id
string
updated_at
string
| date-time
created_at
string
| date-time
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
POST
Response
Update Legal Pages
updateLegalInformation
Operations
POST
# Create path redirection rules
GET
# List Path Redirection Rules
GET
# Get Path Redirection Rule
PUT
# Update path redirection rule
DEL
# Delete path redirection rule
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
application
string
_id
string
redirect_from
string
redirect_to
string
updated_at
string
| date-time
created_at
string
| date-time
__source
object (PathSourceSchema)
PathSourceSchema
type
string
id
string
Response
200
Success. Refer `PathMappingSchema` for more details.
PathMappingSchema
application
string
_id
string
redirect_from
string
redirect_to
string
updated_at
string
| date-time
created_at
string
| date-time
__source
object (PathSourceSchema)
PathSourceSchema
type
string
id
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
Create path redirection rules
addPathRedirectionRules
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
page_size
integer
The number of items to retrieve in each page. Default value is 5.
Default Value : 5
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
Response
200
Success. Refer `PathMappingSchema` for more details.
PathMappingSchema
application
string
_id
string
redirect_from
string
redirect_to
string
updated_at
string
| date-time
created_at
string
| date-time
__source
object (PathSourceSchema)
PathSourceSchema
type
string
id
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
List Path Redirection Rules
getPathRedirectionRules
Use this API to Get detailed information about a specific path redirection rule
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
path_id
string
Required
ID allotted to the path redirection rule.
Response
200
Success. Refer `PathMappingSchema` for more details.
PathMappingSchema
application
string
_id
string
redirect_from
string
redirect_to
string
updated_at
string
| date-time
created_at
string
| date-time
__source
object (PathSourceSchema)
PathSourceSchema
type
string
id
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get Path Redirection Rule
getPathRedirectionRule
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
path_id
string
Required
ID allotted to the path redirection rule.
Request body
application
string
_id
string
redirect_from
string
redirect_to
string
updated_at
string
| date-time
created_at
string
| date-time
__source
object (PathSourceSchema)
PathSourceSchema
type
string
id
string
Response
200
Success. Refer `PathMappingSchema` for more details.
PathMappingSchema
application
string
_id
string
redirect_from
string
redirect_to
string
updated_at
string
| date-time
created_at
string
| date-time
__source
object (PathSourceSchema)
PathSourceSchema
type
string
id
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Response
Update path redirection rule
updatePathRedirectionRules
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
path_id
string
Required
ID allotted to the path redirection rule.
Response
200
Success.
Examples
Parameters
company_id:
"value"
application_id:
"value"
path_id:
"value"
Was this section helpful?
DEL
Response
Delete path redirection rule
deletePathRedirectionRules
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
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
type
object (GenerationEntityType)
Required
String representing the type of SEO content to be generated. Possible values are: title, description
Enum
Request body
text
string
existing_text
string
keywords
array of string
type
string
Response
200
Returns the generated SEO title
GeneratedSEOContent
title
string
description
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
Generate SEO title
generateSEOTitle
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Response
200
Success. Refer `SeoComponent` for more details.
SeoComponent
seo
object (SeoSchema)
SeoSchema
app
string
_id
string
robots_txt
string
sitemap_enabled
boolean
additional_sitemap
string
cannonical_enabled
boolean
Default Value : false
custom_meta_tags
array of object (CustomMetaTag)
Array of CustomMetaTag
name
string
content
string
_id
string
details
object (Detail)
Detail
title
string
description
string
image_url
string
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get sales channel SEO
getSEOConfiguration
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
seo
object (SeoSchema)
SeoSchema
app
string
_id
string
robots_txt
string
sitemap_enabled
boolean
additional_sitemap
string
cannonical_enabled
boolean
Default Value : false
custom_meta_tags
array of object (CustomMetaTag)
Array of CustomMetaTag
name
string
content
string
_id
string
details
object (Detail)
Detail
title
string
description
string
image_url
string
created_at
string
| date-time
updated_at
string
| date-time
Response
200
Success. Refer `SeoSchema` for more details.
SeoSchema
app
string
_id
string
robots_txt
string
sitemap_enabled
boolean
additional_sitemap
string
cannonical_enabled
boolean
Default Value : false
custom_meta_tags
array of object (CustomMetaTag)
Array of CustomMetaTag
name
string
content
string
_id
string
details
object (Detail)
Detail
title
string
description
string
image_url
string
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Update sales channel SEO information
updateSEOConfiguration
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
page_type
string
The type of page against which schema template was created
Enum
Response
200
Success. Refer `DefaultSchemaComponent` for more details.
DefaultSchemaComponent
items
array of object (DefaultSEOSchemaMarkupTemplate)
Array of DefaultSEOSchemaMarkupTemplate
page_type
string
Enum
schema
string
target_json
object
Examples
Parameters
company_id:
"value"
application_id:
"value"
page_type:
"value"
Was this section helpful?
GET
Response
List default SEO Markup Schemas
getDefaultSEOMarkupSchema
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
title
string
Title of the seo schema.
active
string
Boolean value for fetching seo schema.
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
Default Value : 1
page_size
integer
The number of items to retrieve in each page. Default value is 10.
Default Value : 10
Response
200
Success. Refer `SeoSchemaComponent` for more details.
SeoSchemaComponent
items
array of object (SEOSchemaMarkupTemplate)
Array of SEOSchemaMarkupTemplate
id
string
title
string
page_type
string
Enum
schema
string
description
string
active
boolean
created_at
string
| date-time
updated_at
string
| date-time
application
string
target_json
object
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
"value"
application_id:
"value"
title:
"value"
active:
"value"
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
List default SEO Markup Schemas
getSEOMarkupSchemas
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Request body
title
string
page_type
string
Enum
schema
string
| byte
description
string
target_json
object
active
boolean
created_at
string
| date-time
updated_at
string
| date-time
Response
200
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
id
string
title
string
page_type
string
Enum
schema
string
description
string
active
boolean
created_at
string
| date-time
updated_at
string
| date-time
application
string
target_json
object
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
POST
Response
Create SEO Markup Schema
createSEOMarkupSchema
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
id
string
Required
Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.
Response
200
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
id
string
title
string
page_type
string
Enum
schema
string
description
string
active
boolean
created_at
string
| date-time
updated_at
string
| date-time
application
string
target_json
object
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Was this section helpful?
GET
Response
Get SEO Markup Schema
getSEOMarkupSchema
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
id
string
Required
Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.
Request body
title
string
page_type
string
Enum
schema
string
| byte
description
string
target_json
object
active
boolean
created_at
string
| date-time
updated_at
string
| date-time
Response
200
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
id
string
title
string
page_type
string
Enum
schema
string
description
string
active
boolean
created_at
string
| date-time
updated_at
string
| date-time
application
string
target_json
object
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Was this section helpful?
PUT
Response
Get SEO Markup Schema
editSEOMarkupSchema
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
id
string
Required
Alphanumeric ID allotted to a SEO Markup Schema Template created within a business.
Response
200
400
Success. Refer `SEOSchemaMarkupTemplate` for more details.
SEOSchemaMarkupTemplate
id
string
title
string
page_type
string
Enum
schema
string
description
string
active
boolean
created_at
string
| date-time
updated_at
string
| date-time
application
string
target_json
object
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Was this section helpful?
DEL
Response