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 are a flexible way to attach additional information to a resource (e.g. Product, promotions, etc.). Some examples of data stored using customfields include specifications, size charts, downloadable documents, release dates, images, or part numbers. Custom fields are identified by an owner resource, a namespace, and a key and they store a value along with type information for that context.
Operations
GET
# Get custom field types
GET
# Get resources
GET
# Get custom fields definitions
GET
# Get custom fields definitions for a given resource type
POST
# Create custom field definition for a given resource type
GET
# Get custom fields definition by resource, slug and namespace
PUT
# Update custom field definition
DEL
# Delete custom fields definition
GET
# Get list of custom fields of given resource and resource slug
PUT
# Update custom field entries for gives resource and resource slug
Each custom field and custom field definition has a type, which defines the type of information that it can store. The custom field types have built-in validation. This api will give list of supported custom fields types
Parameters
company_id
integer
Required
This is company id
Response
200
Success. Returns all custom field types.
MetafieldTypesSchema
metafield_types
object (CustomFieldTypeSchema)
CustomFieldTypeSchema
string_single_line
object (StringSingleLine)
StringSingleLine
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
string_multi_line
object (StringMultiLine)
StringMultiLine
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
dropdown
object (Dropdown)
Dropdown
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
integer
object (Integer)
Integer
name
string
list_enabled
boolean
type
string
category
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
float_type
object (FloatType)
FloatType
name
string
list_enabled
boolean
type
string
category
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
boolean_type
object (BooleanType)
BooleanType
name
string
category
string
list_enabled
boolean
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
date
object (Date)
Date
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
datetime
object (Datetime)
Datetime
name
string
category
string
list_enabled
boolean
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
json
object (Json)
Json
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
file
object (File)
File
name
string
category
string
list_enabled
boolean
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
url
object (Url)
Url
name
string
list_enabled
boolean
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
metaobject
object (Metaobject)
Metaobject
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
product
object (Product)
Product
name
string
list_enabled
boolean
category
string
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
scope
array of string
html
object (HTML)
HTML
name
string
list_enabled
boolean
type
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
duration
object (Duration)
Duration
name
string
list_enabled
boolean
type
string
category
string
supported_validations
array of object (SupportedValidationsSchema)
Array of SupportedValidationsSchema
name
string
type
string
display
string
required
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
Was this section helpful?
GET
Response
Use this API to retrieve the resources, such as products, collections, customers, selling locations, etc.
Parameters
company_id
integer
Required
This is company id
Response
200
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
Response
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
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
Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionsSchema
items
array of object (FieldDefinitionSchema)
Array of FieldDefinitionSchema
resource
string
name
string
namespace
string
slug
string
description
string
type
string
multi_value
boolean
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
company_id
string
| integer
required
boolean
is_deleted
boolean
type_name
string
invalid_fields_count
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
page_no:
"1"
page_size:
"10"
resources:
"product"
types:
"string_single_line"
search:
"sometext"
Was this section helpful?
GET
Response
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
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
Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionsSchema
items
array of object (FieldDefinitionSchema)
Array of FieldDefinitionSchema
resource
string
name
string
namespace
string
slug
string
description
string
type
string
multi_value
boolean
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
company_id
string
| integer
required
boolean
is_deleted
boolean
type_name
string
invalid_fields_count
integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
page_no:
"1"
page_size:
"10"
resource:
"product"
types:
"string_single_line"
search:
"sometext"
Was this section helpful?
GET
Response
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
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
Request body
resource
string
type
string
key
string
namespace
string
slug
string
multi_value
boolean
name
string
description
string
creator
string
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
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
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
resource:
"product"
body:
body
Was this section helpful?
POST
Response
Custom field definitions can be retrived from this using its slug, namespace and resource
Parameters
company_id
integer
Required
This is company id
slug
string
Required
This is custom field definition slug
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
namespace
string
Required
This is namespace for a custom field
Response
200
404
Success. Returns a custom field definition. Refer `MetaFieldDefinitionDetailResSchema` for more details.
MetaFieldDefinitionDetailResSchema
resource
string
resource to which meta field is associated
name
string
name of meta field
namespace
string
namespace of meta field
slug
string
slug of meta field
description
string
description regarding meta field
type
string
data type of meta field
multi_value
boolean
flag to denote whether meta field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the field is required or not
is_deleted
boolean
is meta field deleted
id
string
Unique system generated id
validations
array of Undefined Type
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
4072
slug:
"product-name"
resource:
"product"
namespace:
"custom"
Was this section helpful?
GET
Response
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
slug
string
Required
This is custom field definition slug
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
namespace
string
Required
This is namespace for a custom field
Request body
resource
string
type
string
key
string
namespace
string
slug
string
multi_value
boolean
name
string
description
string
creator
string
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Custom field definition updated.
CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
slug:
"inventory-update-field-definition"
resource:
"inventory"
namespace:
"custom"
body:
body
Was this section helpful?
PUT
Response
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
slug
string
Required
This is custom field definition slug
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
namespace
string
Required
This is namespace for a custom field
Response
200
404
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
message
string
Examples
Parameters
company_id:
1
slug:
"inventory-delete-field-definition"
resource:
"inventory"
namespace:
"custom"
Was this section helpful?
DEL
Response
Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug.
Parameters
company_id
integer
Required
This is company id
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resource_slug
string
Required
This is the resource slug for which custom fields created
Response
200
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
resource_id
string
type
string
Enum
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
resource:
"product"
resource_slug:
"64bb987e9a3c4b6c29d676bc"
Was this section helpful?
GET
Response
You can add a custom field using this endpoint to any resource by providing the resource slug.
Parameters
company_id
integer
Required
This is company id
resource
string
Required
This is the type of resource for which you want to fetch custom fields eg. product, collection, customer etc.
resource_slug
string
Required
This is the resource slug for which custom fields created
Request body
fields
array of object
Response
200
400
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Array of CustomFieldSchema
_id
string
namespace
string
key
string
resource
string
creator
string
resource_id
string
type
string
Enum
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
4072
resource:
"product"
resource_slug:
1234567
body:
body
Was this section helpful?
PUT
Response
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 under a certain custom object definition
POST
# Create custom object entries
GET
# Get custom object details
DEL
# Delete custom object
PUT
# Update custom object details
GET
# Get bulk import and export job list
POST
# Bulk custom object entries upload
GET
# Initiate download for bulk custom object entries
GET
# Download sample for custom object bulk entry
Create a custom object that will have a collection of custom fields and can be used anywhere in the custom field for any resource.
Parameters
company_id
integer
Required
This is company id
Request body
type
string
description
string
slug
string
name
string
display_name_key
string
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
Array of CustomObjectCustomFieldDefinitions
_id
string
type
string
Required
Enum
description
string
name
string
multi_value
boolean
required
boolean
key
string
validations
array of object (FieldValidations)
Array of FieldValidations
name
string
type
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
action
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Success. Returns the saved custom object defintion
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
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
Success. Returns a list custom object definitions.
CustomObjectDefinitionsSchema
items
array of object (CustomObjectEntry)
Array of CustomObjectEntry
name
string
type
string
updated_at
string
| date-time
entries_count
integer
fields_count
integer
slug
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.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
page_no:
"1"
page_size:
"10"
search:
"sometext"
Was this section helpful?
GET
Response
Custom object definitions can be fetched using their custom object definition slug.
Parameters
company_id
integer
Required
This is company id
slug
string
Required
This is custom object definition slug
Response
200
404
Success. It will returns the message for delete successfully.
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
slug:
"address"
Was this section helpful?
GET
Response
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
slug
string
Required
This is custom object definition slug
Request body
type
string
description
string
name
string
display_name_key
string
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Array of CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
404
Custom field definition updated.
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
creator
string
resource
string
name
string
namespace
string
key
string
description
string
type
string
multi_value
boolean
company_id
string
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
slug:
"address-company-edit"
body:
body
Was this section helpful?
PUT
Response
Custom object definitions can be deleted using this endpoint by providing the definition ID.
Parameters
company_id
integer
Required
This is company id
slug
string
Required
This is custom object definition slug
Response
200
404
Custom object definition details.
CustomObjectDefinitionDeleteResponseSchema
success
boolean
message
string
Examples
Parameters
company_id:
1
slug:
"address-company-delete"
Was this section helpful?
DEL
Response
Custom object entries can fetch 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
definition_slug
string
Required
This is custom object definition slug
Response
200
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
type
string
status
string
slug
string
updated_at
string
| date-time
display_name
string
definition
object (CustomObjectListItemDefinationSchema)
CustomObjectListItemDefinationSchema
_id
string
name
string
type
string
display_name_key
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.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
page_no:
"1"
page_size:
"10"
Was this section helpful?
GET
Response
Custom object entries against the custom object definition can be added using this API.
Parameters
company_id
integer
Required
This is company id
definition_slug
string
Required
This is custom object definition slug
Request body
slug
string
status
string
status of the custom object entry.
fields
array of object (CustomObjectEntryFieldSchemaWithoutID)
list of custom fields
Array of CustomObjectEntryFieldSchemaWithoutID
slug
string
custom fields belonging to a custom object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Success. Returns a list of custom objects. Refer `CustomObjectSchema` for more details.
CustomObjectSchema
id
string
name
string
creator
string
company_id
string
| integer
created_by
string
updated_by
string
status
string
slug
string
type
string
display_name
string
definition_id
string
is_deleted
boolean
created_at
string
| date-time
updated_at
string
| date-time
fields
array of object (CustomFieldSchema)
Array of CustomFieldSchema
_id
string
namespace
string
key
string
resource
string
creator
string
resource_id
string
type
string
Enum
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
definition_slug:
"address-company"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
This is company id
definition_slug
string
Required
This is custom object definition slug
slug
string
Required
This is custom object entry slug
Response
200
404
Success. Returns a custom object. Refer `CustomObjectBySlugSchema` for more details.
CustomObjectBySlugSchema
id
string
Unique system generated identifer for a Custom Object
status
string
status of Custom Object
display_name
string
Display name for the Custom Object
definition
object (CustomObjectListItemDefinitionModel)
CustomObjectListItemDefinitionModel
id
string
Unique system generated id
name
string
Name of custom object
type
string
Type of custom object entry
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
references
array of Undefined Type
Places where the custom object has been used as a custom field
slug
string
slug of custom object entry
definition_slug
string
slug of custom object definition
fields
array of object (CustomObjectFieldDefinition)
List of custom fields inside the custom object
Array of CustomObjectFieldDefinition
id
string
Unique system generate id
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
type
string
data type of the custom field
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
definition_slug:
"product_warranty_information"
slug:
"6-months-warranty"
Was this section helpful?
GET
Response
Custom object entries can be deleted by providing the delete ID using this endpoint.
Parameters
company_id
integer
Required
This is company id
definition_slug
string
Required
This is custom object definition slug
slug
string
Required
This is custom object entry slug
Response
200
404
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
message
string
Examples
Parameters
company_id:
1
definition_slug:
"product_warranty_information"
slug:
"12-months-warranty"
Was this section helpful?
DEL
Response
Parameters
company_id
integer
Required
This is company id
definition_slug
string
Required
This is custom object definition slug
slug
string
Required
This is custom object entry slug
Request body
slug
string
status
string
status of the custom object entry.
fields
array of object (CustomObjectEntryFieldSchemaWithoutID)
list of custom fields
Array of CustomObjectEntryFieldSchemaWithoutID
slug
string
custom fields belonging to a custom object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
404
Custom field definition created.
CustomObjectBySlugSchema
id
string
Unique system generated identifer for a Custom Object
status
string
status of Custom Object
display_name
string
Display name for the Custom Object
definition
object (CustomObjectListItemDefinitionModel)
CustomObjectListItemDefinitionModel
id
string
Unique system generated id
name
string
Name of custom object
type
string
Type of custom object entry
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
references
array of object
Places where the custom object has been used as a custom field
slug
string
slug of custom object entry
definition_slug
string
slug of custom object definition
fields
array of object (CustomObjectFieldDefinition)
List of custom fields inside the custom object
Array of CustomObjectFieldDefinition
id
string
Unique system generate id
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
type
string
data type of the custom field
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
definition_slug:
"product_warranty_information"
slug:
"lifetime-warranty"
body:
body
Was this section helpful?
PUT
Response
Custom object bulk import and export jobs status and details can be obtained using this endpoint.
Parameters
company_id
integer
Required
This is company id
page_no
string
Required
This is the page number
page_size
string
Required
This is the page size
action_type
string
Required
This is the action type
Enum
Response
200
Success. Returns all bulk entries history.
CustomObjectBulkEntry
items
array of object (JobSchema)
Array of JobSchema
_id
string
jobs
array of string
finished_jobs
array of string
error_jobs
array of string
errors_occured
array of string
company_id
string
creator
string
status
string
action_type
string
Enum
entity
string
error_url
string
finished_count
integer
error_count
integer
success_count
integer
total_jobs
integer
meta
object (CustomObjectMetaSchema)
CustomObjectMetaSchema
mo_total_count
integer
mo_success_count
integer
mo_error_count
integer
mo_defintion_type
string
created_by
string
created_at
string
| date-time
updated_at
string
| date-time
application_id
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
page_no:
"1"
page_size:
"10"
action_type:
"upload"
Was this section helpful?
GET
Response
Custom object bulk import of bulk entries can be performed using this endpoint.
Parameters
company_id
integer
Required
This is company id
slug
string
Required
This is custom object definition slug
Request body
url
string
total_records
integer
Response
200
400
Success. Returns confirmation that the upload has started
CustomObjectEntryBulkUploadDetails
url
string
Signed url of csv
total_records
integer
Total no of records in csv file
message
string
task_id
string
Examples
Parameters
company_id:
1
slug:
"product_warranty_information"
body:
body
Was this section helpful?
POST
Response
Custom object bulk export of bulk entries can be perform using this endpoint.
Parameters
company_id
integer
Required
This is company id
slug
string
Required
This is custom object definition slug
Response
200
404
Success. Initiates bulk entries download
CustomObjectBulkEntryInitiateDownload
message
string
task_id
string
Examples
Parameters
company_id:
1
slug:
"product_warranty_information"
Was this section helpful?
GET
Response
Sample files for custom object bulk import can be obtained from this endpoint.
Parameters
company_id
integer
Required
This is company id
slug
string
Required
This is custom object definition slug
Response
200
404
Success. Get headers of custom object definition
Examples
Parameters
company_id:
1
slug:
"product_warranty_information"
Was this section helpful?
GET
Response