Store Settings

Get Settings

get
/settings
Responses
200

Successfully got settings

get
/settings
GET /backend/api/settings HTTP/1.1
Host: 139.59.67.17
Accept: */*
200

Successfully got settings

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got settings</message>
</object>

Update store settings

post
/settings
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
metaTagTitlestringOptional
metaTagDescriptionstringOptional
metaTagKeywordsstringOptional
businessNamestringOptional
siteUrlstringOptional
storeOwnerstringOptional
storeAddress1stringOptional
storeAddress2stringOptional
storeDescriptionstringOptional
storeEmailstringOptional
storeTelephonestringOptional
storeCitystringOptional
storePostalCodestringOptional
siteCategorystringOptional
maintenanceModeintegerOptional
storeLanguageNamestringOptional
storeSecondaryLanguageNamestringOptional
storeCurrencyIdintegerOptional
timeZonestringOptional
twitterstringOptional
linkedInstringOptional
instagramstringOptional
youtubestringOptional
facebookstringOptional
statusintegerOptional
invoicePrefixstringOptional
orderStatusintegerOptional
categoryProductCountintegerOptional
itemsPerPageintegerOptional
settingIdintegerOptional
accessKeystringOptional
siteNamestringOptional
timeFormatstringOptional
currencySymbolstringOptional
defaultCountryintegerOptional
zoneIdintegerOptional
countryIdintegerOptional
countrystringOptional
defaultWebsiteintegerOptional
Responses
200

Settings Updated Successfully

post
/settings
POST /backend/api/settings HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
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

Get Country List

get
/country
Query parameters
limitintegerOptional

Limit of records

Default: 0
offsetintegerOptional

Offset for pagination

Default: 0
keywordstringOptional

Search keyword

countintegerOptional

Flag to get count (0 or 1)

Default: 0
statusintegerOptional

Filter by status

Default: 1
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully got all country list

get
/country
GET /backend/api/country HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
200

Successfully got all country list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get all country List</message>
</object>

Get Zone List

get
/list/zone
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully got all zone list

get
/list/zone
GET /backend/api/list/zone HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
200

Successfully got all zone list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get all zone list</message>
</object>

Get Settings by ID

get
/settings/{id}
Path parameters
idintegerRequired

ID of the setting to fetch

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully fetched the settings

get
/settings/{id}
GET /backend/api/settings/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
200

Successfully fetched the settings

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get settings</message>
</object>

Get complete list of currencies

get
/currency
Query parameters
limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

keywordstringOptional

Search keyword to filter the currencies

countintegerOptional

Count flag (should be 0 or true/false)

statusintegerOptional

Filter currencies by status (1 for active)

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the currency list

get
/currency
GET /backend/api/currency HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
200

Successfully retrieved the currency list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete currency list</message>
</object>

Get complete list of languages

get
/language
Query parameters
limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

countbooleanOptional

Count flag (should be 0 or true/false)

keywordstringOptional

Search keyword to filter the languages

statusintegerOptional

Filter languages by status (1 for active)

defaultLanguagebooleanOptional

Filter by default language

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the language list

get
/language
GET /backend/api/language HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
200

Successfully retrieved the language list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got all language List</message>
</object>

Get complete list of categories

get
/category
Query parameters
limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

keywordstringOptional

Search keyword to filter the categories

sortOrderintegerOptional

Sort order (0 for ascending, 1 for descending)

statusintegerOptional

Filter categories by status (1 for active)

namestringOptional

Filter categories by name

industryIdintegerOptional

Filter categories by industry ID

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
200

Successfully retrieved the category list

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

Successfully retrieved the category list

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

Last updated