Store Settings

PreviousSite Settings NextSystem

Last updated 22 days ago

Get Settings

get

/settings

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/settings'

200

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

Successfully got settings

Update store settings

post

/settings

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

metaTagTitlestring

metaTagDescriptionstring

metaTagKeywordsstring

businessNamestring

siteUrlstring

storeOwnerstring

storeAddress1string

storeAddress2string

storeDescriptionstring

storeEmailstring

storeTelephonestring

storeCitystring

storePostalCodestring

siteCategorystring

maintenanceModeinteger

storeLanguageNamestring

storeSecondaryLanguageNamestring

storeCurrencyIdinteger

timeZonestring

twitterstring

linkedInstring

instagramstring

youtubestring

facebookstring

statusinteger

invoicePrefixstring

orderStatusinteger

categoryProductCountinteger

itemsPerPageinteger

settingIdinteger

accessKeystring

siteNamestring

timeFormatstring

currencySymbolstring

defaultCountryinteger

zoneIdinteger

countryIdinteger

countrystring

defaultWebsiteinteger

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/settings' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded'

200

400

500

No body

Settings Updated Successfully

Get Country List

get

/country

Query parameters

limitinteger

Limit of records

offsetinteger

Offset for pagination

keywordstring

Search keyword

countinteger

Flag to get count (0 or 1)

statusinteger

Filter by status

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/country' \
  --header 'Authorization: text'

200

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

Successfully got all country list

Get Zone List

get

/list/zone

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/list/zone' \
  --header 'Authorization: text'

200

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

Successfully got all zone list

Get Settings by ID

get

/settings/{id}

Path parameters

idintegerrequired

ID of the setting to fetch

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/settings/{id}' \
  --header 'Authorization: text'

200

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

Successfully fetched the settings

Get complete list of currencies

get

/currency

Query parameters

limitinteger

Limit the number of results

offsetinteger

Offset for pagination

keywordstring

Search keyword to filter the currencies

countinteger

Count flag (should be 0 or true/false)

statusinteger

Filter currencies by status (1 for active)

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/currency' \
  --header 'Authorization: text'

200

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

Successfully retrieved the currency list

Get complete list of languages

get

/language

Query parameters

limitinteger

Limit the number of results

offsetinteger

Offset for pagination

countboolean

Count flag (should be 0 or true/false)

keywordstring

Search keyword to filter the languages

statusinteger

Filter languages by status (1 for active)

defaultLanguageboolean

Filter by default language

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/language' \
  --header 'Authorization: text'

200

{
  "status": 1,
  "message": "Successfully got all language List"
}

Successfully retrieved the language list

Get complete list of categories

get

/category

Query parameters

limitinteger

Limit the number of results

offsetinteger

Offset for pagination

keywordstring

Search keyword to filter the categories

sortOrderinteger

Sort order (0 for ascending, 1 for descending)

statusinteger

Filter categories by status (1 for active)

namestring

Filter categories by name

industryIdinteger

Filter categories by industry ID

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/category' \
  --header 'Authorization: text'

200

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

Successfully retrieved the category list