Add-ons Product Attributes

Get attribute list

get

Retrieve a list of product attributes with optional pagination and search keyword.

Query parameters
limitintegerOptional

Number of records to return

Example: 10
offsetintegerOptional

Offset for pagination

Example: 0
keywordstringOptional

Search keyword to filter attributes

Example: color
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the attribute list

get
GET /backend/api/attribute HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
200

Successfully retrieved the attribute list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the attribute list</message>
</object>

Create a new attribute

post

This endpoint creates a new attribute with specified properties.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequiredExample: test
typestringRequiredExample: short-text
isMandatoryintegerRequiredExample: 0
useAsFilterintegerOptionalExample: 1
isActiveintegerRequiredExample: 1
descriptionstringOptionalExample: test
labelstringOptionalExample: test
sectionNamestringOptional
defaultValuestringOptionalExample: test
sortOrderintegerOptionalExample: 1
Responses
200

Attribute added successfully

post
POST /backend/api/attribute/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 202

"name='test'&type='short-text'&isMandatory=0&useAsFilter=1&isActive=1&description='test'&label='test'&sectionName=''&defaultValue='test'&attributeValues=[{'value':''}]&sortOrder=1"
200

Attribute added successfully

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Attribute added successfully.</message>
</object>

Get attribute group list

get

Retrieves a list of attribute groups with optional pagination and search filters.

Query parameters
limitintegerOptional

Number of items to return per page.

Default: 10
offsetintegerOptional

Offset to start listing attribute groups from.

Default: 0
keywordstringOptional

Search keyword to filter attribute groups.

countintegerOptional

Flag to return count of attribute groups.

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the attribute group list

get
GET /backend/api/attribute-group/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
200

Successfully retrieved the attribute group list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the attribute group list.</message>
</object>

Create a new attribute group

post

Creates a new attribute group with the specified details.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequired

The name of the attribute group.

Example: testg
sortOrderintegerRequired

The sort order of the attribute group.

Example: 1
attributeIdsinteger[]Required

List of attribute IDs associated with the group.

Example: [106]
Responses
200

Successfully created the attribute group

post
POST /backend/api/attribute-group/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 51

"name='testg'&sortOrder=1&attributeIds=[106]"
200

Successfully created the attribute group

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully added Attribute Group</message>
</object>

Get attribute group by ID

get

Retrieves details of a specific attribute group by its ID.

Path parameters
idintegerRequired

The ID of the attribute group to retrieve.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the attribute group

get
GET /backend/api/attribute-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Update attribute group by ID

put

Updates an existing attribute group.

Path parameters
idintegerRequired

The ID of the attribute group to be updated.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequiredExample: Updated Group Name
sortOrderintegerRequiredExample: 1
attributeIdsinteger[]RequiredExample: [106,107]
Responses
200

Successfully updated the attribute group

put
PUT /backend/api/attribute-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 68

"name='Updated Group Name'&sortOrder=1&attributeIds=[106,107]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Delete attribute group by ID

delete

Deletes an existing attribute group.

Path parameters
idintegerRequired

The ID of the attribute group to be deleted.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully deleted the attribute group

delete
DELETE /backend/api/attribute-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get translations for an attribute group by ID

get

Retrieves the translation for the specified attribute group.

Path parameters
idintegerRequired

The ID of the attribute group to retrieve translations for.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved translation for the attribute group

get
GET /backend/api/attribute-group-translation/attribute-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Create translation for an attribute group by ID

post

Creates a new translation for the specified attribute group.

Path parameters
idintegerRequired

The ID of the attribute group to create a translation for.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Bodyobject[]
languagestringRequired

The language of the translation.

translatedNamestringRequired

The translated name for the attribute group.

translatedDescriptionstringOptional

The translated description for the attribute group.

Responses
200

Successfully created translation for the attribute group

post
POST /backend/api/attribute-group-translation/attribute-group/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 76

"[{'language':'text','translatedName':'text','translatedDescription':'text'}]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get list of specifications

get

Fetches a list of specifications with optional filtering.

Query parameters
limitintegerOptional

The number of specifications to return (pagination).

Default: 10
offsetintegerOptional

The offset from where to start retrieving specifications.

Default: 0
keywordstringOptional

A search keyword to filter specifications by.

countintegerOptional

If set to 1, only returns the count of specifications instead of the list.

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the list of specifications

get
GET /backend/api/specification/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get list of attribute groups

get

Fetches a list of attribute groups with optional filtering.

Query parameters
limitintegerOptional

The number of attribute groups to return (pagination).

Default: 10
offsetintegerOptional

The offset from where to start retrieving attribute groups.

Default: 0
countintegerOptional

If set to 1, only returns the count of attribute groups instead of the list.

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the list of attribute groups

get
GET /backend/api/attribute-group HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get list of specifications

get

This endpoint retrieves the list of specifications.

Query parameters
limitintegerOptional

Number of records to return

Default: 10
offsetintegerOptional

The starting position of the records

Default: 0
keywordstringOptional

Keyword for searching specifications

countintegerOptional

Whether to return the count of records (0 = no, 1 = yes)

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the list of specifications

get
GET /backend/api/specification HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got Specification List.</message>
</object>

Create a new specification

post

This endpoint is used to create a new specification, which may include associated attribute groups and attributes.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringOptionalExample: tests
statusintegerOptionalExample: 1
attributeGroupIdinteger[]OptionalExample: 101
Responses
200

Successfully created the specification

post
POST /backend/api/specification HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 116

"name='tests'&status=1&attributeGroup=[{'attributeGroupId':36,'attributeIds':[102]}]&attributeGroupId=[101]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get a specification by ID

get

This endpoint retrieves a specification based on the provided specification ID.

Path parameters
idintegerRequired

ID of the specification to retrieve

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the specification

get
GET /backend/api/specification/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Got Specification.</message>
</object>

Update a specification by ID

put

This endpoint updates a specification based on the provided specification ID.

Path parameters
idintegerRequired

ID of the specification to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequiredExample: tests
statusintegerRequiredExample: 1
attributeGroupIdinteger[]Optional
deleteAttributeGroupIdsinteger[]Optional
idstringOptionalExample: 52
Responses
200

Successfully updated the specification

put
PUT /backend/api/specification/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 154

"name='tests'&status=1&attributeGroup=[{'attributeGroupId':36,'attributeIds':[102]}]&attributeGroupId=[1]&deleteAttributeGroupIds=[1]&id='52'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Update Specification.</message>
</object>

Delete a specification by ID

delete

This endpoint deletes a specification based on the provided specification ID.

Path parameters
idintegerRequired

ID of the specification to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully deleted the specification

delete
DELETE /backend/api/specification/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted Specification..!</message>
</object>

Get specification translation details by ID

get

This endpoint retrieves the translation details of a specification by its ID.

Path parameters
idintegerRequired

ID of the specification translation to retrieve

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved specification translation details

get
GET /backend/api/specification-translation/specification/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got specification translation detail</message>
</object>

Create new specification translation for the given specification ID

post

This endpoint creates a new translation for the specified specification by its ID.

Path parameters
idintegerRequired

ID of the specification to add the translation for

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body

Details of the new specification translation

languagestringOptionalExample: en
translationstringOptionalExample: This is the translated specification
Responses
200

Successfully created new specification translation

post
POST /backend/api/specification-translation/specification/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 70

"language='en'&translation='This is the translated specification'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created new specification translation</message>
</object>

Get list of specification categories

get

This endpoint retrieves the list of specification categories, with optional query parameters for filtering and pagination.

Query parameters
limitintegerOptional

Number of records to return

Default: 10
offsetintegerOptional

The starting position of the records

Default: 0
keywordstringOptional

Keyword for searching specification categories

countintegerOptional

Whether to return the count of records (0 = no, 1 = yes)

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the list of specification categories

get
GET /backend/api/specification/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Got Specification Category List.</message>
</object>

Update specification for a category

put

This endpoint updates the specifications assigned to a category.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Bodyobject[]
categoryIdintegerRequired

The ID of the category

Example: 1424
specificationIdsinteger[]Required

List of specification IDs to associate with the category

Example: 51
deleteSpecificationIdsinteger[]Optional

List of specification IDs to remove from the category

Responses
200

Successfully updated the specifications for the category

put
PUT /backend/api/specification/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 74

"[{'categoryId':1424,'specificationIds':[51],'deleteSpecificationIds':[1]}]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Updated Specification To Category.</message>
</object>

Get a list of site filters

get

This endpoint retrieves a list of site filters based on the specified query parameters.

Query parameters
limitintegerOptional

Number of records to return.

offsetintegerOptional

The starting point for the filter records.

keywordstringOptional

Search keyword for filtering the list.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the filter list

get
GET /backend/api/site-filter/site-filter-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got filter list</message>
</object>

Create a new site filter

post

This endpoint creates a new site filter based on the provided data.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
filterNamestringOptional

The name of the filter

categoryIdinteger[]Optional

A list of category IDs associated with the filter

Responses
200

Successfully created the site filter

post
POST /backend/api/site-filter/create-site-filter HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 112

"filterName='text'&categoryId=[1]&section=[{'sectionType':1,'sectionItem':['text'],'sectionName':'text'}]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created a new Filter</message>
</object>

Get details of a specific site filter

get

This endpoint retrieves the details of a site filter by its ID.

Path parameters
idintegerRequired

The ID of the site filter

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the filter details

get
GET /backend/api/site-filter/filter-detail/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got filter detail</message>
</object>

Update a site filter

put

This endpoint updates the details of a site filter by its ID.

Path parameters
idintegerRequired

The ID of the site filter to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
filterNamestringRequired

The name of the site filter

categoryIdinteger[]Required

List of category IDs associated with the filter

editIdstringRequired

The ID of the site filter being edited

Responses
200

Successfully updated the site filter

put
PUT /backend/api/site-filter/update-site-filter/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 142

"filterName='text'&categoryId=[1]&section=[{'sectionType':1,'sectionItem':['text'],'sectionName':'text','sectionId':1}]&editId='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated the site filter</message>
</object>

Delete a site filter

delete

This endpoint deletes a specific site filter by its ID.

Path parameters
idintegerRequired

The ID of the site filter to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully deleted the site filter

delete
DELETE /backend/api/site-filter/delete-site-filter/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted the filter</message>
</object>

Last updated