Settings
Successfully got settings
1Successfully got settingsGET /backend/api/settings HTTP/1.1
Host: 139.59.67.17
Accept: */*
Successfully got settings
{
"status": 1,
"message": "Successfully got settings"
}Bearer token for authentication.
Settings Updated Successfully
Invalid input
Internal Server Error
POST /backend/api/settings HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 794
{
"metaTagTitle": "text",
"metaTagDescription": "text",
"metaTagKeywords": "text",
"businessName": "text",
"siteUrl": "text",
"storeOwner": "text",
"storeAddress1": "text",
"storeAddress2": "text",
"storeDescription": "text",
"storeEmail": "text",
"storeTelephone": "text",
"storeCity": "text",
"storePostalCode": "text",
"siteCategory": "text",
"maintenanceMode": 1,
"storeLanguageName": "text",
"storeSecondaryLanguageName": "text",
"storeCurrencyId": 1,
"timeZone": "text",
"twitter": "text",
"linkedIn": "text",
"instagram": "text",
"youtube": "text",
"facebook": "text",
"status": 1,
"invoicePrefix": "text",
"orderStatus": 1,
"categoryProductCount": 1,
"itemsPerPage": 1,
"settingId": 1,
"accessKey": "text",
"siteName": "text",
"timeFormat": "text",
"currencySymbol": "text",
"defaultCountry": 1,
"zoneId": 1,
"countryId": 1,
"country": "text",
"defaultWebsite": 1
}No content
Limit of records
0Offset for pagination
0Search keyword
Flag to get count (0 or 1)
0Filter by status
1Bearer token for authentication.
Successfully got all country list
1Successfully get all country ListGET /backend/api/country HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully got all country list
{
"status": 1,
"message": "Successfully get all country List"
}Bearer token for authentication.
The name of the country
The 2-letter ISO code for the country
The 3-letter ISO code for the country
Indicates whether a postcode is required (1 for true, 0 for false)
The status of the country (e.g., 0 for inactive, 1 for active)
The country ID (set to 0 for new country)
Successfully added the new country
Invalid input
POST /backend/api/country HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 107
{
"name": "text",
"isoCode2": "text",
"isoCode3": "text",
"postcodeRequired": 1,
"status": "text",
"countryId": "text"
}{
"status": 1,
"message": "text"
}Bearer token for authentication.
Successfully got all zone list
1Successfully get all zone listGET /backend/api/list/zone HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully got all zone list
{
"status": 1,
"message": "Successfully get all zone list"
}ID of the setting to fetch
Bearer token for authentication.
Successfully fetched the settings
1Successfully get settingsGET /backend/api/settings/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully fetched the settings
{
"status": 1,
"message": "Successfully get settings"
}Limit the number of results
Offset for pagination
Search keyword to filter the currencies
Count flag (should be 0 or true/false)
Filter currencies by status (1 for active)
Bearer token for authentication.
Successfully retrieved the currency list
1Successfully got the complete currency listGET /backend/api/currency HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved the currency list
{
"status": 1,
"message": "Successfully got the complete currency list"
}Adds a new currency to the system.
Bearer token for authentication.
testsdfsnull01Successfully added a new currency
1Successfully added new currencyBad request, invalid input
POST /backend/api/currency HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 90
{
"title": "test",
"code": "sdf",
"symbolLeft": "s",
"symbolRight": "null",
"value": 0,
"status": "1"
}{
"status": 1,
"message": "Successfully added new currency"
}Limit the number of results
Offset for pagination
Count flag (should be 0 or true/false)
Search keyword to filter the languages
Filter languages by status (1 for active)
Filter by default language
Bearer token for authentication.
Successfully retrieved the language list
1Successfully got all language ListGET /backend/api/language HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved the language list
{
"status": 1,
"message": "Successfully got all language List"
}Limit the number of results
Offset for pagination
Search keyword to filter the categories
Sort order (0 for ascending, 1 for descending)
Filter categories by status (1 for active)
Filter categories by name
Filter categories by industry ID
Bearer token for authentication.
Successfully retrieved the category list
GET /backend/api/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved the category list
{
"status": 1,
"message": "text"
}The ID of the country to update
Bearer token for authentication.
The name of the country
The 2-letter ISO code for the country
The 3-letter ISO code for the country
Indicates whether a postcode is required (1 for true, 0 for false)
The status of the country (e.g., 0 for inactive, 1 for active)
The country ID being updated
Successfully updated the country
Invalid input
Country not found
PUT /backend/api/country/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 107
{
"name": "text",
"isoCode2": "text",
"isoCode3": "text",
"postcodeRequired": 1,
"status": "text",
"countryId": "text"
}{
"status": 1,
"message": "text"
}The ID of the country to delete
Bearer token for authentication.
Successfully deleted the country
Country not found
DELETE /backend/api/country/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "text"
}The ID of the language to update
Bearer token for authentication.
The language code
The language name
The image associated with the language
The sort order of the language
The status of the language
The unique ID of the language to update
Successfully updated the language
Invalid language ID or data
Language not found
PUT /backend/api/language/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 89
{
"code": "text",
"name": "text",
"image": "text",
"sortOrder": 1,
"status": "text",
"languageId": 1
}{
"status": 1,
"message": "text"
}The ID of the language to be deleted
Bearer token for authentication.
Successfully deleted the language
Status code
Success message
Invalid ID provided
Language not found
DELETE /backend/api/language/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "text"
}Bearer token for authentication.
The language code
The language name
The image associated with the language (optional)
The sort order of the language
The status of the language
Successfully added a new language
Invalid input data
Not Found
POST /backend/api/language/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 74
{
"code": "text",
"name": "text",
"image": "text",
"sortOrder": 1,
"status": "text"
}{
"status": 1,
"message": "text"
}The number of zones to retrieve. Defaults to 10.
The offset for pagination. Defaults to 0.
A keyword to search zones.
If true, will return a count of zones instead of the zone list.
The status of the zones (1 for active, 0 for inactive).
Bearer token for authentication.
Successfully retrieved all zone list
Status code
Success message
Invalid query parameters
GET /backend/api/zone HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "text"
}Bearer token for authentication.
The country ID to which the zone belongs.
The unique code for the zone.
The name of the zone.
The status of the zone (1 for active, 0 for inactive).
Successfully created a new zone
Status code
Success message
Invalid input data
POST /backend/api/zone HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 54
{
"countryId": 1,
"code": "text",
"name": "text",
"status": 1
}{
"status": 1,
"message": "text"
}Updates a zone with the provided details.
ID of the zone to update
Bearer token for authentication.
4dftest1110Successfully updated the zone
1Successfully updated the zoneBad request
PUT /backend/api/zone/{zoneId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 67
{
"countryId": 4,
"code": "df",
"name": "test",
"status": "1",
"zoneId": 110
}{
"status": 1,
"message": "Successfully updated the zone"
}Deletes a zone identified by its ID.
ID of the zone to delete
Bearer token for authentication.
Successfully deleted the zone
1Successfully deleted the ZoneBad request
DELETE /backend/api/zone/{zoneId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully deleted the Zone"
}Updates an existing currency with the provided details.
ID of the currency to update
Bearer token for authentication.
testsdfsnull01Successfully updated the currency
1Successfully updated the currencyBad request, invalid input
Currency not found
PUT /backend/api/currency/{currencyId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 90
{
"title": "test",
"code": "sdf",
"symbolLeft": "s",
"symbolRight": "null",
"value": 0,
"status": "1"
}{
"status": 1,
"message": "Successfully updated the currency"
}Deletes an existing currency by ID.
ID of the currency to delete
Bearer token for authentication.
Successfully deleted the currency
1Successfully deleted the currencyBad request, invalid input
Currency not found
DELETE /backend/api/currency/{currencyId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully deleted the currency"
}Retrieves a list of taxes based on the given filters.
The maximum number of items to return
10The offset for pagination
0Search keyword for filtering tax list
If true, returns only the count of taxes, not the actual list
falseFilter by status (e.g., active/inactive)
Bearer token for authentication.
Successfully retrieved the list of taxes
1Successfully get all tax listBad request, invalid input
GET /backend/api/tax/tax-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully get all tax list"
}Creates a new tax record with the provided details.
Bearer token for authentication.
test441Successfully created the new tax
1Successfully created new taxBad request, invalid input
POST /backend/api/tax/add-tax HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 55
{
"taxName": "test",
"taxPercentage": "44",
"taxStatus": "1"
}{
"status": 1,
"message": "Successfully created new tax"
}Updates the tax with the provided ID and new details.
The ID of the tax to update
Bearer token for authentication.
test441Successfully updated the tax
1Successfully updated the taxBad request, invalid input
PUT /backend/api/tax/update-tax/{taxId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 53
{
"taxName": "test",
"taxPercentage": 44,
"taxStatus": "1"
}{
"status": 1,
"message": "Successfully updated the tax"
}Deletes a tax by ID.
The ID of the tax to delete
Bearer token for authentication.
Successfully deleted the tax
1Successfully deleted the taxTax not found
DELETE /backend/api/tax/delete-tax/{taxId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully deleted the tax"
}Fetches a list of all roles with optional pagination and filtering.
The number of results to return per page.
10The number of records to skip before starting to return results.
0Indicates whether to count the total number of records available.
falseBearer token for authentication.
Successfully fetched the role list
1Successfully get all role listGET /backend/api/role/rolelist HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully fetched the role list
{
"status": 1,
"message": "Successfully get all role list"
}Creates a new role with a name and status.
Bearer token for authentication.
testtrueSuccessfully created a new role
1Successfully created a new roleRole already exists
POST /backend/api/role/create-role HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 29
{
"name": "test",
"status": true
}{
"status": 1,
"message": "Successfully created a new role"
}Updates the role details (name and status) for a given roleId.
ID of the role to update
Bearer token for authentication.
testtttt130Role updated successfully
1Role updated successfullyPUT /backend/api/role/update-role/{roleId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 38
{
"name": "testtttt",
"status": 1,
"id": 30
}Role updated successfully
{
"status": 1,
"message": "Role updated successfully"
}Retrieves a list of permission modules with pagination and filtering options.
The number of permission modules to retrieve per request
The offset to retrieve the list from
Search keyword to filter the permission modules
Flag to include count in the response
Filter permission modules by status
Bearer token for authentication.
Successfully retrieved the list of permission modules
1Successfully got the complete list of pagesGET /backend/api/permission-module/list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved the list of permission modules
{
"status": 1,
"message": "Successfully got the complete list of pages"
}Retrieves a list of permissions for a specific reference type and ID.
The reference type (e.g., 1 for a specific object)
The reference ID to fetch permissions for
Bearer token for authentication.
Successfully retrieved the permission list
1Successfully got permission listGET /backend/api/permission-module/get-permission?refType=1&refId=1 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved the permission list
{
"status": 1,
"message": "Successfully got permission list"
}Adds a list of permissions for a specific reference type and ID.
Bearer token for authentication.
1["list-order"]30Successfully updated the permissions
1Successfully updated the permissionPOST /backend/api/permission-module/add-permission HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 52
{
"refType": 1,
"permission": [
"list-order"
],
"refId": 30
}Successfully updated the permissions
{
"status": 1,
"message": "Successfully updated the permission"
}Deletes the role identified by the provided role ID.
ID of the role to delete
Bearer token for authentication.
Successfully deleted the role
1Successfully deleted the roleDELETE /backend/api/role/delete-role/{roleId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully deleted the role
{
"status": 1,
"message": "Successfully deleted the role"
}Retrieves a list of users based on the provided parameters like limit, offset, and status.
Limit of users per request
10Offset to start fetching the list
0Whether to count the total number of users
falseFilter users based on their status
Bearer token for authentication.
Successfully retrieved the user list
1Successfully got all user listGET /backend/api/auth/userlist HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved the user list
{
"status": 1,
"message": "Successfully got all user list"
}Creates a new user in the system with the provided user details.
Bearer token for authentication.
The user's first name
The user's last name
The user's email address
The ID of the user's group
The user's username
The user's password
Successfully created the user
1User created successfullyBad Request - User already exists
POST /backend/api/auth/create-user HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 115
{
"firstName": "text",
"lastName": "text",
"email": "name@gmail.com",
"userGroupId": 1,
"username": "text",
"password": "text"
}{
"status": 1,
"message": "User created successfully"
}Updates an existing user in the system with the provided user details.
ID of the user to be updated
Bearer token for authentication.
The user's first name
The user's last name
The user's email address
The ID of the user's group
The user's username
The user's password (hashed)
The ID of the user being updated
Successfully updated the user
1User updated successfullyBad Request - Invalid user data
PUT /backend/api/auth/update-user/{userId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 122
{
"firstName": "text",
"lastName": "text",
"email": "name@gmail.com",
"userGroupId": 1,
"username": "text",
"password": "text",
"id": 1
}{
"status": 1,
"message": "User updated successfully"
}Deletes an existing user by user ID.
ID of the user to be deleted
Bearer token for authentication.
Successfully deleted the user
1User deleted successfullyBad Request - Invalid user ID
DELETE /backend/api/auth/delete-user/{userId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "User deleted successfully"
}This endpoint is used to enable or disable the maintenance mode.
Bearer token for authentication.
Set mode: 0 to disable maintenance mode, 1 to enable maintenance mode.
0The ID of the setting to update
2Successfully updated the maintenance mode
1Maintainance mode updated successfullyBad Request - Invalid input parameters
PUT /backend/api/settings/maintainance HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 17
{
"mode": 0,
"id": 2
}{
"status": 1,
"message": "Maintainance mode updated successfully"
}This endpoint is used to retrieve a list of audit logs with pagination and optional filters.
The number of items to skip (used for pagination)
0The number of items to return (used for pagination)
20Keyword to filter the results by
Filter the audit logs by the module
Filter the audit logs by the user who performed the action
Bearer token for authentication.
Successfully retrieved audit log list
1Successfully got a audit log listBad Request - Invalid input parameters
GET /backend/api/auditlog/auditLog-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got a audit log list"
}This endpoint is used to retrieve a list of modules involved in audit logs.
Bearer token for authentication.
Successfully retrieved module log list
1Successfully got a module log listBad Request - Invalid request or input
GET /backend/api/auditlog/module-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got a module log list"
}This endpoint allows the deletion of audit logs between the given fromDate and toDate.
Bearer token for authentication.
The starting date for the range of audit logs to delete
2024-1-1The ending date for the range of audit logs to delete
2024-1-1Successfully deleted the audit logs within the specified date range
1Successfully deleted audit logsBad Request - Invalid input or date format
POST /backend/api/auditlog/delete-auditlog HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 43
{
"fromDate": "2024-1-1",
"toDate": "2024-1-1"
}{
"status": 1,
"message": "Successfully deleted audit logs"
}This endpoint retrieves a list of order statuses based on the provided filters like status and keyword.
Filter by status. If not provided, fetches all statuses.
Filter by a keyword to search order statuses.
Bearer token for authentication.
Successfully retrieved the order status list
The status of the request, 1 for success
A message providing details about the status of the request
Bad Request - Invalid parameters
GET /backend/api/order-status/order-status-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "text"
}This endpoint retrieves a list of email templates based on the provided filters like limit, offset, keyword, and count.
Limit the number of email templates returned.
Offset to start fetching the email templates.
Filter by keyword to search email templates.
If set to 1, it will return the count of email templates.
Bearer token for authentication.
Successfully retrieved the email template list
The status of the request, 1 for success
A message providing details about the request
Bad Request - Invalid parameters
GET /backend/api/email-template/email-templatelist HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "text"
}This endpoint allows updating an existing email template based on the provided template Id.
The unique identifier of the email template to be updated
Bearer token for authentication.
The title of the email template
The subject of the email template
The content/body of the email template
The status of the email template (1 for active, 0 for inactive)
The dynamic fields reference for the email template
Successfully updated the email template
The status of the request, 1 for success
A message providing details about the request
Bad Request - Invalid parameters
PUT /backend/api/email-template/update-email-template/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 87
{
"title": "text",
"subject": "text",
"content": "text",
"status": 1,
"dynamicFieldsRef": "text"
}{
"status": 1,
"message": "text"
}This endpoint retrieves the complete list of order fulfillment statuses.
Number of records to return in a single response
Offset from which to start the records (for pagination)
Bearer token for authentication.
Successfully retrieved the order fulfillment status list
The status of the operation
The response message
Invalid query parameter
GET /backend/api/order-status/order-fullfillment-status-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got the complete Order full-fillment status list"
}This endpoint creates a new order status with the given details.
Bearer token for authentication.
Indicates if the order status is related to fulfillment
Name of the order status
Hexadecimal color code for the order status
Priority level of the order status
Status of the order (1 for active, 0 for inactive)
Indicates if the order status is for admin
Indicates if the order status is for vendor
Indicates if the order status is for buyer
Indicates if the order status is related to API
Successfully created a new order status
Invalid input data
POST /backend/api/order-status/create-order-status HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 129
{
"isFullfillment": 1,
"name": "test",
"colorCode": "#2e1515",
"priority": "4",
"status": 1,
"isAdmin": 1,
"isVendor": 0,
"isBuyer": 0,
"isApi": 0
}{
"status": 1,
"message": "Successfully created a new order status"
}This endpoint updates an existing order status with the provided details.
ID of the order status to be updated
Bearer token for authentication.
Indicates if the order status is related to fulfillment
Name of the order status
Hexadecimal color code for the order status
Priority level of the order status
Status of the order (1 for active, 0 for inactive)
ID of the parent order status
Indicates if the order status is for admin
Indicates if the order status is for vendor
Indicates if the order status is for buyer
Indicates if the order status is related to API
ID of the order status
Successfully updated the order status
Invalid input data
PUT /backend/api/order-status/update-order-status/{orderStatusId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 159
{
"isFullfillment": 1,
"name": "test",
"colorCode": "#2e1515",
"priority": 4,
"status": 1,
"parentId": 0,
"isAdmin": 1,
"isVendor": 0,
"isBuyer": 0,
"isApi": 0,
"orderStatusId": 54
}{
"status": 1,
"message": "Successfully updated the order status"
}Update the order fulfillment status
This endpoint updates the order fulfillment status for a specific order status ID.
ID of the order status whose fulfillment status is to be updated
Bearer token for authentication.
The order fulfillment status (1 for active, 0 for inactive)
Successfully updated the order fulfillment status
Invalid input data
PUT /backend/api/order-status/update-order-fullfillment-status/{orderStatusId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 12
{
"status": 0
}{
"status": 1,
"message": "Successfully updated order fulfillment status"
}This endpoint deletes the order status for a given order status ID.
ID of the order status to be deleted
Bearer token for authentication.
Successfully deleted the order status
Order status not found
DELETE /backend/api/order-status/{orderStatusId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully deleted the order status"
}This endpoint retrieves a complete list of order fulfillment statuses.
Limit the number of results
Offset for pagination
Filter by fulfillment status
Bearer token for authentication.
Successfully retrieved the order fulfillment status list
GET /backend/api/order-status/fullfillment HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved the order fulfillment status list
{
"status": 1,
"message": "Successfully got the complete Order full-fillment status list"
}This endpoint assigns multiple order statuses to fulfillment statuses.
Bearer token for authentication.
Successfully updated order statuses with fulfillment status assignments
PUT /backend/api/order-status/fullfillment HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 49
[
{
"orderStatusId": 1,
"fullfillmentStatusIds": [
1
]
}
]Successfully updated order statuses with fulfillment status assignments
{
"status": 1,
"message": "Successfully updated order status"
}This endpoint creates a new order fulfillment status.
Bearer token for authentication.
1test#9c2a2a51Successfully created order fulfillment status
POST /backend/api/order-status/fullfillment HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 80
{
"isFullfillment": 1,
"name": "test",
"colorCode": "#9c2a2a",
"priority": 5,
"status": 1
}Successfully created order fulfillment status
{
"status": 1,
"message": "Successfully created full-fillment status"
}This endpoint updates the status of an existing order fulfillment.
The ID of the order fulfillment status to be updated.
Bearer token for authentication.
Successfully updated the order fulfillment status
PUT /backend/api/order-status/fullfillment/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 20
{
"id": 23,
"status": 0
}Successfully updated the order fulfillment status
{
"status": 1,
"message": "Successfully updated the order status"
}This endpoint deletes an existing order fulfillment status.
The ID of the order fulfillment status to be deleted.
Bearer token for authentication.
Successfully deleted the order fulfillment status
DELETE /backend/api/order-status/fullfillment/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully deleted the order fulfillment status
{
"status": 1,
"message": "Successfully deleted the order status"
}This endpoint retrieves the list of available plugins.
Successfully retrieved the plugin list
No plugins found
GET /backend/api/plugins/ HTTP/1.1
Host: 139.59.67.17
Accept: */*
{
"status": 1,
"message": "Successfully got the plugin list"
}This endpoint retrieves the details of a specific plugin by its ID.
The ID of the plugin.
Optional query parameter for the plugin ID.
Bearer token for authentication.
Successfully retrieved the plugin details
Plugin not found
GET /backend/api/plugins/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got the plugin detail"
}This endpoint updates the status of a specific plugin.
The ID of the plugin to be updated.
Bearer token for authentication.
0Successfully updated the plugin status
Plugin not found
PUT /backend/api/plugins/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 20
{
"pluginStatus": "0"
}{
"status": 1,
"message": "Successfully updated the plugin status"
}This endpoint updates PayPal settings, including client credentials and test mode.
Bearer token for authentication.
The client ID for PayPal API.
The client secret for PayPal API.
Flag to indicate if PayPal is in test mode.
Successfully updated the PayPal payment settings
Invalid request, missing required parameters
POST /backend/api/paypal-payment HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 55
{
"clientId": "text",
"clientSecret": "text",
"isTest": true
}{
"status": 1,
"message": "Paypal settings updated successfully"
}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
{
"status": 1,
"message": "Successfully got the attribute list"
}This endpoint creates a new attribute with specified properties.
Bearer token for authentication.
testshort-text011testtesttest1Attribute added successfully
1Attribute added successfully.POST /backend/api/attribute/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/json
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
}Attribute added successfully
{
"status": 1,
"message": "Attribute added successfully."
}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
1Successfully got 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
{
"status": 1,
"message": "Successfully got the attribute group list."
}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
1Successfully added Attribute GroupPOST /backend/api/attribute-group/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"name": "testg",
"sortOrder": 1,
"attributeIds": [
106
]
}Successfully created the attribute group
{
"status": 1,
"message": "Successfully added Attribute Group"
}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: */*
{
"status": 1,
"message": "Successfully Got attribute group"
}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/json
Accept: */*
Content-Length: 68
{
"name": "Updated Group Name",
"sortOrder": 1,
"attributeIds": [
106,
107
]
}{
"status": 1,
"message": "Successfully updated Attribute Group"
}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: */*
{
"status": 1,
"message": "text"
}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: */*
{
"status": 1,
"message": "text"
}Create translation for an attribute group by ID
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: */*
Accept: */*
Content-Length: 76
[
{
"language": "text",
"translatedName": "text",
"translatedDescription": "text"
}
]{
"status": 1,
"message": "text"
}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: */*
{
"status": 1,
"message": "text"
}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: */*
{
"status": 1,
"message": "text"
}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
1Successfully got Specification List.Invalid parameters or request
GET /backend/api/specification HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got Specification List."
}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: */*
Accept: */*
Content-Length: 116
{
"name": "tests",
"status": 1,
"attributeGroup": [
{
"attributeGroupId": 36,
"attributeIds": [
102
]
}
],
"attributeGroupId": [
101
]
}{
"status": 1,
"message": "text"
}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
1Successfully Got Specification.Specification not found
GET /backend/api/specification/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully Got Specification."
}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
1Successfully Update Specification.Specification not found
PUT /backend/api/specification/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 154
{
"name": "tests",
"status": 1,
"attributeGroup": [
{
"attributeGroupId": 36,
"attributeIds": [
102
]
}
],
"attributeGroupId": [
1
],
"deleteAttributeGroupIds": [
1
],
"id": "52"
}{
"status": 1,
"message": "Successfully Update Specification."
}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
1Successfully deleted Specification..!Specification not found
DELETE /backend/api/specification/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully deleted Specification..!"
}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
1Successfully got specification translation detailSpecification translation not found
GET /backend/api/specification-translation/specification/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got specification translation detail"
}Create new specification translation for the given specification ID
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
1Successfully created new specification translationBad request, invalid data
POST /backend/api/specification-translation/specification/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 70
{
"language": "en",
"translation": "This is the translated specification"
}{
"status": 1,
"message": "Successfully created new specification translation"
}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
1Successfully Got Specification Category List.Invalid parameters or request
GET /backend/api/specification/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully Got Specification Category List."
}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
1Successfully Updated Specification To Category.Invalid request parameters
PUT /backend/api/specification/category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 74
[
{
"categoryId": 1424,
"specificationIds": [
51
],
"deleteSpecificationIds": [
1
]
}
]{
"status": 1,
"message": "Successfully Updated Specification To Category."
}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
1Successfully got filter listInvalid query parameters
GET /backend/api/site-filter/site-filter-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got filter list"
}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
1Successfully created a new FilterInvalid input data
POST /backend/api/site-filter/create-site-filter HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 112
{
"filterName": "text",
"categoryId": [
1
],
"section": [
{
"sectionType": 1,
"sectionItem": [
"text"
],
"sectionName": "text"
}
]
}{
"status": 1,
"message": "Successfully created a new Filter"
}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
1Successfully got filter detailInvalid ID supplied
Filter not found
GET /backend/api/site-filter/filter-detail/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully got filter detail"
}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
1Successfully updated the site filterInvalid 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: */*
Accept: */*
Content-Length: 142
{
"filterName": "text",
"categoryId": [
1
],
"section": [
{
"sectionType": 1,
"sectionItem": [
"text"
],
"sectionName": "text",
"sectionId": 1
}
],
"editId": "text"
}{
"status": 1,
"message": "Successfully updated the site filter"
}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
1Successfully deleted the filterSite filter not found
DELETE /backend/api/site-filter/delete-site-filter/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
{
"status": 1,
"message": "Successfully deleted the filter"
}Last updated