Product Configuration

Get vendor category list

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/category

Retrieve a list of vendor categories with filtering and pagination options.

Query parameters

limitintegerOptional

Number of categories to retrieve.

offsetintegerOptional

The number of categories to skip for pagination.

keywordstringOptional

Keyword to filter categories by name.

sortOrderintegerOptional

Sort order (e.g., 0 for ascending, 1 for descending).

statusintegerOptional

Filter categories by status (active or inactive).

namestringOptional

Name of the category to filter by.

industryIdintegerOptional

Filter categories by industry ID.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved category list

application/xmlapplication/json

get

/category

HTTPcURLJavaScriptPython

GET /backend/api/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

200

Successfully retrieved category list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Create a new category

post

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/category

Create a new category with the provided details.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

application/x-www-form-urlencoded

namestringRequiredExample: test

sortOrderintegerRequiredExample: 1

metaTagDescriptionstringOptional

metaTagKeywordstringOptional

metaTagTitlestringOptional

parentIntintegerRequiredExample: 1424

imagestringOptional

imagePathstringOptional

statusstringRequiredExample: 1

categorySlugstringRequiredExample: test

categoryDescriptionstringRequiredExample: <p>test</p>

industryIdintegerRequiredExample: 1

Responses

200

Successfully created the new category.

application/xmlapplication/json

400

Invalid input or missing required fields.

500

Internal server error.

post

/category

HTTPcURLJavaScriptPython

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>

Get a list of industries

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/list/industry

Retrieve a list of industries with optional filters.

Query parameters

limitintegerOptional

The number of industries to return per page (optional).

offsetintegerOptional

The offset for the list of industries (optional).

keywordstringOptional

A search keyword to filter the industries by name (optional).

sortOrderstring · enumOptional

The sorting order of the results (optional).

Possible values:

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully got the industry list

application/xmlapplication/json

400

Invalid parameters

500

Internal server error

get

/list/industry

HTTPcURLJavaScriptPython

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>

Get category translation list

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/category/category-translation

Retrieve a list of category translations with optional filters.

Query parameters

offsetintegerOptional

The offset for pagination.

limitintegerOptional

The number of translations to return per page.

keywordstringOptional

A search keyword to filter the category translations by name.

skustringOptional

A filter for the category translations by SKU.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved category translation list

application/xmlapplication/json

400

Invalid parameters

500

Internal server error

get

/category/category-translation

HTTPcURLJavaScriptPython

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>

Get category translation detail

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/category/{categoryId}/category-translation

Retrieve the translation details for a specific category based on the category ID.

Path parameters

categoryIdintegerRequired

ID of the category to retrieve the translation for

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved category translation detail

application/xmlapplication/json

400

Invalid category ID

404

Category translation not found

500

Internal server error

get

/category/{categoryId}/category-translation

HTTPcURLJavaScriptPython

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 category translations

post

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/category/{categoryId}/category-translation

Save translations for a specific category based on the category ID.

Path parameters

categoryIdintegerRequired

ID of the category to save translations for

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

application/x-www-form-urlencoded

Responses

200

Successfully saved category translations

application/xmlapplication/json

400

Invalid input

500

Internal server error

post

/category/{categoryId}/category-translation

HTTPcURLJavaScriptPython

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 category

put

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/category/{categoryId}

Update an existing category with new details.

Path parameters

categoryIdintegerRequired

ID of the category to be updated

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

application/x-www-form-urlencoded

categoryIdstringRequired

namestringRequired

sortOrderintegerRequired

metaTagDescriptionstringOptional

metaTagKeywordstringOptional

metaTagTitlestringOptional

parentIntintegerOptional

imagestringOptional

statusstringRequired

categorySlugstringRequired

categoryDescriptionstringOptional

industryIdintegerRequired

Responses

200

Successfully updated category

application/xmlapplication/json

400

Invalid input data

404

Category not found

500

Internal server error

put

/category/{categoryId}

HTTPcURLJavaScriptPython

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 category

delete

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/category/{categoryId}

Delete an existing category by its ID.

Path parameters

categoryIdintegerRequired

ID of the category to be deleted

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted category

application/xmlapplication/json

400

Invalid category ID

404

Category not found

500

Internal server error

delete

/category/{categoryId}

HTTPcURLJavaScriptPython

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>

Get export log list

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/export-log

Retrieve a paginated list of export logs.

Query parameters

limitintegerOptional

Number of records to retrieve

Default: 10

offsetintegerOptional

Number of records to skip

Default: 0

countintegerOptional

Flag to indicate if the count should be returned (1 for true, 0 for false)

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved export log list

application/xmlapplication/json

400

Invalid query parameters

500

Internal server error

get

/export-log

HTTPcURLJavaScriptPython

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>

Get order Excel list

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/order/order-excel-list/

Retrieve a list of orders in Excel format, with an optional filter for failed orders.

Query parameters

failedOrderbooleanOptional

Filter orders by failed status (true or false)

Default: false

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved order Excel list

application/xmlapplication/json

400

Invalid query parameters

500

Internal server error

get

/order/order-excel-list/

HTTPcURLJavaScriptPython

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>

Get QR code product list

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/qrCode/product-list

Retrieve a paginated list of products linked with QR codes.

Query parameters

limitintegerOptional

Number of records to retrieve

Default: 10

offsetintegerOptional

Number of records to skip

Default: 0

countintegerOptional

Flag to indicate if the count should be returned (1 for true, 0 for false)

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved QR code product list

application/xmlapplication/json

400

Invalid query parameters

500

Internal server error

get

/qrCode/product-list

HTTPcURLJavaScriptPython

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>

Get website settings

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/settings

Retrieve website settings based on query parameters.

Query parameters

defaultWebsiteintegerOptional

Specify whether to retrieve the default website settings (1 for true, 0 for false).

Default: 1

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved website settings

application/xmlapplication/json

400

Invalid query parameters

500

Internal server error

get

/settings

HTTPcURLJavaScriptPython

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 code for products

post

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/qrCode/created-qrcode

Generate QR codes based on the provided product data.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

application/x-www-form-urlencoded

Responses

200

Successfully generated the product QR code

application/xmlapplication/json

400

Invalid request data

500

Internal server error

post

/qrCode/created-qrcode

HTTPcURLJavaScriptPython

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>

Download QR code image

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/qrCode/download-qrimage/{productId}

Retrieve the QR code image for a given product ID.

Path parameters

productIdintegerRequired

The ID of the product whose QR code image needs to be downloaded

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved QR code image

image/pngapplication/xmlapplication/json

Responsestring · binary

400

Invalid product ID

404

QR code not found for the given product ID

500

Internal server error

get

/qrCode/download-qrimage/{productId}

HTTPcURLJavaScriptPython

GET /backend/api/qrCode/download-qrimage/{productId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

binary

Get attribute list

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/attribute

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

application/xmlapplication/json

get

/attribute

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/attribute/

This endpoint creates a new attribute with specified properties.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

application/x-www-form-urlencoded

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

application/xmlapplication/json

post

/attribute/

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/attribute-group/

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

application/xmlapplication/json

get

/attribute-group/

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/attribute-group/

Creates a new attribute group with the specified details.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

application/x-www-form-urlencoded

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

application/xmlapplication/json

post

/attribute-group/

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/attribute-group/{id}

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

application/xmlapplication/json

400

Invalid ID supplied

404

Attribute group not found

get

/attribute-group/{id}

HTTPcURLJavaScriptPython

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>

Delete attribute group by ID

delete

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/attribute-group/{id}

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

application/xmlapplication/json

400

Invalid ID supplied

404

Attribute group not found

delete

/attribute-group/{id}

HTTPcURLJavaScriptPython

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 list of specifications

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/specification/

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

application/xmlapplication/json

400

Invalid query parameters

get

/specification/

HTTPcURLJavaScriptPython

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>

Create translation for an attribute group by ID

post

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/attribute-group-translation/attribute-group/{id}

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[]

application/x-www-form-urlencoded

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

application/xmlapplication/json

400

Invalid ID or request body

404

Attribute group not found

post

/attribute-group-translation/attribute-group/{id}

HTTPcURLJavaScriptPython

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 translations for an attribute group by ID

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/attribute-group-translation/attribute-group/{id}

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

application/xmlapplication/json

400

Invalid ID supplied

404

Attribute group translation not found

get

/attribute-group-translation/attribute-group/{id}

HTTPcURLJavaScriptPython

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>

Update attribute group by ID

put

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/attribute-group/{id}

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

application/x-www-form-urlencoded

namestringRequiredExample: Updated Group Name

sortOrderintegerRequiredExample: 1

attributeIdsinteger[]RequiredExample: [106,107]

Responses

200

Successfully updated the attribute group

application/xmlapplication/json

400

Invalid ID supplied

404

Attribute group not found

put

/attribute-group/{id}

HTTPcURLJavaScriptPython

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>

Get list of specifications

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/specification

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

application/xmlapplication/json

400

Invalid parameters or request

get

/specification

HTTPcURLJavaScriptPython

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>

Get list of attribute groups

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/attribute-group

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

application/xmlapplication/json

400

Invalid query parameters

get

/attribute-group

HTTPcURLJavaScriptPython

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>

Create a new specification

post

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/specification

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

application/x-www-form-urlencoded

namestringOptionalExample: tests

statusintegerOptionalExample: 1

attributeGroupIdinteger[]OptionalExample: 101

Responses

200

Successfully created the specification

application/xmlapplication/json

400

Invalid input or missing required fields

post

/specification

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/specification/{id}

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

application/xmlapplication/json

404

Specification not found

get

/specification/{id}

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/specification/{id}

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

application/x-www-form-urlencoded

namestringRequiredExample: tests

statusintegerRequiredExample: 1

attributeGroupIdinteger[]Optional

deleteAttributeGroupIdsinteger[]Optional

idstringOptionalExample: 52

Responses

200

Successfully updated the specification

application/xmlapplication/json

404

Specification not found

put

/specification/{id}

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/specification/{id}

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

application/xmlapplication/json

404

Specification not found

delete

/specification/{id}

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/specification-translation/specification/{id}

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

application/xmlapplication/json

404

Specification translation not found

get

/specification-translation/specification/{id}

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/specification-translation/specification/{id}

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

application/x-www-form-urlencoded

Details of the new specification translation

languagestringOptionalExample: en

translationstringOptionalExample: This is the translated specification

Responses

200

Successfully created new specification translation

application/xmlapplication/json

400

Bad request, invalid data

post

/specification-translation/specification/{id}

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/specification/category

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

application/xmlapplication/json

400

Invalid parameters or request

get

/specification/category

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/specification/category

This endpoint updates the specifications assigned to a category.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Bodyobject[]

application/x-www-form-urlencoded

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

application/xmlapplication/json

400

Invalid request parameters

put

/specification/category

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/site-filter/site-filter-list

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

application/xmlapplication/json

400

Invalid query parameters

get

/site-filter/site-filter-list

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/site-filter/create-site-filter

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

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

application/x-www-form-urlencoded

filterNamestringOptional

The name of the filter

categoryIdinteger[]Optional

A list of category IDs associated with the filter

Responses

200

Successfully created the site filter

application/xmlapplication/json

400

Invalid input data

post

/site-filter/create-site-filter

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/site-filter/filter-detail/{id}

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

application/xmlapplication/json

400

Invalid ID supplied

404

Filter not found

get

/site-filter/filter-detail/{id}

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/site-filter/update-site-filter/{id}

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

application/x-www-form-urlencoded

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

application/xmlapplication/json

400

Invalid input

404

Site filter not found

put

/site-filter/update-site-filter/{id}

HTTPcURLJavaScriptPython

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

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/site-filter/delete-site-filter/{id}

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

application/xmlapplication/json

404

Site filter not found

delete

/site-filter/delete-site-filter/{id}

HTTPcURLJavaScriptPython

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>

Get Family List API

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/api/family

This API retrieves a list of families with optional filtering and pagination.

Query parameters

limitnumberOptional

Number of records to return.

offsetnumberOptional

Number of records to skip.

keywordstringOptional

Keyword to filter families by name.

countnumberOptional

If set to 1, returns only the count.

Responses

200

Successfully got family list.

*/*

500

Failed to fetch family list.

*/*

get

/api/family

HTTPcURLJavaScriptPython

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
    }
  ]
}

Add Family API

post

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/api/family

This API allows users to add a new family.

Bodynumber[]

*/*

number[]Optional

Responses

200

Family created successfully.

*/*

500

Failed to create family

*/*

post

/api/family

HTTPcURLJavaScriptPython

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."
}

Get Category List Family API

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/api/family/category

This API retrieves a list of family categories based on the provided query parameters.

Query parameters

limitnumberOptional

Limit the number of records.

offsetnumberOptional

Offset for pagination.

statusnumberOptional

Filter categories by status.

countnumberOptional

If set to 1, returns only the count.

keywordstringOptional

Search categories by keyword.

familyNamestringOptional

Filter categories by family name.

sortOrdernumberOptional

Sort order for the categories.

Responses

200

Successfully Got family Category List.

*/*

500

Failed to fetch family category list.

*/*

get

/api/family/category

HTTPcURLJavaScriptPython

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
        }
      ]
    }
  ]
}

Get Family Detail API

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/api/family/{id}

This API retrieves the details of a specific family based on the provided family ID.

Path parameters

idnumberRequired

ID of the family to retrieve details for.

Responses

200

Successfully got family detail.

*/*

500

Failed to fetch family detail.

*/*

get

/api/family/{id}

HTTPcURLJavaScriptPython

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
    }
  ]
}

Update Family API

put

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/api/family/{id}

This API allows users to update an existing family by ID.

Path parameters

idnumberRequired

Family ID to update.

Body

*/*

anyOptional

Responses

200

Family updated successfully.

*/*

500

Failed to update family.

*/*

put

/api/family/{id}

HTTPcURLJavaScriptPython

PUT /backend/api/api/family/{id} HTTP/1.1
Host: 139.59.67.17
Content-Type: */*
Accept: */*

{
  "status": 1,
  "message": "Family updated successfully."
}

Delete Family API

delete

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/api/family/{id}

This API allows users to delete a family by ID.

Path parameters

idnumberRequired

Family ID to delete.

Responses

200

Successfully deleted family.

*/*

500

Failed to delete family

*/*

delete

/api/family/{id}

HTTPcURLJavaScriptPython

DELETE /backend/api/api/family/{id} HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted family."
}