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.
Custom Fields
Custom fields are a flexible way to attach additional information to a resource (e.g. Product, promotions, etc.). Some examples of data stored using customfields include specifications, size charts, downloadable documents, release dates, images, or part numbers. Custom fields are identified by an owner resource, a namespace, and a key and they store a value along with type information for that context.
Operations
GET
# Get custom field types
GET
# Get resources
GET
# Get custom fields definitions
POST
# Create custom field definition
GET
# Get custom fields definition
PUT
# Update custom field definition
DEL
# Delete custom fields definition
GET
# Get list of custom fields of given resource
GET
# Get list of custom fields of given resource and resource id
PUT
# Create custom field entries for gives resource and resource_id
GET
Get custom field types
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
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
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom field types
getCustomFieldTypes
GET
Get resources
Each custom fields is assosiated with a resource such as product, promotion, coupon, selling location etc, This will gives list of supported resource list.
Parameters
company_id
integer
Required
This is company 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
Was this section helpful?
GET
Loading...
Response
Example not available.
Get resources
getResources
GET
Get custom fields definitions
Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list.
Parameters
company_id
integer
Required
This is company 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
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
getCustomFieldDefinitions
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
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
createCustomFieldDefinition
GET
Get custom fields definition
Custom field definitions can be fetch using definition id.
Parameters
company_id
integer
Required
This is company 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
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Example not available.
Get custom fields definition
getCustomFieldDefinition
PUT
Update custom field definition
Custom fields definition can be update using this api, You can update custom field definition name and description.
Parameters
company_id
integer
Required
This is company 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
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
PUT
Loading...
Response
Example not available.
Update custom field definition
updateCustomFieldDefinition
DEL
Delete custom fields definition
Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id.
Parameters
company_id
integer
Required
This is company 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
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
DEL
Loading...
Response
Example not available.
Delete custom fields definition
deleteCustomFieldDefinition
GET
Get list of custom fields of given resource
Retrieves a list of custom fields attached to a particular resource by using the resource.
Parameters
company_id
integer
Required
This is company 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
resource:
"product"
Was this section helpful?
GET
Loading...
Response
Example not available.
Get list of custom fields of given resource
getCustomFields
GET
Get list of custom fields of given resource and resource id
Retrieves a list of custom fields attached to a particular resource by using the resource and resource id.
Parameters
company_id
integer
Required
This is company 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
resource:
"product"
resource_id:
"64bb987e9a3c4b6c29d676bc"
Was this section helpful?
GET
Loading...
Response
Loading...
Get list of custom fields of given resource and resource id
getCustomFieldsByResourceId
PUT
Create custom field entries for gives resource and resource_id
You can add a custom field using this endpoint to any resource by providing the resource ID.
Parameters
company_id
integer
Required
This is company 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
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
createCustomFieldByResourceId
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
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
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
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create custom object definition
createCustomObjectDefinition
GET
Get custom object definitions
Custom object definition lists can be obtained using this endpoint.
Parameters
company_id
integer
Required
This is company 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
page_no:
1
page_size:
10
search:
"sometext"
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom object definitions
getCustomObjectDefinitions
GET
Get custom object definition
Custom object definitions can be fetched using their definition ID.
Parameters
company_id
integer
Required
This is company id
definition_id
string
Required
This is definition id
Response
200
400
500
Custom object definition details.
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
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Loading...
Get custom object definition
getCustomObjectDefinition
PUT
Update custom object definition
Custom object definitions can be updated using this endpoint. You can update the name and description of the custom object and add more custom field definitions to the existing custom object.
Parameters
company_id
integer
Required
This is company 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
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
PUT
Loading...
Response
Loading...
Update custom object definition
updateCustomObjectDefinition
DEL
delete custom object definition
Custom object definitions can be deleted using this endpoint by providing the definition ID.
Parameters
company_id
integer
Required
This is company id
definition_id
string
Required
This is definition id
Response
200
400
500
Custom object definition details.
CustomObjectDefinitionDeleteResponseSchema
success
boolean
message
string
Examples
Parameters
company_id:
1
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
DEL
Loading...
Response
Loading...
delete custom object definition
deleteCustomObjectDefinition
GET
Get list of custom objects
Custom object entries can fetch using this endpoint.
Parameters
company_id
integer
Required
This is company id
definition_id
string
This is definition id
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
Response
200
400
500
Success. Returns a list of custom objects. Refer `CustomObjectsSchema` for more details.
CustomObjectsSchema
items
array of object (CustomObjectListItemSchema)
Array of CustomObjectListItemSchema
_id
string
definition_id
string
status
string
updated_at
string
| date-time
display_name
string
definition
object (CustomObjectListItemDefinationSchema)
CustomObjectListItemDefinationSchema
_id
string
name
string
type
string
references
integer
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
definition_id:
"65369afad436ae0e54147e86"
page_no:
1
page_size:
10
Was this section helpful?
GET
Loading...
Response
Example not available.
Get list of custom objects
getCustomObjects
POST
Create custom object entries
Custom object entries against the custom object definition can be added using this API.
Parameters
company_id
integer
Required
This is company id
Request body
status
string
definition_id
string
fields
array of object (CustomObjectEntryFieldSchema)
Array of CustomObjectEntryFieldSchema
definition_id
string
value
array of object
anyOf Schema from below
Response
200
400
500
Success. Returns a list of custom objects. Refer `CustomObjectSchema` for more details.
CustomObjectSchema
_id
string
creator
string
company_id
string
| integer
application_id
string
created_by
string
updated_by
string
status
string
type
string
display_name
string
definition_id
string
fields
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
Was this section helpful?
POST
Loading...
Response
Example not available.
Create custom object entries
createCustomObject
GET
Get custom object details
Details of custom objects, their field details, definitions, and references can be obtained using this endpoint.
Parameters
company_id
integer
Required
This is company id
metaobject_id
string
Required
This is meta object id
Response
200
400
500
Success. Returns a custom object. Refer `CustomObjectByIdSchema` for more details.
CustomObjectByIdSchema
_id
string
status
string
display_name
string
definition
object (CustomObjectListItemDefinationSchema)
CustomObjectListItemDefinationSchema
_id
string
name
string
type
string
references
array of object
fields
array of object (CustomObjectFieldSchema)
Array of CustomObjectFieldSchema
_id
string
key
string
value
array of object
anyOf Schema from below
type
string
definition_id
string
Examples
Parameters
company_id:
1
metaobject_id:
"65392bd912376081aafa90ff"
Was this section helpful?
GET
Loading...
Response
Example not available.
Get custom object details
getCustomObject
DEL
Delete custom object
Custom object entries can be deleted by providing the delete ID using this endpoint.
Parameters
company_id
integer
Required
This is company id
metaobject_id
string
Required
This is meta object id
Response
200
400
500
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
message
string
Examples
Parameters
company_id:
1
metaobject_id:
"65392bd912376081aafa90ff"
Was this section helpful?
DEL
Loading...
Response
Example not available.
Delete custom object
deleteCustomObject
PUT
Update custom object details
Custom object entries can be updated using this endpoint.
Parameters
company_id
integer
Required
This is company id
metaobject_id
string
Required
This is meta object id
Request body
status
string
definition_id
string
fields
array of object (CustomObjectEntryFieldSchema)
Array of CustomObjectEntryFieldSchema
definition_id
string
value
array of object
anyOf Schema from below
Response
200
400
500
Custom field definition created.
CustomObjectByIdSchema
_id
string
status
string
display_name
string
definition
object (CustomObjectListItemDefinationSchema)
CustomObjectListItemDefinationSchema
_id
string
name
string
type
string
references
array of object
fields
array of object (CustomObjectFieldSchema)
Array of CustomObjectFieldSchema
_id
string
key
string
value
array of object
anyOf Schema from below
type
string
definition_id
string
Examples
Parameters
company_id:
1
metaobject_id:
"65392bd912376081aafa90ff"
Was this section helpful?
PUT
Loading...
Response
Loading...
Update custom object details
updateCustomObject
POST
Bulk custom object entries upload
Custom object bulk import of bulk entries can be performed using this endpoint.
Parameters
company_id
integer
Required
This is company id
definition_id
string
Required
This is definition id
Request body
url
string
total_records
integer
Response
200
400
500
Success. Returns confirmation that the upload has started
CustomObjectEntryBulkUploadResponse
url
string
total_records
integer
Examples
Parameters
company_id:
1
definition_id:
"65369afad436ae0e54147e86"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Bulk custom object entries upload
importCustomObjectEntries
GET
Initiate download for bulk custom object entries
Custom object bulk export of bulk entries can be perform using this endpoint.
Parameters
company_id
integer
Required
This is company id
definition_id
string
Required
This is definition id
Response
200
400
500
Success. Initiates bulk entries download
CustomObjectBulkEntryInitiateDownload
message
string
task_id
string
Examples
Parameters
company_id:
1
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Loading...
Initiate download for bulk custom object entries
exportCustomObjectEntries
GET
Download sample for custom object bulk entry
Sample files for custom object bulk import can be obtained from this endpoint.
Parameters
company_id
integer
Required
This is company id
definition_id
string
Required
This is definition id
Response
200
400
500
Success. Get headers of custom object definition
Examples
Parameters
company_id:
1
definition_id:
"65369afad436ae0e54147e86"
Was this section helpful?
GET
Loading...
Response
Loading...