Localization

PreviousAdd-ons Product Attributes NextOrder Fulfilment Status

Last updated 4 months ago

Delete an existing country

delete

Path parameters

idintegerRequired

The ID of the country to delete

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted the country

404

Country not found

delete

DELETE /backend/api/country/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Delete a language

delete

Path parameters

idintegerRequired

The ID of the language to be deleted

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted the language

400

Invalid ID provided

404

Language not found

delete

DELETE /backend/api/language/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Get all zones

get

Query parameters

limitintegerOptional

The number of zones to retrieve. Defaults to 10.

offsetintegerOptional

The offset for pagination. Defaults to 0.

keywordstringOptional

A keyword to search zones.

countbooleanOptional

If true, will return a count of zones instead of the zone list.

statusintegerOptional

The status of the zones (1 for active, 0 for inactive).

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved all zone list

400

Invalid query parameters

get

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

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

Delete a zone

delete

Deletes a zone identified by its ID.

Path parameters

zoneIdinteger · int64Required

ID of the zone to delete

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted the zone

400

Bad request

delete

DELETE /backend/api/zone/{zoneId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted the Zone</message>
</object>

Delete an existing currency

delete

Deletes an existing currency by ID.

Path parameters

currencyIdintegerRequired

ID of the currency to delete

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted the currency

400

Bad request, invalid input

404

Currency not found

delete

DELETE /backend/api/currency/{currencyId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

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

Get a list of taxes

get

Retrieves a list of taxes based on the given filters.

Query parameters

limitintegerOptional

The maximum number of items to return

Default: 10

offsetintegerOptional

The offset for pagination

Default: 0

keywordstringOptional

Search keyword for filtering tax list

countbooleanOptional

If true, returns only the count of taxes, not the actual list

Default: false

statusstringOptional

Filter by status (e.g., active/inactive)

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the list of taxes

400

Bad request, invalid input

get

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

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

Delete a tax

delete

Deletes a tax by ID.

Path parameters

taxIdintegerRequired

The ID of the tax to delete

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted the tax

404

Tax not found

delete

DELETE /backend/api/tax/delete-tax/{taxId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted the tax</message>
</object>

Get complete list of languages

get

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

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>

Add a new currency

post

Adds a new currency to the system.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

titlestringRequiredExample: test

codestringRequiredExample: sdf

symbolLeftstringOptionalExample: s

symbolRightstringOptionalExample: null

valuenumber · floatRequiredExample: 0

statusstringRequiredExample: 1

Responses

200

Successfully added a new currency

400

Bad request, invalid input

post

POST /backend/api/currency HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 90

"title='test'&code='sdf'&symbolLeft='s'&symbolRight='null'&value=0&status='1'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully added new currency</message>
</object>

Update an existing country

put

Path parameters

idintegerRequired

The ID of the country to update

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

namestringRequired

The name of the country

isoCode2stringRequired

The 2-letter ISO code for the country

isoCode3stringRequired

The 3-letter ISO code for the country

postcodeRequiredintegerOptional

Indicates whether a postcode is required (1 for true, 0 for false)

statusstringOptional

The status of the country (e.g., 0 for inactive, 1 for active)

countryIdstringOptional

The country ID being updated

Responses

200

Successfully updated the country

400

Invalid input

404

Country not found

put

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

"name='text'&isoCode2='text'&isoCode3='text'&postcodeRequired=1&status='text'&countryId='text'"

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

Update an existing language

put

Path parameters

idintegerRequired

The ID of the language to update

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

codestringRequired

The language code

namestringRequired

The language name

imagestringOptional

The image associated with the language

sortOrderintegerOptional

The sort order of the language

statusstringRequired

The status of the language

languageIdintegerRequired

The unique ID of the language to update

Responses

200

Successfully updated the language

400

Invalid language ID or data

404

Language not found

put

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

"code='text'&name='text'&image='text'&sortOrder=1&status='text'&languageId=1"

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

Create a new language

post

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

codestringRequired

The language code

namestringRequired

The language name

imagestringOptional

The image associated with the language (optional)

sortOrderintegerOptional

The sort order of the language

statusstringRequired

The status of the language

Responses

200

Successfully added a new language

400

Invalid input data

404

Not Found

post

POST /backend/api/language/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 74

"code='text'&name='text'&image='text'&sortOrder=1&status='text'"

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

Create a new zone

post

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

countryIdintegerRequired

The country ID to which the zone belongs.

codestringRequired

The unique code for the zone.

namestringRequired

The name of the zone.

statusintegerRequired

The status of the zone (1 for active, 0 for inactive).

Responses

200

Successfully created a new zone

400

Invalid input data

post

POST /backend/api/zone HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 54

"countryId=1&code='text'&name='text'&status=1"

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

Update an existing zone

put

Updates a zone with the provided details.

Path parameters

zoneIdinteger · int64Required

ID of the zone to update

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

countryIdintegerRequiredExample: 4

codestringRequiredExample: df

namestringRequiredExample: test

statusstringRequiredExample: 1

zoneIdintegerRequiredExample: 110

Responses

200

Successfully updated the zone

400

Bad request

put

PUT /backend/api/zone/{zoneId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 67

"countryId=4&code='df'&name='test'&status='1'&zoneId=110"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated the zone</message>
</object>

Update an existing currency

put

Updates an existing currency with the provided details.

Path parameters

currencyIdintegerRequired

ID of the currency to update

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

titlestringRequiredExample: test

codestringRequiredExample: sdf

symbolLeftstringOptionalExample: s

symbolRightstringOptionalExample: null

valuenumber · floatRequiredExample: 0

statusstringRequiredExample: 1

Responses

200

Successfully updated the currency

400

Bad request, invalid input

404

Currency not found

put

PUT /backend/api/currency/{currencyId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 90

"title='test'&code='sdf'&symbolLeft='s'&symbolRight='null'&value=0&status='1'"

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

Add a new tax

post

Creates a new tax record with the provided details.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

taxNamestringRequiredExample: test

taxPercentagestringRequiredExample: 44

taxStatusstringRequiredExample: 1

Responses

200

Successfully created the new tax

400

Bad request, invalid input

post

POST /backend/api/tax/add-tax HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 55

"taxName='test'&taxPercentage='44'&taxStatus='1'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created new tax</message>
</object>

Update tax details

put

Updates the tax with the provided ID and new details.

Path parameters

taxIdintegerRequired

The ID of the tax to update

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

taxNamestringRequiredExample: test

taxPercentageintegerRequiredExample: 44

taxStatusstringRequiredExample: 1

Responses

200

Successfully updated the tax

400

Bad request, invalid input

put

PUT /backend/api/tax/update-tax/{taxId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 53

"taxName='test'&taxPercentage=44&taxStatus='1'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated the tax</message>
</object>