Meta Info

This section covers the API endpoint to fetch core and custom fields which are available for bulk update.

Core attributes

Below are the core fields which are available for bulk update:

Field name	Field code
Category	Category
CountryOfOrigin	CountryOfOrigin
DimHeight	DimHeight
DimLength	DimLength
DimWidth	DimWidth
EnableNotifyMe	EnableNotifyMe
EnableSubscription	EnableSubscription
FulfilFromInstoreDays	FulfilFromInstoreDays
FulfilFromStore	FulfilFromStore
FulfilFromSupplier	FulfilFromSupplier
FulfilFromSupplierDays	FulfilFromSupplierDays
FulfilFromWarehouse	FulfilFromWarehouse
FulfilFromWarehouseDays	FulfilFromWarehouseDays
HSNCode	HSNCode
IsActive	IsActive
IsPreOrderEnabled	IsPreOrderEnabled
LaunchDate	LaunchDate
PreorderLanchDate	PreorderLanchDate
PreorderMaxStock	PreorderMaxStock
SellWithoutInventory	SellWithoutInventory
Visibility	Visibility
Weight	Weight

GET/api/v1/meta-info

Meta Info

This endpoint returns the list of all the attributes available in the system along with their meta-info.

Request Parameters

NA - No request parameters required for this endpoint

Sample Request

Request

GET

/api/v1/meta-info

curl --location '<api_url>/api/v1/meta-info' \
--header 'Accept: text/plain' \
--header 'Authorization: bearer {{apiKey}}'

Response Model

Response

{
"statusCode": 100,
"status": "string",
"error": "string",
"errorId": "string",
"message": "string",
"messageCode": "string",
"result": [
 {
   "fieldCode": "string",
   "fieldName": "string",
   "fieldGroup": "string",
   "displayOrder": 0,
   "inputType": 1,
   "options": [
     {
       "key": "string",
       "value": "string"
     }
   ],
   "defaultValue": "string",
   "isCustom": true,
   "isRequired": true,
   "validations": [
     1
   ],
   "info1": "string",
   "info2": "string",
   "info3": "string",
   "isSearchable": true,
   "isBulkEditable": true,
   "searchType": 0
 }
]
}

Name	Type	Description
status	string	Holds the status name related to the status code
error	string	Details of the error, if any
errorId	string	Error Id displayed in case of any errors/success
message	string	Message displayed in case of any errors/success
messageCode	string	Response message code
totalRecords	int	Total number of products in result set
result	object	Contains the result object which can be array of objects or specific object
result.fieldCode	string	Code of the attribute
result.fieldName	int	Name of the Attribute
result.fieldGroup	string	Attribute group of which this attribute belongs to
result.displayOrder	int	Display order of the attribute
result.inputType	int	Input type of the attribute Input type
result.options	object of key value pair	List of attribute value options uploaded for this attribute
result.options.key	string	Name of the attribute option
result.options.value	string	Value of the attribute option
result.defaultValue	string	Default value of the attribute
result.isCustom	boolean	Whether attribute is a custom attribute or core
result.isRequired	boolean	Whether attribute is required for a product or not
result.validations	array	validation results for the attribute
result.info1	string	Any additional custom information about the attribute
result.info2	string	Any additional custom information about the attribute
result.info3	string	Any additional custom information about the attribute
result.isSearchable	boolean	Whether attribute is searchable or not
result.isBulkEditable	boolean	Whether attribute is enabled for bulk edit or not
result.searchType	int	It returns the identifier whether the attribute can be updated at master product level, child product level or both. Here are the Update Types