Home

PreviousCategories NextProduct Detail Page

Last updated 22 days ago

This endpoint retrieves a list of widgets available in the system.

get

/list/widget-list

Header parameters

Authorizationstring

Optional Bearer token for authentication.

industrystring

The industry of the user.

keystring

The unique key for the request.

languagekeystring

The language key for the request.

Responses

cURL

JavaScript

Python

HTTP

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

200

400

500

{
  "status": 1,
  "message": "Successfully got widget list"
}

Successfully retrieved the widget list.

Get Google Map API Key

This endpoint returns a URL that redirects to the add-address API for Google Map integration.

get

/list/gmap-key

Query parameters

pluginNamestringrequired

The name of the plugin requesting the API key.

Header parameters

Authorizationstring

Optional Bearer token for authentication.

industrystring

The industry of the user.

keystring

The unique key for the request.

languagekeystring

The language key for the request.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/list/gmap-key?pluginName=text'

200

400

500

{
  "status": 1,
  "message": "Redirect to this url"
}

Successfully retrieved the Google Map API key URL.

Get a list of languages

This endpoint retrieves a list of all available languages.

get

/list/language

Query parameters

limitinteger

Number of languages to retrieve.

offsetinteger

Starting point to retrieve languages.

keywordstring

Filter languages based on keyword search.

countinteger

Flag to indicate if the total count of languages should be returned.

Header parameters

Authorizationstring

Optional Bearer token for authentication.

industrystring

The industry of the user.

keystring

The unique key for the request.

languagekeystring

The language key for the request.

Responses

cURL

JavaScript

Python

HTTP

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

200

400

500

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

Successfully retrieved the language list.

Get store settings

This endpoint retrieves the store settings for a given industry.

get

/settings/store-setting

Header parameters

Authorizationstring

Optional Bearer token for authentication.

industrystring

The industry of the user.

keystring

The unique key for the request.

languagekeystring

The language key for the request.

Responses

cURL

JavaScript

Python

HTTP

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

200

400

500

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

Successfully retrieved the store settings.

Get list of available addons

This endpoint retrieves the list of available addons for the system.

get

/list/addons

Header parameters

Authorizationstring

Optional Bearer token for authentication.

industrystring

The industry of the user.

keystring

The unique key for the request.

languagekeystring

The language key for the request.

Responses

cURL

JavaScript

Python

HTTP

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

200

400

500

{
  "status": 1,
  "message": "Successfully get the list"
}

Successfully retrieved the addons list.

Get Cart List

This endpoint retrieves the list of items in the customer's cart.

get

/cart

Header parameters

Authorizationstring

Optional Bearer token for authentication.

industrystring

The industry of the user.

keystring

The unique key for the request.

languagekeystring

The language key for the request.

Responses

cURL

JavaScript

Python

HTTP

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

200

400

500

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

Successfully got the cart list

Add Product to Wishlist

post

/customer/add-product-to-wishlist

Header parameters

Authorizationstring

Optional Bearer token for authentication.

industrystring

The industry of the user.

keystring

The unique key for the request.

languagekeystring

The language key for the request.

Body

productIdintegerrequired

Example: 2023

productOptionValueIdstring

Example:

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://139.59.67.17/backend/api/customer/add-product-to-wishlist' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"productId":2023,"productOptionValueId":""}'

200

400

500

{
  "status": 1,
  "message": "You have Successfully add to wishlist"
}

Product successfully added to wishlist

Get customer profile

This API allows customers to retrieve their profile information.

get

/customer/get-profile

Header parameters

Authorizationstring

Optional Bearer token for authentication.

industrystring

The industry of the user.

keystring

The unique key for the request.

languagekeystring

The language key for the request.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/customer/get-profile'

200

400

500

{
  "status": 1,
  "message": "Successfully Get the Profile."
}

Successfully retrieved the customer profile

Get wishlist product list

This API allows customers to retrieve a list of products in their wishlist.

get

/customer/wishlist-product-list

Query parameters

limitinteger

Limit the number of products returned.

offsetinteger

Offset for pagination.

Header parameters

Authorizationstring

Optional Bearer token for authentication.

industrystring

The industry of the user.

keystring

The unique key for the request.

languagekeystring

The language key for the request.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/customer/wishlist-product-list'

200

400

500

{
  "status": 1,
  "message": "Successfully show the wishlist product list"
}

Successfully retrieved the wishlist product list

Page List API

Fetch a list of pages with optional filters and pagination.

get

/pages

Query parameters

limitinteger

Limit the number of results

offsetinteger

Offset for pagination

keywordstring

Search keyword for filtering pages

countinteger

If set, returns count of pages (should be number or boolean)

Header parameters

Authorizationstring

Optional bearer token for authentication

languageIdintegerrequired

Language ID for content localization

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/pages' \
  --header 'languageId: 1'

200

400

401

500

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

Successfully retrieved the page list

Get Page Detail API

Retrieve detailed information about a page using its slug name.

get

/pages/{slugName}

Path parameters

slugNamestringrequired

The slug name of the page to fetch details for

Header parameters

Authorizationstring

Optional bearer token for authentication

languageIdintegerrequired

Language ID for content localization

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://139.59.67.17/backend/api/pages/{slugName}' \
  --header 'languageId: 1'

200

400

401

404

500

{
  "status": 1,
  "message": "Successfully get page Details"
}

Successfully retrieved page details

Get widget list

Get Google Map API Key

Get a list of languages

Get store settings

Get list of available addons

Get Cart List

Add Product to Wishlist

Get customer profile

Get wishlist product list

Page List API

Get Page Detail API