Localization | Spurtcommerce

Spurtcommerce

Document API Reference Add-ons

Add a new currency

Adds a new currency to the system.

post

/currency

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

titlestringrequired

Example: test

codestringrequired

Example: sdf

symbolLeftstring

Example: s

symbolRightstring

Example: null

valuenumber floatrequired

Example: 0

statusstringrequired

Example: 1

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/currency' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"title":"test","code":"sdf","symbolLeft":"s","symbolRight":"null","value":0,"status":"1"}'

200

400

{
  "status": 1,
  "message": "Successfully added new currency"
}

Successfully added a new currency

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

Update an existing country

put

/country/{id}

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

postcodeRequiredinteger

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

statusstring

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

countryIdstring

The country ID being updated

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://139.59.67.17/backend/api/country/{id}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"name":"text","isoCode2":"text","isoCode3":"text"}'

200

400

404

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

Successfully updated the country

Delete an existing country

delete

/country/{id}

Path parameters

idintegerrequired

The ID of the country to delete

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

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

200

404

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

Successfully deleted the country

Update an existing language

put

/language/{id}

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

imagestring

The image associated with the language

sortOrderinteger

The sort order of the language

statusstringrequired

The status of the language

languageIdintegerrequired

The unique ID of the language to update

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://139.59.67.17/backend/api/language/{id}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"code":"text","name":"text","status":"text","languageId":1}'

200

400

404

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

Successfully updated the language

Delete a language

delete

/language/{id}

Path parameters

idintegerrequired

The ID of the language to be deleted

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

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

200

400

404

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

Successfully deleted the language

Create a new language

post

/language/

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

codestringrequired

The language code

namestringrequired

The language name

sortOrderinteger

The sort order of the language

statusstringrequired

The status of the language

imagestring

The image associated with the language (optional)

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/language/' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"code":"text","name":"text","status":"text"}'

200

400

404

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

Successfully added a new language

Get all zones

get

/zone

Query parameters

limitinteger

The number of zones to retrieve. Defaults to 10.

offsetinteger

The offset for pagination. Defaults to 0.

keywordstring

A keyword to search zones.

countboolean

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

statusinteger

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

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

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

200

400

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

Successfully retrieved all zone list

Create a new zone

post

/zone

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/zone' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"countryId":1,"code":"text","name":"text","status":1}'

200

400

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

Successfully created a new zone

Update an existing zone

Updates a zone with the provided details.

put

/zone/{zoneId}

Path parameters

zoneIdinteger int64required

ID of the zone to update

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

countryIdintegerrequired

Example: 4

codestringrequired

Example: df

namestringrequired

Example: test

statusstringrequired

Example: 1

zoneIdintegerrequired

Example: 110

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://139.59.67.17/backend/api/zone/{zoneId}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"countryId":4,"code":"df","name":"test","status":"1","zoneId":110}'

200

400

{
  "status": 1,
  "message": "Successfully updated the zone"
}

Successfully updated the zone

Delete a zone

Deletes a zone identified by its ID.

delete

/zone/{zoneId}

Path parameters

zoneIdinteger int64required

ID of the zone to delete

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://139.59.67.17/backend/api/zone/{zoneId}' \
  --header 'Authorization: text'

200

400

{
  "status": 1,
  "message": "Successfully deleted the Zone"
}

Successfully deleted the zone

Update an existing currency

Updates an existing currency with the provided details.

put

/currency/{currencyId}

Path parameters

currencyIdintegerrequired

ID of the currency to update

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

titlestringrequired

Example: test

codestringrequired

Example: sdf

symbolLeftstring

Example: s

symbolRightstring

Example: null

valuenumber floatrequired

Example: 0

statusstringrequired

Example: 1

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://139.59.67.17/backend/api/currency/{currencyId}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"title":"test","code":"sdf","symbolLeft":"s","symbolRight":"null","value":0,"status":"1"}'

200

400

404

{
  "status": 1,
  "message": "Successfully updated the currency"
}

Successfully updated the currency

Delete an existing currency

Deletes an existing currency by ID.

delete

/currency/{currencyId}

Path parameters

currencyIdintegerrequired

ID of the currency to delete

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://139.59.67.17/backend/api/currency/{currencyId}' \
  --header 'Authorization: text'

200

400

404

{
  "status": 1,
  "message": "Successfully deleted the currency"
}

Successfully deleted the currency

Get a list of taxes

Retrieves a list of taxes based on the given filters.

get

/tax/tax-list

Query parameters

limitinteger

The maximum number of items to return

offsetinteger

The offset for pagination

keywordstring

Search keyword for filtering tax list

countboolean

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

statusstring

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

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

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

200

400

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

Successfully retrieved the list of taxes

Add a new tax

Creates a new tax record with the provided details.

post

/tax/add-tax

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

taxNamestringrequired

Example: test

taxPercentagestringrequired

Example: 44

taxStatusstringrequired

Example: 1

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/tax/add-tax' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"taxName":"test","taxPercentage":"44","taxStatus":"1"}'

200

400

{
  "status": 1,
  "message": "Successfully created new tax"
}

Successfully created the new tax

Update tax details

Updates the tax with the provided ID and new details.

put

/tax/update-tax/{taxId}

Path parameters

taxIdintegerrequired

The ID of the tax to update

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Body

taxNamestringrequired

Example: test

taxPercentageintegerrequired

Example: 44

taxStatusstringrequired

Example: 1

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://139.59.67.17/backend/api/tax/update-tax/{taxId}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"taxName":"test","taxPercentage":44,"taxStatus":"1"}'

200

400

{
  "status": 1,
  "message": "Successfully updated the tax"
}

Successfully updated the tax

Delete a tax

Deletes a tax by ID.

delete

/tax/delete-tax/{taxId}

Path parameters

taxIdintegerrequired

The ID of the tax to delete

Header parameters

Authorizationstringrequired

Bearer token for authentication.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://139.59.67.17/backend/api/tax/delete-tax/{taxId}' \
  --header 'Authorization: text'

200

404

{
  "status": 1,
  "message": "Successfully deleted the tax"
}

Successfully deleted the tax