settings

get settings

GET/settings/get-settings

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/settings/get-settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get settings"
}

Create Settings

POST/settings/create-settings

Header parameters

Body

application/x-www-form-urlencoded

urlstring

metaTagTitlestring

metaTagDescriptionstring

metaTagKeywordsstring

storeNamestring

storeOwnerstring

storeAddressstring

zoneIdstring

countryIdinteger (int32)

storeEmailstring

storeTelephonestring

storeFaxstring

storeLogostring

emailLogostring

invoiceLogostring

maintenanceModeinteger (int32)

storeLanguageNameinteger (int32)

storeCurrencyIdinteger (int32)

storeImagestring

googlestring

twitterstring

instagramstring

facebookstring

statusinteger (int32)

invoicePrefixstring

orderStatusinteger (int32)

categoryProductCountinteger (int32)

itemsPerPageinteger (int32)

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

settingsIdinteger (int32)

urlstring

storeNamestring

storeOwnerstring

storeAddressstring

countryIdinteger (int32)

zoneIdstring

storeEmailstring

storeTelephonestring

storeLogoPathstring

emailLogostring

emailLogoPathstring

invoiceLogostring

invoiceLogoPathstring

maintenanceModeinteger (int32)

storeLanguageNamestring

storeCurrencyIdinteger (int32)

storeImagePathstring

addonsstring

Request

JavaScriptCurl

const response = await fetch('/settings/create-settings', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T19:35:17.084Z",
  "modifiedDate": "2024-04-28T19:35:17.084Z",
  "url": "text",
  "storeName": "text",
  "storeOwner": "text",
  "storeAddress": "text",
  "zoneId": "text",
  "storeEmail": "text",
  "storeTelephone": "text",
  "storeLogoPath": "text",
  "emailLogo": "text",
  "emailLogoPath": "text",
  "invoiceLogo": "text",
  "invoiceLogoPath": "text",
  "storeLanguageName": "text",
  "storeImagePath": "text",
  "addons": "text"
}

update maintainance mode

PUT/settings/update-maintainancemode

Query parameters

Header parameters

Response

200400

success response

Body

*/*

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

settingsIdinteger (int32)

urlstring

metaTagTitlestring

metaTagDescriptionstring

metaTagKeywordstring

storeNamestring

storeOwnerstring

storeAddressstring

countryIdinteger (int32)

zoneIdstring

orderStatusinteger (int32)

storeEmailstring

storeTelephonestring

storeFaxstring

storeLogostring

storeLogoPathstring

emailLogostring

emailLogoPathstring

invoiceLogostring

invoiceLogoPathstring

maintenanceModeinteger (int32)

storeLanguageNamestring

storeCurrencyIdinteger (int32)

storeImagestring

storeImagePathstring

facebookstring

googlestring

twitterstring

instagramstring

invoicePrefixstring

categoryProductCountinteger (int32)

itemsPerPageinteger (int32)

isActiveinteger (int32)

addonsstring

Request

JavaScriptCurl

const response = await fetch('/settings/update-maintainancemode', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T19:35:17.084Z",
  "modifiedDate": "2024-04-28T19:35:17.084Z",
  "url": "text",
  "metaTagTitle": "text",
  "metaTagDescription": "text",
  "metaTagKeyword": "text",
  "storeName": "text",
  "storeOwner": "text",
  "storeAddress": "text",
  "zoneId": "text",
  "storeEmail": "text",
  "storeTelephone": "text",
  "storeFax": "text",
  "storeLogo": "text",
  "storeLogoPath": "text",
  "emailLogo": "text",
  "emailLogoPath": "text",
  "invoiceLogo": "text",
  "invoiceLogoPath": "text",
  "storeLanguageName": "text",
  "storeImage": "text",
  "storeImagePath": "text",
  "facebook": "text",
  "google": "text",
  "twitter": "text",
  "instagram": "text",
  "invoicePrefix": "text",
  "addons": "text"
}

Add country

Add a country

POST/country/add-country

Header parameters

Body

application/x-www-form-urlencoded

name*string

isoCode2*string

isoCode3*string

postcodeRequired*integer (int32)

status*integer (int32)

Response

200400

success response

Body

application/json

namestring

isoCode2string

isoCode3string

postcodeRequiredinteger (int32)

isActiveinteger (int32)

countryIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/country/add-country', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "isoCode2": "text",
      "isoCode3": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "isoCode2": "text",
  "isoCode3": "text"
}

update country

Update a country

PUT/country/update-country/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

countryId*integer (int32)

name*string

isoCode2*string

isoCode3*string

postcodeRequired*integer (int32)

status*integer (int32)

Response

200400

success response

Body

application/json

countryIdinteger (int32)

namestring

isoCode2string

isoCode3string

addressFormatstring

postcodeRequiredinteger (int32)

isActiveinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/country/update-country/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "isoCode2": "text",
      "isoCode3": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "isoCode2": "text",
  "isoCode3": "text",
  "addressFormat": "text"
}

country list

Get the list of country

GET/country/countrylist

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/country/countrylist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got country List"
}

delete country

Delete a country

DELETE/country/delete-country/{id}

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/country/delete-country/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted the country."
}

add zone

Add a zone.

POST/zone/add-zone

Header parameters

Body

application/x-www-form-urlencoded

countryId*integer (int32)

code*string

name*string

status*integer (int32)

Response

200400

success response

Body

application/json

countryIdinteger (int32)

codestring

namestring

isActiveinteger (int32)

createdDatestring (date-time)

zoneIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/zone/add-zone', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "code": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "code": "text",
  "name": "text",
  "createdDate": "2024-04-28T19:35:17.084Z"
}

update zone

Update a zone

PUT/zone/update-zone/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

countryId*integer (int32)

code*string

name*string

status*integer (int32)

Response

200400

success response

Body

application/json

createdByinteger

createdDatestring (date-time)

modifiedByinteger

modifiedDatestring (date-time)

zoneIdinteger (int32)

countryIdinteger (int32)

codeinteger (int32)

namestring

isActiveinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/zone/update-zone/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "code": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T19:35:17.084Z",
  "modifiedDate": "2024-04-28T19:35:17.084Z",
  "name": "text"
}

zone list

Get the list of zone.

GET/zone/zone-list

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/zone/zone-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get all zone List"
}

delete zone

Get the detail of zone list.

DELETE/zone/delete-zone/{id}

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/zone/delete-zone/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted the Zone."
}

Add language

Add a language

POST/language/add-language

Header parameters

Body

application/x-www-form-urlencoded

name*string

codestring

imagestring

sortOrderinteger (int32)

status*integer (int32)

Response

200400

success response

Body

application/json

namestring

codestring

sortOrderinteger (int32)

isActiveinteger (int32)

createdDatestring (date-time)

languageIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/language/add-language', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "code": "text",
  "createdDate": "2024-04-28T19:35:17.084Z"
}

Language list

Get a list of language

GET/language/languageList

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/language/languageList', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Update language

Update a language

PUT/language/update-language/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

name*string

codestring

imagestring

sortOrderinteger (int32)

status*integer (int32)

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

languageIdinteger (int32)

namestring

codestring

imagestring

imagePathstring

localestring

sortOrderinteger (int32)

isActiveinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/language/update-language/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T19:35:17.084Z",
  "modifiedDate": "2024-04-28T19:35:17.084Z",
  "name": "text",
  "code": "text",
  "image": "text",
  "imagePath": "text",
  "locale": "text"
}

Delete language

Get a detail of language

DELETE/language/delete-language/{id}

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/language/delete-language/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted the language."
}

add currency

Add a currency

POST/currency/add-currency

Header parameters

Body

application/x-www-form-urlencoded

title*string

codestring

symbolLeftstring

symbolRightstring

status*integer (int32)

Response

200400

success response

Body

application/json

titlestring

codestring

symbolLeftstring

symbolRightstring

isActiveinteger (int32)

createdDatestring (date-time)

currencyIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/currency/add-currency', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "title": "text",
  "code": "text",
  "symbolLeft": "text",
  "symbolRight": "text",
  "createdDate": "2024-04-28T19:35:17.084Z"
}

currency list

Get the list of currency

GET/currency/currencylist

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/currency/currencylist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

update currency

Update a currency

PUT/currency/update-currency/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

currencyId*integer (int32)

title*string

codestring

symbolLeftstring

symbolRightstring

status*integer (int32)

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

currencyIdinteger (int32)

titlestring

codestring

symbolLeftstring

symbolRightstring

decimalPlaceinteger (date-time)

isActiveinteger (date-time)

Request

JavaScriptCurl

const response = await fetch('/currency/update-currency/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T19:35:17.084Z",
  "modifiedDate": "2024-04-28T19:35:17.084Z",
  "title": "text",
  "code": "text",
  "symbolLeft": "text",
  "symbolRight": "text"
}

delete currency

Delete a currency

DELETE/currency/delete-currency/{id}

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/currency/delete-currency/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfullly deleted the currency."
}

addb tax

Add a tax

POST/tax/add-tax

Header parameters

Body

application/x-www-form-urlencoded

taxNamestring

taxPercentageinteger (int32)

taxStatus*integer (int32)

Response

200400

success response

Body

application/json

taxNamestring

taxPercentageinteger (int32)

taxStatusinteger (int32)

createdDatestring

taxIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/tax/add-tax', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "taxName": "text",
  "createdDate": "text"
}

user list

List of users

GET/auth/userlist

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/userlist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get All user List"
}

tax list

Get a list of tax

GET/tax/tax-list

Query parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/tax/tax-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get all tax List"
}

delete tax

DELETE/tax/delete-tax/{taxId}

Path parameters

taxId*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/tax/delete-tax/{taxId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted the Tax."
}

create role

Add a role

POST/role/create-role

Header parameters

Body

application/x-www-form-urlencoded

name*string

status*integer (int32)

Response

200400

success response

Body

application/json

namestring

isActiveinteger (int32)

slugstring

createdDatestring (date-time)

groupIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/role/create-role', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "slug": "text",
  "createdDate": "2024-04-28T19:35:17.084Z"
}

Update role

Update a role

PUT/role/update-role/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

name*string

status*integer (int32)

Response

200400

success response

Body

application/json

namestring

isActiveinteger (int32)

slugstring

groupIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/role/update-role/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "slug": "text"
}

role list

List of role

GET/role/rolelist

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/role/rolelist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get all role List"
}

delete role

Delete a role

DELETE/role/delete-role/:id

Header parameters

Body

application/x-www-form-urlencoded

groupId*integer (int32)

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/role/delete-role/:id', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Successfully deleted the role."
}

login

Create a user login

POST/auth/login

Body

application/x-www-form-urlencoded

username*string

password*string

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

userIdinteger (int32)

avatarstring

avatarPathstring

isActiveinteger (int32)

codeinteger (int32)

addressstring

deleteFlaginteger (int32)

linkExpiresinteger (int32)

usergroupuserGroup (object)

Request

JavaScriptCurl

const response = await fetch('/auth/login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "password": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T19:35:17.084Z",
  "modifiedDate": "2024-04-28T19:35:17.084Z",
  "avatar": "text",
  "avatarPath": "text",
  "address": "text",
  "usergroup": {
    "createdDate": "2024-04-28T19:35:17.084Z",
    "modifiedDate": "2024-04-28T19:35:17.084Z",
    "name": "text"
  }
}

user list

List of users

GET/auth/userlist

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/userlist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully get All user List"
}

create user

Add a new user.

POST/auth/create-user

Header parameters

Body

application/x-www-form-urlencoded

username*string

password*string

firstName*string

lastName*string

email*string

userGroupId*integer (int32)

Response

200400

success response

Body

application/json

usernamestring

passwordstring

firstNamestring

lastNamestring

emailstring

deleteFlaginteger (int32)

userGroupIdstring

isActiveinteger (int32)

createdDatestring (date-time)

userIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/auth/create-user', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "email": "text",
      "firstName": "text",
      "lastName": "text",
      "password": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

{
  "username": "text",
  "password": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "userGroupId": "text",
  "createdDate": "2024-04-28T19:35:17.084Z"
}

Update User

Update a user.

PUT/auth/update-user/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

username*string

passwordstring

firstName*string

lastName*string

email*string

userGroupId*integer (int32)

Response

200400422

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/update-user/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "email": "text",
      "firstName": "text",
      "lastName": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "User updated successfully."
}

Delete a User

Delete a user

DELETE/auth/delete-user/{id}

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/delete-user/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "User Deleted successfully."
}

Forgot the user password

Forgrt password

POST/auth/forgot-password

Header parameters

Body

application/x-www-form-urlencoded

emailstring

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/forgot-password', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Your password has been sent to your email inbox."
}

Change the Password

Change Password

PUT/auth/change-password

Header parameters

Body

application/x-www-form-urlencoded

oldPasswordstring

newPasswordstring

Response

200400422

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/change-password', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Your password changed successfully."
}

Edit Profile

Edit a profile for a user.

POST/auth/edit-profile

Header parameters

Body

application/x-www-form-urlencoded

username*string

email*string

avatarstring

phoneNumberstring

addressstring

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

userIdinteger (int32)

userGroupIdinteger (int32)

usernamestring

passwordstring

firstNamestring

lastNamestring

emailstring

avatarstring

avatarPathstring

isActiveinteger (int32)

codeinteger (int32)

ipstring

phoneNumberstring

addressstring

deleteFlaginteger (int32)

linkExpiresinteger (int32)

forgetPasswordKeystring

permissioninteger (int32)

usergroupprofileUserGroup (any)

Request

JavaScriptCurl

const response = await fetch('/auth/edit-profile', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "email": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T19:35:17.084Z",
  "modifiedDate": "2024-04-28T19:35:17.084Z",
  "username": "text",
  "password": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "avatar": "text",
  "avatarPath": "text",
  "ip": "text",
  "phoneNumber": "text",
  "address": "text",
  "forgetPasswordKey": "text"
}

logout

User logout.

POST/auth/logout

Header parameters

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/logout', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully Logout."
}

forgot password link

This is for user forget password link.

POST/auth/forgot-password-link

Body

application/x-www-form-urlencoded

emailIdstring

Response

200

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/forgot-password-link', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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

This is for user password key validation.

GET/auth/forgot-password-key-check

Query parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/forgot-password-key-check', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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

Users reset their password

PUT/auth/reset-password

Body

application/x-www-form-urlencoded

newPasswordstring

keystring

Response

200400422

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/reset-password', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Your password has been changed successfully"
}

Get Profile

This is to get the user profile

GET/auth/get-profile

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/get-profile', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully Get the Profile."
}

Get Site Map

Get user site map

GET/auth/get-sitemap

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/auth/get-sitemap', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}

plugin detail

Get a detai of plugin

GET/plugins/detail/{id}

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/plugins/detail/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

plugin update

Update a list of plugin

PUT/plugins/update/plugin-status/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

pluginStatusinteger (int32)

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

idinteger (int32)

pluginNamestring

pluginAvatarstring

pluginAvatarPathstring

pluginTypestring

pluginAdditionalInfostring

pluginFormInfostring

pluginStatusinteger (int32)

slugNamestring

isEditableinteger (int32)

routesstring

Request

JavaScriptCurl

const response = await fetch('/plugins/update/plugin-status/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T19:35:17.084Z",
  "modifiedDate": "2024-04-28T19:35:17.084Z",
  "pluginName": "text",
  "pluginAvatar": "text",
  "pluginAvatarPath": "text",
  "pluginType": "text",
  "pluginAdditionalInfo": "text",
  "pluginFormInfo": "text",
  "slugName": "text",
  "routes": "text"
}

plugin list

Get the list of plugin

GET/plugins/list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/plugins/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

add email template

Add a email template

POST/email-template/add-email-template

Header parameters

Body

application/x-www-form-urlencoded

title*string

subject*string

content*string

status*integer (int32)

Response

200400

success response

Body

application/json

titlestring

subjectstring

contentstring

isActiveinteger (int32)

createdDatestring (date-time)

emailTemplateIdinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/email-template/add-email-template', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "content": "text",
      "subject": "text",
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "title": "text",
  "subject": "text",
  "content": "text",
  "createdDate": "2024-04-28T19:35:17.084Z"
}

email template list

Get the list of emali template

GET/email-template/email-templatelist

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/email-template/email-templatelist', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

update email template

Update a email template

PUT/email-template/update-email-template/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

title*string

subject*string

content*string

status*integer (int32)

Response

200400

success response

Body

application/json

createdByinteger (int32)

createdDatestring (date-time)

modifiedByinteger (int32)

modifiedDatestring (date-time)

emailTemplateIdinteger (int32)

titlestring

subjectstring

contentstring

isActiveinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/email-template/update-email-template/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "content": "text",
      "subject": "text",
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-28T19:35:17.084Z",
  "modifiedDate": "2024-04-28T19:35:17.084Z",
  "title": "text",
  "subject": "text",
  "content": "text"
}

delete-email-template

Delete a email template

DELETE/email-template/delete-email-template/{id}

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/email-template/delete-email-template/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted the email template."
}

Updated Gmap settings

Update details of the Gmap credential.

POST/admin-gmap/update-setting

Body

application/x-www-form-urlencoded

clientIdstring

clientSecretstring

isTeststring

Response

200400

settings updated successfully

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-gmap/update-setting', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Gmap settings updated successfully"
}

Update facebook setting credentials

Update facebook setting credentials

POST/admin-facebook/update-setting

Body

application/x-www-form-urlencoded

clientIdstring

clientSecretstring

isTestboolean

Response

200400

Success Response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-facebook/update-setting', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Facebook settings updated successfully"
}

Update gmail setting credentials

Update gmail setting credentials

POST/admin-gmail/update-setting

Body

application/x-www-form-urlencoded

clientIdstring

clientSecretstring

isTestboolean

Response

200400

Success Response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-gmail/update-setting', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Gmail settings updated successfully"
}