Content
API for managing languages and translations of Fynd Commerce
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
DEL
# delete custom fields of given 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
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
Was this section helpful?
GET
Response
Get custom field types
getCustomFieldTypes
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
Get resources
getResources
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
400
Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionsSchema
items
array of object (FieldDefinitionSchema)
list of custom field definitions
Array of FieldDefinitionSchema
id
string
Unique system generated id
resource
string
resource type to which custom field belongs
name
string
name of custom field
namespace
string
Namespace of custom field
slug
string
slug of custom field
description
string
description of custom field definition
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multivalued or not
validations
array of object (FieldValidations)
list of validations applied
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
Undefined Type
anyOf Schema from below
company_id
string
| integer
id of company
required
boolean
whether the custom field is required or not
is_deleted
boolean
whether the custom field is deleted or not
type_name
string
type of type field
invalid_fields_count
integer
count of invalid fields after validation
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
page_no:
1
page_size:
10
resources:
"product"
types:
"string_single_line"
search:
"sometext"
Was this section helpful?
GET
Response
Get custom fields definitions
getCustomFieldDefinitions
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
400
Success. Returns a list of custom fields definitions. Refer `CustomFieldDefinitionsSchema` for more details.
CustomFieldDefinitionsSchema
items
array of object (FieldDefinitionSchema)
list of custom field definitions
Array of FieldDefinitionSchema
id
string
Unique system generated id
resource
string
resource type to which custom field belongs
name
string
name of custom field
namespace
string
Namespace of custom field
slug
string
slug of custom field
description
string
description of custom field definition
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multivalued or not
validations
array of object (FieldValidations)
list of validations applied
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
object
anyOf Schema from below
company_id
string
| integer
id of company
required
boolean
whether the custom field is required or not
is_deleted
boolean
whether the custom field is deleted or not
type_name
string
type of type field
invalid_fields_count
integer
count of invalid fields after validation
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
page_no:
1
page_size:
10
resource:
"product"
types:
"string_single_line"
search:
"sometext"
Was this section helpful?
GET
Response
Get custom fields definitions for a given resource type
getCustomFieldDefinitionByResource
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
type
string
data type of custom field
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
multi_value
boolean
flag to denote whether custom field is multi valued or not
name
string
name of custom field definition
description
string
description of a custom field definition
validations
array of object (FieldValidations)
validations for a custom field
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
object
anyOf Schema from below
Response
200
400
Custom field definition created.
CustomFieldDefinitionDetailResSchema
resource
string
resource to which custom field is associated
name
string
name of custom field
namespace
string
namespace of custom field
slug
string
slug of custom field
description
string
description regarding custom field
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the customfield is required or not
is_deleted
boolean
is custom field deleted
id
string
Unique system generated id
validations
array of Undefined Type
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create custom field definition for a given resource type
createCustomFieldDefinition
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
400
Success. Returns a custom field definition. Refer `MetaFieldDefinitionDetailResSchema` for more details.
MetaFieldDefinitionDetailResSchema
resource
string
resource to which meta field is associated
name
string
name of meta field
namespace
string
namespace of meta field
slug
string
slug of meta field
description
string
description regarding meta field
type
string
data type of meta field
multi_value
boolean
flag to denote whether meta field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the field is required or not
is_deleted
boolean
is meta field deleted
id
string
Unique system generated id
validations
array of Undefined Type
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
slug:
"65369afad436ae0e54147e86"
resource:
"product"
Was this section helpful?
GET
Response
Get custom fields definition by resource, slug and namespace
getCustomFieldDefinitionBySlug
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
type
string
data type of custom field
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
multi_value
boolean
flag to denote whether custom field is multi valued or not
name
string
name of custom field definition
description
string
description of a custom field definition
validations
array of object (FieldValidations)
validations for a custom field
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
object
anyOf Schema from below
Response
200
400
Custom field definition updated.
CustomFieldDefinitionDetailResSchema
resource
string
resource to which custom field is associated
name
string
name of custom field
namespace
string
namespace of custom field
slug
string
slug of custom field
description
string
description regarding custom field
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the customfield is required or not
is_deleted
boolean
is custom field deleted
id
string
Unique system generated id
validations
array of object
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
slug:
"65369afad436ae0e54147e86"
resource:
"product"
Was this section helpful?
PUT
Response
Update custom field definition
updateCustomFieldDefinitionBySlug
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
400
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
denotes the success of the delete operation
message
string
denotes the message of delete operation
Examples
Parameters
company_id:
1
slug:
"65369afad436ae0e54147e86"
resource:
"product"
Was this section helpful?
DEL
Response
Delete custom fields definition
deleteCustomFieldDefinitionBySlug
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
400
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Array of CustomFieldSchema
id
string
Unique system generated id
namespace
string
namespace of custom field definition
slug
string
slug of custom field definition
resource
string
the resource for which custom field is being created
value
array of object (CustomFieldValue)
Array of CustomFieldValue
value
Undefined Type
anyOf Schema from below
resource_slug
string
unique identifier of the resource
type
string
data type of custom field
multi_value
boolean
whether custom field is multi valued
company_id
string
| integer
identifer for a company
has_invalid_values
boolean
invalid_value_errors
array of Undefined Type
is_deleted
boolean
indicates whether custom field is deleted
created_at
string
| date-time
time at which customer field was created
updated_at
string
| date-time
time at which custom field was updated
Examples
Parameters
company_id:
1
resource:
"product"
resource_slug:
"64bb987e9a3c4b6c29d676bc"
Was this section helpful?
GET
Response
Get list of custom fields of given resource and resource slug
getCustomFieldsByResourceSlug
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 (CustomField)
Array of CustomField
value
array of object
anyOf Schema from below
namespace
string
This is the namespace to which custom field belongs
slug
string
This is the slug of custom field used while creating a custom field definition
Response
200
400
Success. Returns a list of custom fields. Refer `CustomFieldsResponseByResourceIdSchema` for more details.
CustomFieldsResponseByResourceIdSchema
items
array of object (CustomFieldSchema)
Array of CustomFieldSchema
id
string
Unique system generated id
namespace
string
namespace of custom field definition
slug
string
slug of custom field definition
resource
string
the resource for which custom field is being created
value
array of object (CustomFieldValue)
Array of CustomFieldValue
value
object
anyOf Schema from below
resource_slug
string
unique identifier of the resource
type
string
data type of custom field
multi_value
boolean
whether custom field is multi valued
company_id
string
| integer
identifer for a company
has_invalid_values
boolean
invalid_value_errors
array of object
is_deleted
boolean
indicates whether custom field is deleted
created_at
string
| date-time
time at which customer field was created
updated_at
string
| date-time
time at which custom field was updated
Examples
Parameters
company_id:
1
resource:
"product"
resource_slug:
"64bb987e9a3c4b6c29d676bc"
body:
body
Was this section helpful?
PUT
Response
Update custom field entries for gives resource and resource slug
updateCustomFieldByResourceSlug
Use this API to delete the custom fields for given resource in param.
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
ids
string
Required
This is the ids of to filter custom fields
Response
200
400
Success. Returns a list of custom fields. Refer `CustomFieldsDeleteSchema` for more details.
CustomFieldsDeleteSchema
success
boolean
message
string
Examples
Parameters
ids:
"65d196c533b05cbc1cf24323"
Was this section helpful?
DEL
Response
delete custom fields of given resource and resource slug
deleteCustomFieldsByResourceSlug
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
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
Namespace/Slug of Custom object definition
definition_slug
string
Unique slug for a custom object definition
description
string
description of custom object definition
name
string
name of custom object
display_name_key
string
denotes which custom field to be used for displaying custom object
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
list of custom field definitions belonging to this custom object definition
Array of CustomObjectCustomFieldDefinitions
id
string
Unique identifer for a custom field
type
string
data type of custom field
description
string
description of custom field
name
string
name of custom field
multi_value
boolean
flag to denote if cusom field is multi valued or not
required
boolean
whether the field is required or not
slug
string
slug of custom field definition
validations
array of object (FieldValidations)
validations added against the custom field
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
object
anyOf Schema from below
action
string
Response
200
400
Success. Returns the saved custom object defintion
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
definition_slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
resource
string
resource to which custom field is associated
name
string
name of custom field
namespace
string
namespace of custom field
slug
string
slug of custom field
description
string
description regarding custom field
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the customfield is required or not
is_deleted
boolean
is custom field deleted
id
string
Unique system generated id
validations
array of object
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create custom object definition
createCustomObjectDefinition
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
Success. Returns a list custom object definitions.
CustomObjectDefinitionsSchema
items
array of object (CustomObjectEntry)
Array of CustomObjectEntry
id
string
Unique system generated id
name
string
Name of Custom Object definition
type
string
Type of Custom Object Definition
updated_at
string
| date-time
Updation time of a Custom Object
entries_count
integer
Number of entries against the Custom Object definition
fields_count
integer
Number of fields against a Custom Object definition
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
page_no:
1
page_size:
10
search:
"sometext"
Was this section helpful?
GET
Response
Get custom object definitions
getCustomObjectDefinitions
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
400
Success. It will returns the message for delete successfully.
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
definition_slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
resource
string
resource to which custom field is associated
name
string
name of custom field
namespace
string
namespace of custom field
slug
string
slug of custom field
description
string
description regarding custom field
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the customfield is required or not
is_deleted
boolean
is custom field deleted
id
string
Unique system generated id
validations
array of object
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
slug:
"address-success"
Was this section helpful?
GET
Response
Get custom object definition
getCustomObjectDefinitionBySlug
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
description
string
description of custom object definiton
name
string
name of custom object definition
display_name_key
string
custom field slug which is used as a display key in
field_definitions
array of object (CustomObjectCustomFieldDefinitions)
Array of CustomObjectCustomFieldDefinitions
id
string
Unique identifer for a custom field
type
string
data type of custom field
description
string
description of custom field
name
string
name of custom field
multi_value
boolean
flag to denote if cusom field is multi valued or not
required
boolean
whether the field is required or not
slug
string
slug of custom field definition
validations
array of object (FieldValidations)
validations added against the custom field
Array of FieldValidations
name
string
Name of validation
type
string
type of validation
value
object
anyOf Schema from below
action
string
Response
200
400
Custom field definition updated.
CustomObjectDefinitionSlugSchema
id
string
Unique system generated custom object definition id
name
string
Display name of custom object definition
type
string
Type of custom object definiton
definition_slug
string
Slug of custom object definiton
display_name_key
string
Display name of custom object definition
description
string
description of custom object definition
field_definitions
array of object (CustomFieldDefinitionDetailResSchema)
Custom fields inside custom objects
Array of CustomFieldDefinitionDetailResSchema
resource
string
resource to which custom field is associated
name
string
name of custom field
namespace
string
namespace of custom field
slug
string
slug of custom field
description
string
description regarding custom field
type
string
data type of custom field
multi_value
boolean
flag to denote whether custom field is multi valued or not
company_id
string
| integer
Company Identifer
application_id
string
Sales channel identifier
required
boolean
whether the customfield is required or not
is_deleted
boolean
is custom field deleted
id
string
Unique system generated id
validations
array of object
created_at
string
| date-time
date time at which field was created
updated_at
string
| date-time
date time at for a field's last modification
Examples
Parameters
company_id:
1
slug:
"address-success"
Was this section helpful?
PUT
Response
Update custom object definition
updateCustomObjectDefinitionBySlug
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
400
Custom object definition details.
CustomObjectDefinitionDeleteResponseSchema
success
boolean
Success status of delete custom object definition.
message
string
Response message when custom object definition is deleted.
Examples
Parameters
company_id:
1
slug:
"address-success"
Was this section helpful?
DEL
Response
Delete custom object definition
deleteCustomObjectDefinitionBySlug
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
400
Success. Returns a list of custom objects. Refer `CustomObjectsSchema` for more details.
CustomObjectsSchema
items
array of object (CustomObjectListItemSchema)
list of paginated custom object entries
Array of CustomObjectListItemSchema
id
string
Unique system generated id
status
string
Status of custom object
created_at
string
| date-time
Creation time of custom object document
updated_at
string
| date-time
Updation time of custom object document
display_name
string
Display name of custom object
definition
object (CustomObjectListItemDefinitionModel)
CustomObjectListItemDefinitionModel
id
string
Unique system generated id
name
string
Name of custom object
type
string
Type of custom object entry
references
integer
references of the custom object entry
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
page_no:
1
page_size:
10
definition_slug:
"address-success"
Was this section helpful?
GET
Response
Get list of custom objects under a certain custom object definition
getCustomObjectsBySlug
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
status
string
status of the custom object entry.
fields
array of object (CustomObjectEntryFieldSchemaWithoutID)
list of custom fields
Array of CustomObjectEntryFieldSchemaWithoutID
slug
string
custom fields belonging to a custom object
value
object
value of custom field inside a custom object
anyOf Schema from below
Response
200
400
Success. Returns a list of custom objects. Refer `CustomObjectSchema` for more details.
CustomObjectSchema
id
string
Unique system generated id
company_id
string
| integer
Identifer for a company
application_id
string
Identifer for a sales channel
status
string
Status of custom object
type
string
Slug of custom object definition
definition_slug
string
Slug for custom object definition
display_name
string
Value of custom field used for displaying custom object
fields
array of object (CustomFieldSchema)
Fields associated to the custom object
Array of CustomFieldSchema
id
string
Unique system generated id
namespace
string
namespace of custom field definition
slug
string
slug of custom field definition
resource
string
the resource for which custom field is being created
value
array of object (CustomFieldValue)
Array of CustomFieldValue
value
object
anyOf Schema from below
resource_slug
string
unique identifier of the resource
type
string
data type of custom field
multi_value
boolean
whether custom field is multi valued
company_id
string
| integer
identifer for a company
has_invalid_values
boolean
invalid_value_errors
array of object
is_deleted
boolean
indicates whether custom field is deleted
created_at
string
| date-time
time at which customer field was created
updated_at
string
| date-time
time at which custom field was updated
Examples
Parameters
company_id:
1
definition_slug:
"address-success"
Was this section helpful?
POST
Response
Create custom object entries
createCustomObjectBySlug
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
400
Success. Returns a custom object. Refer `CustomObjectBySlugSchema` for more details.
CustomObjectBySlugSchema
id
string
Unique system generated identifer for a Custom Object
status
string
status of Custom Object
display_name
string
Display name for the Custom Object
definition
object (CustomObjectListItemDefinitionModel)
CustomObjectListItemDefinitionModel
id
string
Unique system generated id
name
string
Name of custom object
type
string
Type of custom object entry
references
array of Undefined Type
Places where the custom object has been used as a custom field
slug
string
slug of custom object entry
definition_slug
string
slug of custom object definition
fields
array of object (CustomObjectFieldDefinition)
List of custom fields inside the custom object
Array of CustomObjectFieldDefinition
id
string
Unique system generate id
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
value
array of Undefined Type
value of custom field
anyOf Schema from below
type
string
data type of the custom field
Examples
Parameters
company_id:
1
definition_slug:
"address-success"
slug:
"address-1-success"
Was this section helpful?
GET
Response
Get custom object details
getCustomObjectBySlug
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
400
Success. It will returns the message for delete successfully.
CustomDataDeleteSchema
success
boolean
denotes the success of the delete operation
message
string
denotes the message of delete operation
Examples
Parameters
company_id:
1
definition_slug:
"address-success"
slug:
"address-1-success"
Was this section helpful?
DEL
Response
Delete custom object
deleteCustomObjectBySlug
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
status
string
status of the custom object entry.
fields
array of object (CustomObjectEntryFieldSchemaWithoutID)
list of custom fields
Array of CustomObjectEntryFieldSchemaWithoutID
slug
string
custom fields belonging to a custom object
value
object
value of custom field inside a custom object
anyOf Schema from below
Response
200
400
Custom field definition created.
CustomObjectBySlugSchema
id
string
Unique system generated identifer for a Custom Object
status
string
status of Custom Object
display_name
string
Display name for the Custom Object
definition
object (CustomObjectListItemDefinitionModel)
CustomObjectListItemDefinitionModel
id
string
Unique system generated id
name
string
Name of custom object
type
string
Type of custom object entry
references
array of object
Places where the custom object has been used as a custom field
slug
string
slug of custom object entry
definition_slug
string
slug of custom object definition
fields
array of object (CustomObjectFieldDefinition)
List of custom fields inside the custom object
Array of CustomObjectFieldDefinition
id
string
Unique system generate id
slug
string
slug of custom field definition
namespace
string
namespace of custom field definition
value
array of object
value of custom field
anyOf Schema from below
type
string
data type of the custom field
Examples
Parameters
company_id:
1
definition_slug:
"address-success"
slug:
"address-1-success"
Was this section helpful?
PUT
Response
Update custom object details
updateCustomObjectBySlug
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
Full URL for the bulk operations data
total_records
integer
Total records in the upload.
Response
200
400
Success. Returns confirmation that the upload has started
CustomObjectEntryBulkUploadDetails
url
string
Signed url of csv
total_records
integer
Total no of records in csv file
Examples
Parameters
company_id:
1
slug:
"address-success"
body:
body
Was this section helpful?
POST
Response
Bulk custom object entries upload
importCustomObjectEntriesBySlug
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
400
Success. Initiates bulk entries download
CustomObjectBulkEntryInitiateDownload
message
string
message for the user
task_id
string
Identifer for a task
Examples
Parameters
company_id:
1
slug:
"address-success"
Was this section helpful?
GET
Response
Initiate download for bulk custom object entries
exportCustomObjectEntriesBySlug
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
400
Success. Get headers of custom object definition
Examples
Parameters
company_id:
1
slug:
"address-success"
Was this section helpful?
GET
Response