Product Configuration
Retrieve a list of vendor categories with filtering and pagination options.
Number of categories to retrieve.
The number of categories to skip for pagination.
Keyword to filter categories by name.
Sort order (e.g., 0 for ascending, 1 for descending).
Filter categories by status (active or inactive).
Name of the category to filter by.
Filter categories by industry ID.
Bearer token for authentication.
Successfully retrieved category list
GET /backend/api/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved category list
<?xml version="1.0"?>
<object>
<status>1</status>
<message>text</message>
</object>
Create a new category with the provided details.
Bearer token for authentication.
test114241test<p>test</p>1Successfully created the new category.
Invalid input or missing required fields.
Internal server error.
POST /backend/api/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 220
"name='test'&sortOrder=1&metaTagDescription=''&metaTagKeyword=''&metaTagTitle=''&parentInt=1424&image=''&imagePath=''&status='1'&categorySlug='test'&categoryDescription='<p>test</p>'&industryId=1"<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully created New Category.</message>
</object>
Retrieve a list of industries with optional filters.
The number of industries to return per page (optional).
The offset for the list of industries (optional).
A search keyword to filter the industries by name (optional).
The sorting order of the results (optional).
Bearer token for authentication.
Successfully got the industry list
Invalid parameters
Internal server error
GET /backend/api/list/industry HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got industry list</message>
</object>
Retrieve a list of category translations with optional filters.
The offset for pagination.
The number of translations to return per page.
A search keyword to filter the category translations by name.
A filter for the category translations by SKU.
Bearer token for authentication.
Successfully retrieved category translation list
Invalid parameters
Internal server error
GET /backend/api/category/category-translation HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got category translation list</message>
</object>
Retrieve the translation details for a specific category based on the category ID.
ID of the category to retrieve the translation for
Bearer token for authentication.
Successfully retrieved category translation detail
Invalid category ID
Category translation not found
Internal server error
GET /backend/api/category/{categoryId}/category-translation HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully Got Category Translation Detail</message>
</object>
Save translations for a specific category based on the category ID.
ID of the category to save translations for
Bearer token for authentication.
Successfully saved category translations
Invalid input
Internal server error
POST /backend/api/category/{categoryId}/category-translation HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 84
"categoryTranslation=[{'languageId':1,'name':'text','description':'text','id':1}]"<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully Saved Category Translation</message>
</object>
Update an existing category with new details.
ID of the category to be updated
Bearer token for authentication.
Successfully updated category
Invalid input data
Category not found
Internal server error
PUT /backend/api/category/{categoryId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 234
"categoryId='text'&name='text'&sortOrder=1&metaTagDescription='text'&metaTagKeyword='text'&metaTagTitle='text'&parentInt=1&image='text'&status='text'&categorySlug='text'&categoryDescription='text'&industryId=1"<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully updated category</message>
</object>
Delete an existing category by its ID.
ID of the category to be deleted
Bearer token for authentication.
Successfully deleted category
Invalid category ID
Category not found
Internal server error
DELETE /backend/api/category/{categoryId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully deleted category</message>
</object>
Retrieve a paginated list of export logs.
Number of records to retrieve
10Number of records to skip
0Flag to indicate if the count should be returned (1 for true, 0 for false)
0Bearer token for authentication.
Successfully retrieved export log list
Invalid query parameters
Internal server error
GET /backend/api/export-log HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got the export log list</message>
</object>
Retrieve a list of orders in Excel format, with an optional filter for failed orders.
Filter orders by failed status (true or false)
falseBearer token for authentication.
Successfully retrieved order Excel list
Invalid query parameters
Internal server error
GET /backend/api/order/order-excel-list/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully retrieved order Excel list</message>
</object>
Retrieve a paginated list of products linked with QR codes.
Number of records to retrieve
10Number of records to skip
0Flag to indicate if the count should be returned (1 for true, 0 for false)
0Bearer token for authentication.
Successfully retrieved QR code product list
Invalid query parameters
Internal server error
GET /backend/api/qrCode/product-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got the complete product list.</message>
</object>
Retrieve website settings based on query parameters.
Specify whether to retrieve the default website settings (1 for true, 0 for false).
1Bearer token for authentication.
Successfully retrieved website settings
Invalid query parameters
Internal server error
GET /backend/api/settings HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got settings</message>
</object>
Generate QR codes based on the provided product data.
Bearer token for authentication.
Successfully generated the product QR code
Invalid request data
Internal server error
POST /backend/api/qrCode/created-qrcode HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 112
"productData=[{'productId':2124,'productSlug':'urban-platter-sauerkraut-original-pickled2','base64Image':''}]"<?xml version="1.0"?>
<object>
<status>1</status>
<message>successfully generated the product qr-code !!</message>
</object>
Retrieve the QR code image for a given product ID.
The ID of the product whose QR code image needs to be downloaded
Bearer token for authentication.
Successfully retrieved QR code image
Invalid product ID
QR code not found for the given product ID
Internal server error
GET /backend/api/qrCode/download-qrimage/{productId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
binaryRetrieve 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>
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>
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>
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>
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>
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>
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>
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 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>
This API retrieves a list of families with optional filtering and pagination.
Number of records to return.
Number of records to skip.
Keyword to filter families by name.
If set to 1, returns only the count.
Successfully got family list.
Failed to fetch family list.
GET /backend/api/api/family HTTP/1.1
Host: 139.59.67.17
Accept: */*
{
"status": 1,
"message": "Successfully got family.",
"data": [
{
"createdBy": "Admin",
"createdDate": "2025-04-21T12:00:00Z",
"modifiedBy": "Admin",
"modifiedDate": "2025-04-21T12:00:00Z",
"id": 1,
"familyName": "Furniture",
"isActive": 1,
"isDelete": 0
}
]
}This API allows users to add a new family.
Family created successfully.
Failed to create family
POST /backend/api/api/family HTTP/1.1
Host: 139.59.67.17
Content-Type: */*
Accept: */*
Content-Length: 3
[
1
]{
"status": 1,
"message": "Family created successfully."
}This API retrieves a list of family categories based on the provided query parameters.
Limit the number of records.
Offset for pagination.
Filter categories by status.
If set to 1, returns only the count.
Search categories by keyword.
Filter categories by family name.
Sort order for the categories.
Successfully Got family Category List.
Failed to fetch family category list.
GET /backend/api/api/family/category HTTP/1.1
Host: 139.59.67.17
Accept: */*
{
"status": 1,
"message": "Successfully Got family Category List.",
"data": [
{
"categoryId": 1,
"sortOrder": 1,
"parentInt": 1,
"name": "Category Name",
"image": "image.jpg",
"imagePath": "/path/to/image",
"isActive": 1,
"createdDate": "2025-04-21T12:00:00Z",
"levels": "Level 1",
"familyName": "Furniture",
"specifications": [
{
"createdBy": 1,
"createdDate": "2025-04-21T12:00:00Z",
"modifiedBy": 1,
"modifiedDate": "2025-04-21T12:00:00Z",
"id": 1,
"name": "Specification Name",
"slug": "specification-slug",
"isActive": 1,
"isDelete": 0
}
]
}
]
}This API retrieves the details of a specific family based on the provided family ID.
ID of the family to retrieve details for.
Successfully got family detail.
Failed to fetch family detail.
GET /backend/api/api/family/{id} HTTP/1.1
Host: 139.59.67.17
Accept: */*
{
"status": 1,
"message": "Successfully got family detail.",
"data": [
{
"createdBy": "Admin",
"createdDate": "2025-04-21T12:00:00Z",
"modifiedBy": "Admin",
"modifiedDate": "2025-04-21T12:00:00Z",
"id": 1,
"familyName": "Furniture",
"isActive": 1,
"isDelete": 0
}
]
}This API allows users to update an existing family by ID.
Family ID to update.
Family updated successfully.
Failed to update family.
PUT /backend/api/api/family/{id} HTTP/1.1
Host: 139.59.67.17
Content-Type: */*
Accept: */*
{
"status": 1,
"message": "Family updated successfully."
}This API allows users to delete a family by ID.
Family ID to delete.
Successfully deleted family.
Failed to delete family
DELETE /backend/api/api/family/{id} HTTP/1.1
Host: 139.59.67.17
Accept: */*
{
"status": 1,
"message": "Successfully deleted family."
}Last updated