Ctrlk
DocumentAPI ReferenceAdd-ons
For the complete documentation index, see llms.txt. This page is also available as Markdown.
ChatGPT

settings

get settings

get
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully get settings
get/settings/get-settings
GET /settings/get-settings HTTP/1.1
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully get settings"
}

Create Settings

post
Header parameters
AuthorizationstringRequired
Body
urlstringOptional
metaTagTitlestringOptional
metaTagDescriptionstringOptional
metaTagKeywordsstringOptional
storeNamestringOptional
storeOwnerstringOptional
storeAddressstringOptional
zoneIdstringOptional
countryIdinteger · int32Optional
storeEmailstringOptional
storeTelephonestringOptional
storeFaxstringOptional
storeLogostringOptional
emailLogostringOptional
invoiceLogostringOptional
maintenanceModeinteger · int32Optional
storeLanguageNameinteger · int32Optional
storeCurrencyIdinteger · int32Optional
storeImagestringOptional
googlestringOptional
twitterstringOptional
instagramstringOptional
facebookstringOptional
statusinteger · int32Optional
invoicePrefixstringOptional
orderStatusinteger · int32Optional
categoryProductCountinteger · int32Optional
itemsPerPageinteger · int32Optional
Responses
200

success response

application/json
createdByinteger · int32Optional
createdDatestring · date-timeOptional
modifiedByinteger · int32Optional
modifiedDatestring · date-timeOptional
settingsIdinteger · int32Optional
urlstringOptional
storeNamestringOptional
storeOwnerstringOptional
storeAddressstringOptional
countryIdinteger · int32Optional
zoneIdstringOptional
storeEmailstringOptional
storeTelephonestringOptional
storeLogoPathstringOptional
emailLogostringOptional
emailLogoPathstringOptional
invoiceLogostringOptional
invoiceLogoPathstringOptional
maintenanceModeinteger · int32Optional
storeLanguageNamestringOptional
storeCurrencyIdinteger · int32Optional
storeImagePathstringOptional
addonsstringOptional
post/settings/create-settings
POST /settings/create-settings HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 545

"url='text'&metaTagTitle='text'&metaTagDescription='text'&metaTagKeywords='text'&storeName='text'&storeOwner='text'&storeAddress='text'&zoneId='text'&countryId=1&storeEmail='text'&storeTelephone='text'&storeFax='text'&storeLogo='text'&emailLogo='text'&invoiceLogo='text'&maintenanceMode=1&storeLanguageName=1&storeCurrencyId=1&storeImage='text'&google='text'&twitter='text'&instagram='text'&facebook='text'&status=1&invoicePrefix='text'&orderStatus=1&categoryProductCount=1&itemsPerPage=1"
{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "settingsId": 1,
  "url": "text",
  "storeName": "text",
  "storeOwner": "text",
  "storeAddress": "text",
  "countryId": 1,
  "zoneId": "text",
  "storeEmail": "text",
  "storeTelephone": "text",
  "storeLogoPath": "text",
  "emailLogo": "text",
  "emailLogoPath": "text",
  "invoiceLogo": "text",
  "invoiceLogoPath": "text",
  "maintenanceMode": 1,
  "storeLanguageName": "text",
  "storeCurrencyId": 1,
  "storeImagePath": "text",
  "addons": "text"
}

update maintainance mode

put
Query parameters
modeintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
createdByinteger · int32Optional
createdDatestring · date-timeOptional
modifiedByinteger · int32Optional
modifiedDatestring · date-timeOptional
settingsIdinteger · int32Optional
urlstringOptional
metaTagTitlestringOptional
metaTagDescriptionstringOptional
metaTagKeywordstringOptional
storeNamestringOptional
storeOwnerstringOptional
storeAddressstringOptional
countryIdinteger · int32Optional
zoneIdstringOptional
orderStatusinteger · int32Optional
storeEmailstringOptional
storeTelephonestringOptional
storeFaxstringOptional
storeLogostringOptional
storeLogoPathstringOptional
emailLogostringOptional
emailLogoPathstringOptional
invoiceLogostringOptional
invoiceLogoPathstringOptional
maintenanceModeinteger · int32Optional
storeLanguageNamestringOptional
storeCurrencyIdinteger · int32Optional
storeImagestringOptional
storeImagePathstringOptional
facebookstringOptional
googlestringOptional
twitterstringOptional
instagramstringOptional
invoicePrefixstringOptional
categoryProductCountinteger · int32Optional
itemsPerPageinteger · int32Optional
isActiveinteger · int32Optional
addonsstringOptional
put/settings/update-maintainancemode
PUT /settings/update-maintainancemode HTTP/1.1
Authorization: text
Accept: */*

{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "settingsId": 1,
  "url": "text",
  "metaTagTitle": "text",
  "metaTagDescription": "text",
  "metaTagKeyword": "text",
  "storeName": "text",
  "storeOwner": "text",
  "storeAddress": "text",
  "countryId": 1,
  "zoneId": "text",
  "orderStatus": 1,
  "storeEmail": "text",
  "storeTelephone": "text",
  "storeFax": "text",
  "storeLogo": "text",
  "storeLogoPath": "text",
  "emailLogo": "text",
  "emailLogoPath": "text",
  "invoiceLogo": "text",
  "invoiceLogoPath": "text",
  "maintenanceMode": 1,
  "storeLanguageName": "text",
  "storeCurrencyId": 1,
  "storeImage": "text",
  "storeImagePath": "text",
  "facebook": "text",
  "google": "text",
  "twitter": "text",
  "instagram": "text",
  "invoicePrefix": "text",
  "categoryProductCount": 1,
  "itemsPerPage": 1,
  "isActive": 1,
  "addons": "text"
}

Add country

post

Add a country

Header parameters
AuthorizationstringRequired
Body
namestringRequired
isoCode2stringRequired
isoCode3stringRequired
postcodeRequiredinteger · int32Required
statusinteger · int32Required
Responses
200

success response

application/json
namestringOptional
isoCode2stringOptional
isoCode3stringOptional
postcodeRequiredinteger · int32Optional
isActiveinteger · int32Optional
countryIdinteger · int32Optional
post/country/add-country
POST /country/add-country HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 83

"name='text'&isoCode2='text'&isoCode3='text'&postcodeRequired=1&status=1"
{
  "name": "text",
  "isoCode2": "text",
  "isoCode3": "text",
  "postcodeRequired": 1,
  "isActive": 1,
  "countryId": 1
}

update country

put

Update a country

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
countryIdinteger · int32Required
namestringRequired
isoCode2stringRequired
isoCode3stringRequired
postcodeRequiredinteger · int32Required
statusinteger · int32Required
Responses
200

success response

application/json
countryIdinteger · int32Optional
namestringOptional
isoCode2stringOptional
isoCode3stringOptional
addressFormatstringOptional
postcodeRequiredinteger · int32Optional
isActiveinteger · int32Optional
put/country/update-country/{id}
PUT /country/update-country/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 97

"countryId=1&name='text'&isoCode2='text'&isoCode3='text'&postcodeRequired=1&status=1"
{
  "countryId": 1,
  "name": "text",
  "isoCode2": "text",
  "isoCode3": "text",
  "addressFormat": "text",
  "postcodeRequired": 1,
  "isActive": 1
}

country list

get

Get the list of country

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringRequired
statusstringRequired
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully got country List
get/country/countrylist
GET /country/countrylist?limit=1&keyword=text&status=text HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got country List"
}

delete country

delete

Delete a country

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully deleted the country.
delete/country/delete-country/{id}
DELETE /country/delete-country/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted the country."
}

add zone

post

Add a zone.

Header parameters
AuthorizationstringRequired
Body
countryIdinteger · int32Required
codestringRequired
namestringRequired
statusinteger · int32Required
Responses
200

success response

application/json
countryIdinteger · int32Optional
codestringOptional
namestringOptional
isActiveinteger · int32Optional
createdDatestring · date-timeOptional
zoneIdinteger · int32Optional
post/zone/add-zone
POST /zone/add-zone HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 54

"countryId=1&code='text'&name='text'&status=1"
{
  "countryId": 1,
  "code": "text",
  "name": "text",
  "isActive": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "zoneId": 1
}

update zone

put

Update a zone

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
countryIdinteger · int32Required
codestringRequired
namestringRequired
statusinteger · int32Required
Responses
200

success response

application/json
createdByintegerOptional
createdDatestring · date-timeOptional
modifiedByintegerOptional
modifiedDatestring · date-timeOptional
zoneIdinteger · int32Optional
countryIdinteger · int32Optional
codeinteger · int32Optional
namestringOptional
isActiveinteger · int32Optional
put/zone/update-zone/{id}
PUT /zone/update-zone/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 54

"countryId=1&code='text'&name='text'&status=1"
{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "zoneId": 1,
  "countryId": 1,
  "code": 1,
  "name": "text",
  "isActive": 1
}

zone list

get

Get the list of zone.

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringOptional
statusstringRequired
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully get all zone List
get/zone/zone-list
GET /zone/zone-list?limit=1&status=text HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully get all zone List"
}

delete zone

delete

Get the detail of zone list.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully deleted the Zone.
delete/zone/delete-zone/{id}
DELETE /zone/delete-zone/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted the Zone."
}

Add language

post

Add a language

Header parameters
AuthorizationstringRequired
Body
namestringRequired
codestringOptional
imagestringOptional
sortOrderinteger · int32Optional
statusinteger · int32Required
Responses
200

success response

application/json
namestringOptional
codestringOptional
sortOrderinteger · int32Optional
isActiveinteger · int32Optional
createdDatestring · date-timeOptional
languageIdinteger · int32Optional
post/language/add-language
POST /language/add-language HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 69

"name='text'&code='text'&image='text'&sortOrder=1&status=1"
{
  "name": "text",
  "code": "text",
  "sortOrder": 1,
  "isActive": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "languageId": 1
}

Language list

get

Get a list of language

Query parameters
limitintegerOptional
offsetintegerOptional
keywordstringOptional
statusstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully got the complete language list.
get/language/languageList
GET /language/languageList HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got the complete language list."
}

Update language

put

Update a language

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
namestringRequired
codestringOptional
imagestringOptional
sortOrderinteger · int32Optional
statusinteger · int32Required
Responses
200

success response

application/json
createdByinteger · int32Optional
createdDatestring · date-timeOptional
modifiedByinteger · int32Optional
modifiedDatestring · date-timeOptional
languageIdinteger · int32Optional
namestringOptional
codestringOptional
imagestringOptional
imagePathstringOptional
localestringOptional
sortOrderinteger · int32Optional
isActiveinteger · int32Optional
put/language/update-language/{id}
PUT /language/update-language/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 69

"name='text'&code='text'&image='text'&sortOrder=1&status=1"
{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "languageId": 1,
  "name": "text",
  "code": "text",
  "image": "text",
  "imagePath": "text",
  "locale": "text",
  "sortOrder": 1,
  "isActive": 1
}

Delete language

delete

Get a detail of language

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully deleted the language.
delete/language/delete-language/{id}
DELETE /language/delete-language/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted the language."
}

add currency

post

Add a currency

Header parameters
AuthorizationstringRequired
Body
titlestringRequired
codestringOptional
symbolLeftstringOptional
symbolRightstringOptional
statusinteger · int32Required
Responses
200

success response

application/json
titlestringOptional
codestringOptional
symbolLeftstringOptional
symbolRightstringOptional
isActiveinteger · int32Optional
createdDatestring · date-timeOptional
currencyIdinteger · int32Optional
post/currency/add-currency
POST /currency/add-currency HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 82

"title='text'&code='text'&symbolLeft='text'&symbolRight='text'&status=1"
{
  "title": "text",
  "code": "text",
  "symbolLeft": "text",
  "symbolRight": "text",
  "isActive": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "currencyId": 1
}

currency list

get

Get the list of currency

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringRequired
statusstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully got the complete currency list.
get/currency/currencylist
GET /currency/currencylist?limit=1&keyword=text HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got the complete currency list."
}

update currency

put

Update a currency

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
currencyIdinteger · int32Required
titlestringRequired
codestringOptional
symbolLeftstringOptional
symbolRightstringOptional
statusinteger · int32Required
Responses
200

success response

application/json
createdByinteger · int32Optional
createdDatestring · date-timeOptional
modifiedByinteger · int32Optional
modifiedDatestring · date-timeOptional
currencyIdinteger · int32Optional
titlestringOptional
codestringOptional
symbolLeftstringOptional
symbolRightstringOptional
decimalPlaceinteger · date-timeOptional
isActiveinteger · date-timeOptional
put/currency/update-currency/{id}
PUT /currency/update-currency/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 97

"currencyId=1&title='text'&code='text'&symbolLeft='text'&symbolRight='text'&status=1"
{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "currencyId": 1,
  "title": "text",
  "code": "text",
  "symbolLeft": "text",
  "symbolRight": "text",
  "decimalPlace": 1,
  "isActive": 1
}

delete currency

delete

Delete a currency

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfullly deleted the currency.
delete/currency/delete-currency/{id}
DELETE /currency/delete-currency/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfullly deleted the currency."
}

addb tax

post

Add a tax

Header parameters
AuthorizationstringRequired
Body
taxNamestringOptional
taxPercentageinteger · int32Optional
taxStatusinteger · int32Required
Responses
200

success response

application/json
taxNamestringOptional
taxPercentageinteger · int32Optional
taxStatusinteger · int32Optional
createdDatestringOptional
taxIdinteger · int32Optional
post/tax/add-tax
POST /tax/add-tax HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 50

"taxName='text'&taxPercentage=1&taxStatus=1"
{
  "taxName": "text",
  "taxPercentage": 1,
  "taxStatus": 1,
  "createdDate": "text",
  "taxId": 1
}

user list

get

List of users

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully get All user List
get/auth/userlist
GET /auth/userlist?limit=1 HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully get All user List"
}

tax list

get

Get a list of tax

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringOptional
statusstringRequired
countanyOptional
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully get all tax List
get/tax/tax-list
GET /tax/tax-list?limit=1&status=text HTTP/1.1
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully get all tax List"
}

delete tax

delete
Path parameters
taxIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully deleted the Tax.
delete/tax/delete-tax/{taxId}
DELETE /tax/delete-tax/{taxId} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted the Tax."
}

create role

post

Add a role

Header parameters
AuthorizationstringRequired
Body
namestringRequired
statusinteger · int32Required
Responses
200

success response

application/json
namestringOptional
isActiveinteger · int32Optional
slugstringOptional
createdDatestring · date-timeOptional
groupIdinteger · int32Optional
post/role/create-role
POST /role/create-role HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 26

"name='text'&status=1"
{
  "name": "text",
  "isActive": 1,
  "slug": "text",
  "createdDate": "2026-01-01T00:00:00.000Z",
  "groupId": 1
}

Update role

put

Update a role

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
namestringRequired
statusinteger · int32Required
Responses
200

success response

application/json
namestringOptional
isActiveinteger · int32Optional
slugstringOptional
groupIdinteger · int32Optional
put/role/update-role/{id}
PUT /role/update-role/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 26

"name='text'&status=1"
{
  "name": "text",
  "isActive": 1,
  "slug": "text",
  "groupId": 1
}

role list

get

List of role

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringOptional
statusstringOptional
countstringOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully get all role List
get/role/rolelist
GET /role/rolelist?limit=1 HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully get all role List"
}

delete role

delete

Delete a role

Header parameters
AuthorizationstringRequired
Body
groupIdinteger · int32Required
Responses
200

success response

application/json
statusintegerOptional
messagestringOptionalDefault: Successfully deleted the role.
delete/role/delete-role/:id
DELETE /role/delete-role/:id HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 13

"groupId=1"
{
  "status": 1,
  "message": "Successfully deleted the role."
}

login

post

Create a user login

Body
usernamestringRequired
passwordstringRequired
Responses
200

success response

application/json
createdByinteger · int32Optional
createdDatestring · date-timeOptional
modifiedByinteger · int32Optional
modifiedDatestring · date-timeOptional
userIdinteger · int32Optional
avatarstringOptional
avatarPathstringOptional
isActiveinteger · int32Optional
codeinteger · int32Optional
addressstringOptional
deleteFlaginteger · int32Optional
linkExpiresinteger · int32Optional
post/auth/login
POST /auth/login HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 37

"username='text'&password='text'"
{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "userId": 1,
  "avatar": "text",
  "avatarPath": "text",
  "isActive": 1,
  "code": 1,
  "address": "text",
  "deleteFlag": 1,
  "linkExpires": 1,
  "usergroup": {
    "createdBy": 1,
    "createdDate": "2026-01-01T00:00:00.000Z",
    "modifiedBy": 1,
    "modifiedDate": "2026-01-01T00:00:00.000Z",
    "groupId": 1,
    "name": "text"
  }
}

user list

get

List of users

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully get All user List
get/auth/userlist
GET /auth/userlist?limit=1 HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully get All user List"
}

create user

post

Add a new user.

Header parameters
AuthorizationstringRequired
Body
usernamestringRequired
passwordstringRequired
firstNamestringRequired
lastNamestringRequired
emailstringRequired
userGroupIdinteger · int32Required
Responses
200

success response

application/json
usernamestringOptional
passwordstringOptional
firstNamestringOptional
lastNamestringOptional
emailstringOptional
deleteFlaginteger · int32Optional
userGroupIdstringOptional
isActiveinteger · int32Optional
createdDatestring · date-timeOptional
userIdinteger · int32Optional
post/auth/create-user
POST /auth/create-user HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 105

"username='text'&password='text'&firstName='text'&lastName='text'&email='text'&userGroupId=1"
{
  "username": "text",
  "password": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "deleteFlag": 1,
  "userGroupId": "text",
  "isActive": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "userId": 1
}

Update User

put

Update a user.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
usernamestringRequired
passwordstringOptional
firstNamestringRequired
lastNamestringRequired
emailstringRequired
userGroupIdinteger · int32Required
Responses
200

success response

application/json
statusintegerOptional
messagestringOptionalDefault: User updated successfully.
put/auth/update-user/{id}
PUT /auth/update-user/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 105

"username='text'&password='text'&firstName='text'&lastName='text'&email='text'&userGroupId=1"
{
  "status": 1,
  "message": "User updated successfully."
}

Delete a User

delete

Delete a user

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: User Deleted successfully.
delete/auth/delete-user/{id}
DELETE /auth/delete-user/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "User Deleted successfully."
}

Forgot the user password

post

Forgrt password

Header parameters
AuthorizationstringRequired
Body
emailstringOptional
Responses
200

success response

application/json
statusintegerOptional
messagestringOptionalDefault: Your password has been sent to your email inbox.
post/auth/forgot-password
POST /auth/forgot-password HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16

"email='text'"
{
  "status": 1,
  "message": "Your password has been sent to your email inbox."
}

Change the Password

put

Change Password

Header parameters
AuthorizationstringRequired
Body
oldPasswordstringOptional
newPasswordstringOptional
Responses
200

success response

application/json
statusintegerOptional
messagestringOptionalDefault: Your password changed successfully.
put/auth/change-password
PUT /auth/change-password HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 43

"oldPassword='text'&newPassword='text'"
{
  "status": 1,
  "message": "Your password changed successfully."
}

Edit Profile

post

Edit a profile for a user.

Header parameters
AuthorizationstringRequired
Body
usernamestringRequired
emailstringRequired
avatarstringOptional
phoneNumberstringOptional
addressstringOptional
Responses
200

success response

application/json
createdByinteger · int32Optional
createdDatestring · date-timeOptional
modifiedByinteger · int32Optional
modifiedDatestring · date-timeOptional
userIdinteger · int32Optional
userGroupIdinteger · int32Optional
usernamestringOptional
passwordstringOptional
firstNamestringOptional
lastNamestringOptional
emailstringOptional
avatarstringOptional
avatarPathstringOptional
isActiveinteger · int32Optional
codeinteger · int32Optional
ipstringOptional
phoneNumberstringOptional
addressstringOptional
deleteFlaginteger · int32Optional
linkExpiresinteger · int32Optional
forgetPasswordKeystringOptional
permissioninteger · int32Optional
usergroupanyOptional
post/auth/edit-profile
POST /auth/edit-profile HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 88

"username='text'&email='text'&avatar='text'&phoneNumber='text'&address='text'"
{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "userId": 1,
  "userGroupId": 1,
  "username": "text",
  "password": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "avatar": "text",
  "avatarPath": "text",
  "isActive": 1,
  "code": 1,
  "ip": "text",
  "phoneNumber": "text",
  "address": "text",
  "deleteFlag": 1,
  "linkExpires": 1,
  "forgetPasswordKey": "text",
  "permission": 1,
  "usergroup": null
}

logout

post

User logout.

Header parameters
AuthorizationstringRequired
Responses
200

success response

application/json
statusintegerOptional
messagestringOptionalDefault: Successfully Logout.
post/auth/logout
POST /auth/logout HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully Logout."
}

forgot password link

post

This is for user forget password link.

Body
emailIdstringOptional
Responses
200

success response

application/json
statusintegerOptional
messagestringOptionalDefault: If the user is registered a link to reset the password will be sent to the user’s email address. " or " If the user is registered a link to reset the password will be sent to the user’s email address.
post/auth/forgot-password-link
POST /auth/forgot-password-link HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 18

"emailId='text'"
200

success response

{
  "status": 1,
  "message": "If the user is registered a link to reset the password will be sent to the user’s email address. \" or \" If the user is registered a link to reset the password will be sent to the user’s email address."
}

forgot-password-key-check

get

This is for user password key validation.

Query parameters
encryptedKeystringOptional
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Invalid key. please try again " or " Your forgot password link got expired, try again. " or " This link has been used already. please try again
get/auth/forgot-password-key-check
GET /auth/forgot-password-key-check HTTP/1.1
Accept: */*
200

success response

{
  "status": 1,
  "message": "Invalid key. please try again \" or \" Your forgot password link got expired, try again. \" or \" This link has been used already. please try again"
}

reset password

put

Users reset their password

Body
newPasswordstringOptional
keystringOptional
Responses
200

success response

application/json
statusintegerOptional
messagestringOptionalDefault: Your password has been changed successfully
put/auth/reset-password
PUT /auth/reset-password HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 35

"newPassword='text'&key='text'"
{
  "status": 1,
  "message": "Your password has been changed successfully"
}

Get Profile

get

This is to get the user profile

Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully Get the Profile.
get/auth/get-profile
GET /auth/get-profile HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully Get the Profile."
}

Get Site Map

get

Get user site map

Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: ""
get/auth/get-sitemap
GET /auth/get-sitemap HTTP/1.1
Accept: */*
200

success response

{
  "status": 1,
  "message": ""
}

plugin detail

get

Get a detai of plugin

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully got the complete product list.
get/plugins/detail/{id}
GET /plugins/detail/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got the complete product list."
}

plugin update

put

Update a list of plugin

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
pluginStatusinteger · int32Optional
Responses
200

success response

application/json
createdByinteger · int32Optional
createdDatestring · date-timeOptional
modifiedByinteger · int32Optional
modifiedDatestring · date-timeOptional
idinteger · int32Optional
pluginNamestringOptional
pluginAvatarstringOptional
pluginAvatarPathstringOptional
pluginTypestringOptional
pluginAdditionalInfostringOptional
pluginFormInfostringOptional
pluginStatusinteger · int32Optional
slugNamestringOptional
isEditableinteger · int32Optional
routesstringOptional
put/plugins/update/plugin-status/{id}
PUT /plugins/update/plugin-status/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 18

"pluginStatus=1"
{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "id": 1,
  "pluginName": "text",
  "pluginAvatar": "text",
  "pluginAvatarPath": "text",
  "pluginType": "text",
  "pluginAdditionalInfo": "text",
  "pluginFormInfo": "text",
  "pluginStatus": 1,
  "slugName": "text",
  "isEditable": 1,
  "routes": "text"
}

plugin list

get

Get the list of plugin

Query parameters
modulestringOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully got the complete product list.
get/plugins/list
GET /plugins/list HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got the complete product list."
}

add email template

post

Add a email template

Header parameters
AuthorizationstringRequired
Body
titlestringRequired
subjectstringRequired
contentstringRequired
statusinteger · int32Required
Responses
200

success response

application/json
titlestringOptional
subjectstringOptional
contentstringOptional
isActiveinteger · int32Optional
createdDatestring · date-timeOptional
emailTemplateIdinteger · int32Optional
post/email-template/add-email-template
POST /email-template/add-email-template HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 61

"title='text'&subject='text'&content='text'&status=1"
{
  "title": "text",
  "subject": "text",
  "content": "text",
  "isActive": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "emailTemplateId": 1
}

email template list

get

Get the list of emali template

Query parameters
limitintegerOptional
offsetintegerOptional
keywordstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully got the complete email template list.
get/email-template/email-templatelist
GET /email-template/email-templatelist HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got the complete email template list."
}

update email template

put

Update a email template

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
titlestringRequired
subjectstringRequired
contentstringRequired
statusinteger · int32Required
Responses
200

success response

application/json
createdByinteger · int32Optional
createdDatestring · date-timeOptional
modifiedByinteger · int32Optional
modifiedDatestring · date-timeOptional
emailTemplateIdinteger · int32Optional
titlestringOptional
subjectstringOptional
contentstringOptional
isActiveinteger · int32Optional
put/email-template/update-email-template/{id}
PUT /email-template/update-email-template/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 61

"title='text'&subject='text'&content='text'&status=1"
{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "emailTemplateId": 1,
  "title": "text",
  "subject": "text",
  "content": "text",
  "isActive": 1
}

delete-email-template

delete

Delete a email template

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptional
messagestringOptionalDefault: Successfully deleted the email template.
delete/email-template/delete-email-template/{id}
DELETE /email-template/delete-email-template/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted the email template."
}

Updated Gmap settings

post

Update details of the Gmap credential.

Body
clientIdstringOptional
clientSecretstringOptional
isTeststringOptional
Responses
200

settings updated successfully

application/json
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Gmap settings updated successfully
post/admin-gmap/update-setting
POST /admin-gmap/update-setting HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 57

"clientId='text'&clientSecret='text'&isTest='text'"
{
  "status": 1,
  "message": "Gmap settings updated successfully"
}

Update facebook setting credentials

post

Update facebook setting credentials

Body
clientIdstringOptional
clientSecretstringOptional
isTestbooleanOptional
Responses
200

Success Response

application/json
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Facebook settings updated successfully
post/admin-facebook/update-setting
POST /admin-facebook/update-setting HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 55

"clientId='text'&clientSecret='text'&isTest=true"
{
  "status": 1,
  "message": "Facebook settings updated successfully"
}

Update gmail setting credentials

post

Update gmail setting credentials

Body
clientIdstringOptional
clientSecretstringOptional
isTestbooleanOptional
Responses
200

Success Response

application/json
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Gmail settings updated successfully
post/admin-gmail/update-setting
POST /admin-gmail/update-setting HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 55

"clientId='text'&clientSecret='text'&isTest=true"
{
  "status": 1,
  "message": "Gmail settings updated successfully"
}

Last updated