Personalise

Get Settings

get

Responses

200

Successfully got settings

application/xmlapplication/json

get

HTTPcURLJavaScriptPython

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

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

400

Invalid input

500

Internal Server Error

post

HTTPcURLJavaScriptPython

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

Fetch the list of order statuses

get

This endpoint retrieves a list of order statuses based on the provided filters like status and keyword.

Query parameters

statusintegerOptional

Filter by status. If not provided, fetches all statuses.

keywordstringOptional

Filter by a keyword to search order statuses.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the order status list

application/xmlapplication/json

400

Bad Request - Invalid parameters

application/xmlapplication/json

get

HTTPcURLJavaScriptPython

GET /backend/api/order-status/order-status-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Fetch the list of email templates

get

This endpoint retrieves a list of email templates based on the provided filters like limit, offset, keyword, and count.

Query parameters

limitintegerOptional

Limit the number of email templates returned.

offsetintegerOptional

Offset to start fetching the email templates.

keywordstringOptional

Filter by keyword to search email templates.

countbooleanOptional

If set to 1, it will return the count of email templates.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the email template list

application/xmlapplication/json

400

Bad Request - Invalid parameters

application/xmlapplication/json

get

HTTPcURLJavaScriptPython

GET /backend/api/email-template/email-templatelist HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Update an existing email template

put

This endpoint allows updating an existing email template based on the provided template Id.

Path parameters

idintegerRequired

The unique identifier of the email template to be updated

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

titlestringOptional

The title of the email template

subjectstringOptional

The subject of the email template

contentstringOptional

The content/body of the email template

statusintegerOptional

The status of the email template (1 for active, 0 for inactive)

dynamicFieldsRefstringOptional

The dynamic fields reference for the email template

Responses

200

Successfully updated the email template

application/xmlapplication/json

400

Bad Request - Invalid parameters

application/xmlapplication/json

put

HTTPcURLJavaScriptPython

PUT /backend/api/email-template/update-email-template/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 87

"title='text'&subject='text'&content='text'&status=1&dynamicFieldsRef='text'"

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