Content
The Content service manages various types of content on the e-commerce platform, including Announcements, Blogs, Legal content, Navigation menus, Custom Pages, Path Redirection Rules, Customer Support information, and Slideshows.
Blog
Blogs serve as a multifaceted tool to engage with their audience, enhance their brand image, and drive sales. Through informative and engaging content, one can attract potential customers, improve their website's search engine rankings, and establish themselves as authorities in their industry. Blogs are utilized for various purposes including content marketing, SEO, product announcements, customer engagement, brand storytelling, educational resources, and promotional activities. By regularly updating their blog with relevant content, one can foster a sense of community, provide value to their audience, and ultimately increase conversions on their store. This resource allows you to edit blog-related information such as its content, appearance, author details, related SEO information, and even schedule it to appear on the website or mobile application.
Operations
POST
# Create blog
GET
# List blogs
PUT
# Update a blog
DEL
# Delete a blog
GET
# Get blog by slug
POST
Create blog
Generate and add a new blog.
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
Request body
application
string
_custom_json
object
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
tags
array of string
title
string
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
4XX
5XX
Success. Refer `BlogSchema` for more details.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
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
modified_on
string
summary
string
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example not available.
Create blog
createBlog
GET
List blogs
List all blogs
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
4XX
5XX
Success. Refer `BlogGetResponse` for more details.
BlogGetResponse
items
array of object (BlogSchema)
Array of BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
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
modified_on
string
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.
filters
object (BlogFilters)
BlogFilters
tags
array of string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example not available.
List blogs
getBlogs
PUT
Update a blog
Modify the content and settings of a specific blog.
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Numeric ID allotted to an application created within a business account.
id
string
Required
ID allotted to the blog.
Request body
application
string
_custom_json
object
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
tags
array of string
title
string
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
4XX
5XX
Success.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
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
modified_on
string
summary
string
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Example not available.
Update a blog
updateBlog
DEL
Delete a blog
Remove a specific blog.
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
4XX
5XX
Success.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
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
modified_on
string
summary
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Loading...
Response
Example not available.
Delete a blog
deleteBlog
GET
Get blog by slug
Retrieve detailed information about a specific blog using its 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.
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
4XX
5XX
Success. Returns a a JSON object with components. Refer `BlogSchema` for more details.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
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
modified_on
string
summary
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example not available.
Get blog by slug
getBlogBySlug
Custom Fields
Custom fields are a flexible way to attach additional information to a resource (e.g. Product, promotions, etc.). Some examples of data stored using customfields include specifications, size charts, downloadable documents, release dates, images, or part numbers. Custom fields are identified by an owner resource, a namespace, and a key and they store a value along with type information for that context.
Operations
GET
# Get custom field types
GET
# Get resources
GET
# Get custom fields definitions
POST
# Create custom field definition
GET
# Get custom fields definition
PUT
# Update custom field definition
DEL
# Delete custom fields definition
GET
# Get list of custom fields of gives resource
GET
# Get list of custom fields of given resource and resource id
PUT
# Create custom field entries for gives resource and resource_id
GET
Get custom field types
Each custom field and custom field definition has a type, which defines the type of information that it can store. The custom field types have built-in validation. This api will give list of supported custom fields types
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Response
200
400
500
Success. Returns all custom field types.
CustomObjectByIdSchema
_id
string
status
string
display_name
string
definition
object (CustomObjectListItemDefinationSchema)
CustomObjectListItemDefinationSchema
_id
string
name
string
type
string
references
array of Undefined Type
fields
array of object (CustomObjectFieldSchema)
Array of CustomObjectFieldSchema
_id
string
key
string
value
array of Undefined Type
anyOf Schema from below
type
string
definition_id
string
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom field types
getAppCustomFieldTypes
GET
Get resources
Each custom fields is assosiated with a resource such as product, promotion, coupon, selling location etc, This will gives list of supported resource list.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Response
200
4XX
5XX
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
Loading...
Response
Example not available.
Get resources
getAppResources
GET
Get custom fields definitions
Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list.
Parameters
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
This is the resource for which we are fetching definitions
type
string
This is the type of the custom fields definitions
search
string
This is the search text to filter custom fields definitions
Response
200
400
500
Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionsSchema
items
array of object (FieldDefinitionSchema)
Array of FieldDefinitionSchema
_id
string
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
value
Undefined Type
anyOf Schema from below
company_id
string
| integer
created_by
string
updated_by
string
required
boolean
is_deleted
boolean
created_at
string
| date-time
updated_at
string
| date-time
type_name
string
invalid_fields_count
integer
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
page_no:
1
page_size:
10
resource:
"product"
type:
"string_single_line"
search:
"sometext"
Was this section helpful?
GET
Loading...
Response
Example not available.
Get custom fields definitions
getAppCustomFieldDefinitions
POST
Create custom field definition
You can create custom fields definition to any resource so you can extend property of resource.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
resource
string
type
string
key
string
namespace
string
multi_value
boolean
name
string
description
string
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
value
object
anyOf Schema from below
Response
200
400
500
Custom field definition created.
CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
| integer
application_id
string
created_by
string
updated_by
string
required
boolean
is_deleted
boolean
_id
string
validations
array of Undefined Type
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Example not available.
Create custom field definition
createAppCustomFieldDefinition
GET
Get custom fields definition
Custom field definitions can be fetch using definition id.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_id
string
Required
This is definition id
Response
200
400
500
Success. Returns a object of custom field definition. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
| integer
application_id
string
created_by
string
updated_by
string
required
boolean
is_deleted
boolean
_id
string
validations
array of object
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Example not available.
Get custom fields definition
getAppCustomFieldDefinition
PUT
Update custom field definition
Custom fields definition can be update using this api, You can update custom field definition name and description.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_id
string
Required
This is definition id
Request body
resource
string
type
string
key
string
namespace
string
multi_value
boolean
name
string
description
string
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
value
object
anyOf Schema from below
Response
200
400
500
Custom field definition created.
CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
| integer
application_id
string
created_by
string
updated_by
string
required
boolean
is_deleted
boolean
_id
string
validations
array of object
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
PUT
Loading...
Response
Example not available.
Update custom field definition
updateAppCustomFieldDefinition
DEL
Delete custom fields definition
Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_id
string
Required
This is definition id
Response
200
400
500
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
message
string
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
DEL
Loading...
Response
Example not available.
Delete custom fields definition
deleteAppCustomFieldDefinition
GET
Get list of custom fields of gives resource
Retrieves a list of custom fields attached to a particular resource by using the resource.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
resource
string
Required
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
Response
200
400
500
Success. Returns a list of custom fields. Refer `CustomFieldsResponseSchema` for more details.
CustomFieldsResponseSchema
items
array of object (CustomFieldSchema)
Array of CustomFieldSchema
_id
string
namespace
string
key
string
resource
string
creator
string
value
array of object (CustomFieldValue)
Array of CustomFieldValue
value
Undefined Type
anyOf Schema from below
resource_id
string
type
string
multi_value
boolean
company_id
string
| integer
definition_id
string
has_invalid_values
boolean
invalid_value_errors
array of Undefined Type
created_by
string
is_deleted
boolean
created_at
string
| date-time
updated_at
string
| date-time
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.
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
resource:
"product"
Was this section helpful?
GET
Loading...
Response
Example not available.
Get list of custom fields of gives resource
getAppCustomFields
GET
Get list of custom fields of given resource and resource id
Retrieves a list of custom fields attached to a particular resource by using the resource and resource id.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
resource
string
Required
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resource_id
string
Required
This is the resource id for which custom fields created
Response
200
400
500
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Array of CustomFieldSchema
_id
string
namespace
string
key
string
resource
string
creator
string
value
array of object (CustomFieldValue)
Array of CustomFieldValue
value
object
anyOf Schema from below
resource_id
string
type
string
multi_value
boolean
company_id
string
| integer
definition_id
string
has_invalid_values
boolean
invalid_value_errors
array of object
created_by
string
is_deleted
boolean
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
resource:
"product"
resource_id:
"64bb987e9a3c4b6c29d676bc"
Was this section helpful?
GET
Loading...
Response
Loading...
Get list of custom fields of given resource and resource id
getAppCustomFieldsByResourceId
PUT
Create custom field entries for gives resource and resource_id
You can add a custom field using this endpoint to any resource by providing the resource ID.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
resource
string
Required
This is the name of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resource_id
string
Required
This is the resource id for which custom fields created
Request body
fields
array of object (CustomField)
Array of CustomField
value
array of object
anyOf Schema from below
definition_id
string
Response
200
400
500
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Array of CustomFieldSchema
_id
string
namespace
string
key
string
resource
string
creator
string
value
array of object (CustomFieldValue)
Array of CustomFieldValue
value
object
anyOf Schema from below
resource_id
string
type
string
multi_value
boolean
company_id
string
| integer
definition_id
string
has_invalid_values
boolean
invalid_value_errors
array of object
created_by
string
is_deleted
boolean
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
resource:
"product"
resource_id:
"64bb987e9a3c4b6c29d676bc"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Create custom field entries for gives resource and resource_id
createAppCustomFieldByResourceId
Custom Objects
Custom objects refer to entities that are not currently present on the platform. Sellers can create these custom data structures, allowing them to define the essential custom fields according to their preferences. These custom objects are introduced to address unique data requirements that fall outside the platform's standard features.
Operations
POST
# Create custom object definition
GET
# Get custom object definitions
GET
# Get custom object definition
PUT
# Update custom object definition
DEL
# Delete custom object definition
GET
# Get list of custom objects
POST
# Create custom object entries
GET
# Get custom object details
DEL
# Delete custom object
PUT
# Update custom object details
GET
# Get bulk import and export job list
POST
# Bulk custom object entries upload
GET
# Initiate download for bulk custom object entries
GET
# Download sample for custom object bulk entry
POST
Create custom object definition
Create a custom object that will have a collection of custom fields and can be used anywhere in the custom field for any resource.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
type
string
description
string
name
string
display_name_key
string
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
Array of CustomObjectCustomFieldDefinitions
id
string
type
string
description
string
name
string
multi_value
boolean
required
boolean
key
string
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
value
object
anyOf Schema from below
action
string
Response
200
400
500
Success. Returns the saved custom object defintion
CustomObjectDefinitionSchema
_id
string
name
string
type
string
display_name_key
string
description
string
creator
string
created_by
string
updated_by
string
field_definitions
array of object (CustomObjectCustomFieldDefinitionResSchema)
Array of CustomObjectCustomFieldDefinitionResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
value
object
anyOf Schema from below
company_id
string
created_by
string
metaobject_definition_id
string
required
boolean
is_deleted
boolean
_id
string
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create custom object definition
createAppCustomObjectDefinition
GET
Get custom object definitions
Custom object definition lists can be obtained using this endpoint.
Parameters
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
500
Success. Returns a list custom object definitions.
CustomObjectDefinitionsSchema
items
array of object (CustomObjectEntry)
Array of CustomObjectEntry
_id
string
name
string
type
string
updated_at
string
| date-time
entries_count
integer
fields_count
integer
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
page_no:
1
page_size:
10
search:
"sometext"
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom object definitions
getAppCustomObjectDefinitions
GET
Get custom object definition
Custom object definitions can be fetched using their definition ID.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_id
string
Required
This is definition id
Response
200
400
500
Success. It will returns the message for delete successfully.
CustomObjectDefinitionSchema
_id
string
name
string
type
string
display_name_key
string
description
string
creator
string
created_by
string
updated_by
string
field_definitions
array of object (CustomObjectCustomFieldDefinitionResSchema)
Array of CustomObjectCustomFieldDefinitionResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
value
object
anyOf Schema from below
company_id
string
created_by
string
metaobject_definition_id
string
required
boolean
is_deleted
boolean
_id
string
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom object definition
getAppCustomObjectDefinition
PUT
Update custom object definition
Custom object definitions can be updated using this endpoint. You can update the name and description of the custom object and add more custom field definitions to the existing custom object.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_id
string
Required
This is definition id
Request body
type
string
description
string
name
string
display_name_key
string
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
Array of CustomObjectCustomFieldDefinitions
id
string
type
string
description
string
name
string
multi_value
boolean
required
boolean
key
string
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
value
object
anyOf Schema from below
action
string
Response
200
400
500
Custom field definition updated.
CustomObjectDefinitionSchema
_id
string
name
string
type
string
display_name_key
string
description
string
creator
string
created_by
string
updated_by
string
field_definitions
array of object (CustomObjectCustomFieldDefinitionResSchema)
Array of CustomObjectCustomFieldDefinitionResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
value
object
anyOf Schema from below
company_id
string
created_by
string
metaobject_definition_id
string
required
boolean
is_deleted
boolean
_id
string
created_at
string
| date-time
updated_at
string
| date-time
Examples
Parameters
company_id:
1
application_id:
"5eda528b97457fe43a733ace"
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
PUT
Loading...
Response
Loading...
Update custom object definition
updateAppCustomObjectDefinition
DEL
Delete custom object definition
Custom object definitions can be deleted using this endpoint by providing the definition ID.
Parameters
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
definition_id
string
Required
This is definition id
Response
200
400
500
Custom object definition details.