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.

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
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/
# Create blog
GET
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/
# List blogs
PUT
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/{id}
# Update a blog
DEL
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/{id}
# Delete a blog
GET
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/blogs/{slug}
# 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
Success. Refer `BlogSchema` for more details.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
| date-time
tags
array of string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
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
POST
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/
Loading...
Response
Loading...
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
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
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.
filters
object (BlogFilters)
BlogFilters
tags
array of string
Examples
Parameters
Parameters are not required.
GET
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/
Loading...
Response
Loading...
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
Success.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
| date-time
tags
array of string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
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
PUT
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/{id}
Loading...
Response
Loading...
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
Success.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
| date-time
tags
array of string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
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.
DEL
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/{id}
Loading...
Response
Loading...
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
Success. Returns a a JSON object with components. Refer `BlogSchema` for more details.
BlogSchema
_id
string
_custom_json
object
application
string
archived
boolean
author
object (Author)
Author
designation
string
id
string
name
string
content
array of object (ResourceContent)
Array of ResourceContent
type
string
value
string
feature_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
published
boolean
reading_time
string
slug
string
publish_date
string
| date-time
tags
array of string
seo
object (SEO)
SEO
description
string
image
object (SEOImage)
SEOImage
url
string
title
string
meta_tags
array of object (SEOMetaItem)
Array of SEOMetaItem
title
string
items
array of object (SEOMetaItems)
Array of SEOMetaItems
key
string
value
string
sitemap
object (SEOSitemap)
SEOSitemap
priority
number
frequency
string
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.
GET
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/blogs/{slug}
Loading...
Response
Loading...

Custom Fields

Custom fields are a flexible way to attach additional information to a resource (e.g. Product, promotions, etc.). Some examples of data stored using 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
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/types
# Get custom field types
GET
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/resources
# Get resources
GET
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/definition
# Get custom fields definitions
GET
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/resource/{resource}/definition
# Get custom fields definitions for a given resource type
POST
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/resource/{resource}/definition
# Create custom field definition for a given resource type
GET
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/resource/{resource}/namespace/{namespace}/definition/{slug}
# Get custom fields definition by resource, slug and namespace
PUT
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/resource/{resource}/namespace/{namespace}/definition/{slug}
# Update custom field definition
DEL
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/resource/{resource}/namespace/{namespace}/definition/{slug}
# Delete custom fields definition
GET
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/resource/{resource}/{resource_slug}
# Get list of custom fields of given resource and resource slug
PUT
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/resource/{resource}/{resource_slug}
# Create custom field entries for gives resource and resource slug
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
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"
GET
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/types
Loading...
Response
Loading...
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
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"
GET
/service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/resources
Loading...
Response
Loading...
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
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.
Examples
Parameters
slugs:
"new-meta-object,single-image"
GET
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/definition
Loading...
Response
Loading...
GET

Get custom fields definitions for a given resource type

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.
Examples
Parameters
slugs:
"new-meta-object,single-image"
GET
/service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/resource/{resource}/definition
Loading...
Response
Loading...
POST

Create custom field definition for a given resource type

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