Add-ons Product Attributes
Retrieve a list of product attributes with optional pagination and search keyword.
Number of records to return
10Offset for pagination
0Search keyword to filter attributes
colorBearer token for authentication.
Successfully retrieved the attribute list
GET /backend/api/attribute HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved the attribute list
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got the attribute list</message>
</object>
This endpoint creates a new attribute with specified properties.
Bearer token for authentication.
testshort-text011testtesttest1Attribute added successfully
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'§ionName=''&defaultValue='test'&attributeValues=[{'value':''}]&sortOrder=1"Attribute added successfully
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Attribute added successfully.</message>
</object>
Retrieves a list of attribute groups with optional pagination and search filters.
Number of items to return per page.
10Offset to start listing attribute groups from.
0Search keyword to filter attribute groups.
Flag to return count of attribute groups.
0Bearer token for authentication.
Successfully retrieved the attribute group list
GET /backend/api/attribute-group/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved the attribute group list
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got the attribute group list.</message>
</object>
Creates a new attribute group with the specified details.
Bearer token for authentication.
The name of the attribute group.
testgThe sort order of the attribute group.
1List of attribute IDs associated with the group.
[106]Successfully created the attribute group
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]"Successfully created the attribute group
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully added Attribute Group</message>
</object>
Retrieves details of a specific attribute group by its ID.
The ID of the attribute group to retrieve.
Bearer token for authentication.
Successfully retrieved the attribute group
Invalid ID supplied
Attribute group not found
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>
Updates an existing attribute group.
The ID of the attribute group to be updated.
Bearer token for authentication.
Updated Group Name1[106,107]Successfully updated the attribute group
Invalid ID supplied
Attribute group not found
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>
Deletes an existing attribute group.
The ID of the attribute group to be deleted.
Bearer token for authentication.
Successfully deleted the attribute group
Invalid ID supplied
Attribute group not found
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>
Retrieves the translation for the specified attribute group.
The ID of the attribute group to retrieve translations for.
Bearer token for authentication.
Successfully retrieved translation for the attribute group
Invalid ID supplied
Attribute group translation not found
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>
Creates a new translation for the specified attribute group.
The ID of the attribute group to create a translation for.
Bearer token for authentication.
The language of the translation.
The translated name for the attribute group.
The translated description for the attribute group.
Successfully created translation for the attribute group
Invalid ID or request body
Attribute group not found
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>
Fetches a list of specifications with optional filtering.
The number of specifications to return (pagination).
10The offset from where to start retrieving specifications.
0A search keyword to filter specifications by.
If set to 1, only returns the count of specifications instead of the list.
0Bearer token for authentication.
Successfully retrieved the list of specifications
Invalid query parameters
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>
Fetches a list of attribute groups with optional filtering.
The number of attribute groups to return (pagination).
10The offset from where to start retrieving attribute groups.
0If set to 1, only returns the count of attribute groups instead of the list.
0Bearer token for authentication.
Successfully retrieved the list of attribute groups
Invalid query parameters
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>
This endpoint retrieves the list of specifications.
Number of records to return
10The starting position of the records
0Keyword for searching specifications
Whether to return the count of records (0 = no, 1 = yes)
0Bearer token for authentication.
Successfully retrieved the list of specifications
Invalid parameters or request
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>
This endpoint is used to create a new specification, which may include associated attribute groups and attributes.
Bearer token for authentication.
tests1101Successfully created the specification
Invalid input or missing required fields
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>
This endpoint retrieves a specification based on the provided specification ID.
ID of the specification to retrieve
Bearer token for authentication.
Successfully retrieved the specification
Specification not found
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>
This endpoint updates a specification based on the provided specification ID.
ID of the specification to update
Bearer token for authentication.
tests152Successfully updated the specification
Specification not found
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>
This endpoint deletes a specification based on the provided specification ID.
ID of the specification to delete
Bearer token for authentication.
Successfully deleted the specification
Specification not found
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>
This endpoint retrieves the translation details of a specification by its ID.
ID of the specification translation to retrieve
Bearer token for authentication.
Successfully retrieved specification translation details
Specification translation not found
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>
This endpoint creates a new translation for the specified specification by its ID.
ID of the specification to add the translation for
Bearer token for authentication.
Details of the new specification translation
enThis is the translated specificationSuccessfully created new specification translation
Bad request, invalid data
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>
This endpoint retrieves the list of specification categories, with optional query parameters for filtering and pagination.
Number of records to return
10The starting position of the records
0Keyword for searching specification categories
Whether to return the count of records (0 = no, 1 = yes)
0Bearer token for authentication.
Successfully retrieved the list of specification categories
Invalid parameters or request
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>
This endpoint updates the specifications assigned to a category.
Bearer token for authentication.
The ID of the category
1424List of specification IDs to associate with the category
51List of specification IDs to remove from the category
Successfully updated the specifications for the category
Invalid request parameters
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>
This endpoint retrieves a list of site filters based on the specified query parameters.
Number of records to return.
The starting point for the filter records.
Search keyword for filtering the list.
Bearer token for authentication.
Successfully retrieved the filter list
Invalid query parameters
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>
This endpoint creates a new site filter based on the provided data.
Bearer token for authentication.
The name of the filter
A list of category IDs associated with the filter
Successfully created the site filter
Invalid input data
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]§ion=[{'sectionType':1,'sectionItem':['text'],'sectionName':'text'}]"<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully created a new Filter</message>
</object>
This endpoint retrieves the details of a site filter by its ID.
The ID of the site filter
Bearer token for authentication.
Successfully retrieved the filter details
Invalid ID supplied
Filter not found
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>
This endpoint updates the details of a site filter by its ID.
The ID of the site filter to update
Bearer token for authentication.
The name of the site filter
List of category IDs associated with the filter
The ID of the site filter being edited
Successfully updated the site filter
Invalid input
Site filter not found
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]§ion=[{'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>
This endpoint deletes a specific site filter by its ID.
The ID of the site filter to delete
Bearer token for authentication.
Successfully deleted the site filter
Site filter not found
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