Store

get

/list/widget-list

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

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the widget list.

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got widget list

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/list/widget-list

GET /backend/api/list/widget-list HTTP/1.1
Host: 139.59.67.17
Accept: */*

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

Get Google Map API Key

get

/list/gmap-key

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

Query parameters

pluginNamestringRequired

The name of the plugin requesting the API key.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the Google Map API key URL.

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Redirect to this url

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/list/gmap-key

GET /backend/api/list/gmap-key?pluginName=text HTTP/1.1
Host: 139.59.67.17
Accept: */*

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

Get a list of languages

get

/list/language

This endpoint retrieves a list of all available languages.

Query parameters

limitintegerOptional

Number of languages to retrieve.

Default: 0

offsetintegerOptional

Starting point to retrieve languages.

Default: 0

keywordstringOptional

Filter languages based on keyword search.

countintegerOptional

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

Default: 0

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the language list.

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the complete language list

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/list/language

GET /backend/api/list/language HTTP/1.1
Host: 139.59.67.17
Accept: */*

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

Get store settings

get

/settings/store-setting

This endpoint retrieves the store settings for a given industry.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the store settings.

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got settings

400

Bad Request due to invalid parameters.

*/*

500

Internal Server Error

*/*

get

/settings/store-setting

GET /backend/api/settings/store-setting HTTP/1.1
Host: 139.59.67.17
Accept: */*

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

Get list of available addons

get

/list/addons

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

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the addons list.

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully get the list

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/list/addons

GET /backend/api/list/addons HTTP/1.1
Host: 139.59.67.17
Accept: */*

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

Get list of product categories

get

/list/category

This endpoint retrieves the list of available product categories for the system.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the list of categories.

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the list of categories

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/list/category

GET /backend/api/list/category HTTP/1.1
Host: 139.59.67.17
Accept: */*

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

Get count of custom products

get

/list/custom-product-list

This endpoint retrieves the count of products based on the provided filters.

Query parameters

categorySlugstringRequired

Slug for the product category (e.g., 'mens-bottom-wear')

attributestringOptional

Filter by product attribute (e.g., color, size, etc.)

variantstringOptional

Filter by product variant

pricestringOptional

Filter by price range (e.g., 'low', 'high')

priceFromnumber · floatOptional

Filter by minimum price

priceTonumber · floatOptional

Filter by maximum price

latestArrivalbooleanOptional

Filter by latest arrivals (1 for yes, 0 for no)

countintegerOptional

If set to 1, returns the count of products

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the count of products

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the count of products

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/list/custom-product-list

GET /backend/api/list/custom-product-list?categorySlug=text HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Successfully got the count of products"
}

Get product count and maximum price

get

/list/product-count

This endpoint retrieves the total number of products and the maximum product price.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the product count and maximum price

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully get Product Count

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/list/product-count

GET /backend/api/list/product-count HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Successfully get Product Count"
}

Get question list based on the question ID

get

/store-question-answer/question-list/{skuId}

This endpoint retrieves the list of questions and answers based on the store's question ID and an optional keyword.

Path parameters

skuIdintegerRequired

The ID of the question to retrieve the list for.

Query parameters

keywordstringOptional

An optional search keyword to filter questions.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the question list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully get all question List

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/store-question-answer/question-list/{skuId}

GET /backend/api/store-question-answer/question-list/{skuId} HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Successfully get all question List"
}

Get product details based on product code

get

/product-store/productdetail/{productSlug}

This endpoint retrieves detailed information about a specific product using its product code.

Path parameters

productSlugstringRequired

The product code for which details are to be fetched.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the product details

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got product detail

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/product-store/productdetail/{productSlug}

GET /backend/api/product-store/productdetail/{productSlug} HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Successfully got product detail"
}

get

/list/related-product-list

This endpoint retrieves a list of products related to the product specified by the product ID.

Query parameters

productIdstringRequired

The product ID for which related products are to be fetched.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved related products list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Related product list is successfully being shown.

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/list/related-product-list

GET /backend/api/list/related-product-list?productId=text HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Related product list is successfully being shown."
}

Get common products based on product ID

get

/store-common-product/common-product-list/{productSlug}

This endpoint retrieves a list of common products based on the product ID.

Path parameters

productSlugstringRequired

The product ID for which common products are to be fetched.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the common product list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the Product List

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/store-common-product/common-product-list/{productSlug}

GET /backend/api/store-common-product/common-product-list/{productSlug} HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Successfully got the Product List"
}

Get product attributes based on category IDs

get

/store-product-attributes

This endpoint retrieves product attributes (specifications) based on a list of category IDs.

Query parameters

categoryIdsstringRequired

A comma-separated list of category IDs for which to retrieve the product attributes (specifications).

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the product attributes

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got Specification List.

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/store-product-attributes

GET /backend/api/store-product-attributes?categoryIds=text HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Successfully got Specification List."
}

Get product rating count

get

/product-store/rating-count/{skuId}

This endpoint retrieves the rating count for a specific product using its product ID.

Path parameters

skuIdintegerRequired

The ID of the product for which the rating count is being requested.

Responses

200

Successfully retrieved the product rating count

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the product Rating.

400

Bad Request

*/*

404

Product not found

*/*

500

Internal Server Error

*/*

get

/product-store/rating-count/{skuId}

GET /backend/api/product-store/rating-count/{skuId} HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Successfully got the product Rating."
}

Get product vendor count

get

/store-common-product/vendor-count/{productId}

This endpoint retrieves the vendor count for a specific product using its product ID.

Path parameters

productIdintegerRequired

The ID of the product for which the vendor count is being requested.

Responses

200

Successfully retrieved the product vendor count

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got vendor count.

400

Bad Request

*/*

404

Product not found

*/*

500

Internal Server Error

*/*

get

/store-common-product/vendor-count/{productId}

GET /backend/api/store-common-product/vendor-count/{productId} HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Successfully got vendor count."
}

Get Cart List

get

/cart

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

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully got the cart list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the cart list

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/cart

GET /backend/api/cart HTTP/1.1
Host: 139.59.67.17
Accept: */*

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

Get Abuse Reason List

get

/store-question-answer/abuse-reason-list

This endpoint retrieves the list of available abuse reasons.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the abuse reason list

*/*

statusintegerOptional

messagestringOptional

400

Bad Request

*/*

500

Internal Server Error

*/*

get

/store-question-answer/abuse-reason-list

GET /backend/api/store-question-answer/abuse-reason-list HTTP/1.1
Host: 139.59.67.17
Accept: */*

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

Add Product to Wishlist

post

/customer/add-product-to-wishlist

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Body

productIdintegerRequiredExample: 2023

productOptionValueIdstringOptional

Responses

200

Product successfully added to wishlist

statusintegerOptionalExample: 1

messagestringOptionalExample: You have Successfully add to wishlist

400

Bad request

*/*

500

Internal server error

*/*

post

/customer/add-product-to-wishlist

POST /backend/api/customer/add-product-to-wishlist HTTP/1.1
Host: 139.59.67.17
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "productId": 2023,
  "productOptionValueId": ""
}

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

Get video preview from S3

get

/media/video-preview-s3

Fetches a video preview from an S3 bucket by specifying the video file's name and path.

Query parameters

namestringRequired

The name of the video file for preview. Example: 'Mood _ a 30-second 2D animation.mp4'.

pathstringRequired

The path in the S3 bucket where the video is stored. Example: 'video'.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully fetched the video preview

*/*

messagestringOptionalExample: Successfully fetched the video preview.

statusstringOptionalExample: 1

videoPreviewUrlstringOptionalExample: https://s3.amazonaws.com/video/Mood_a_30-second_2D_animation.mp4

400

Bad request, invalid parameters

500

Internal server error

get

/media/video-preview-s3

GET /backend/api/media/video-preview-s3?name=text&path=text HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "message": "Successfully fetched the video preview.",
  "status": "1",
  "videoPreviewUrl": "https://s3.amazonaws.com/video/Mood_a_30-second_2D_animation.mp4"
}

Get customer profile

get

/customer/get-profile

This API allows customers to retrieve their profile information.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the customer profile

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully Get the Profile.

400

Bad request

500

Internal server error

get

/customer/get-profile

GET /backend/api/customer/get-profile HTTP/1.1
Host: 139.59.67.17
Accept: */*

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

Get wishlist product list

get

/customer/wishlist-product-list

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

Query parameters

limitintegerOptional

Limit the number of products returned.

Default: 0

offsetintegerOptional

Offset for pagination.

Default: 0

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Responses

200

Successfully retrieved the wishlist product list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully show the wishlist product list

400

Bad request

500

Internal server error

get

/customer/wishlist-product-list

GET /backend/api/customer/wishlist-product-list HTTP/1.1
Host: 139.59.67.17
Accept: */*

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

Contact admin

post

/customer/admin-contact

This API allows customers to send an email to the admin with their requirements.

Header parameters

AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics

keystringOptional

The unique key for the request.

Default: 8097571064818418

languagekeystringOptional

The language key for the request.

Default: 57

Body

firstNamestringRequired

First name of the customer

lastNamestringRequired

Last name of the customer

emailIdstringRequired

Email ID of the customer

filesstring[]Optional

List of files uploaded by the customer

userRequirementsstringRequired

Requirements or message from the customer

Responses

200

Successfully sent email to admin

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Your email has been successfully sent to the admin

400

Bad request

500

Internal server error

post

/customer/admin-contact

POST /backend/api/customer/admin-contact HTTP/1.1
Host: 139.59.67.17
Content-Type: */*
Accept: */*
Content-Length: 98

{
  "firstName": "text",
  "lastName": "text",
  "emailId": "text",
  "files": [
    "text"
  ],
  "userRequirements": "text"
}

{
  "status": 1,
  "message": "Your email has been successfully sent to the admin"
}

Page List API

get

/pages

Fetch a list of pages with optional filters and pagination.

Query parameters

limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

keywordstringOptional

Search keyword for filtering pages

countintegerOptional

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

Header parameters

AuthorizationstringOptional

Optional bearer token for authentication

languageIdintegerRequired

Language ID for content localization

Responses

200

Successfully retrieved the page list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the group list

400

Invalid input

401

Unauthorized request

500

Internal server error

get

/pages

GET /backend/api/pages HTTP/1.1
Host: 139.59.67.17
languageId: 1
Accept: */*

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

Get Page Detail API

get

/pages/{slugName}

Retrieve detailed information about a page using its slug name.

Path parameters

slugNamestringRequired

The slug name of the page to fetch details for

Header parameters

AuthorizationstringOptional

Optional bearer token for authentication

languageIdintegerRequired

Language ID for content localization

Responses

200

Successfully retrieved page details

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully get page Details

400

Invalid request parameters

401

Unauthorized request

404

Page not found

500

Internal server error

get

/pages/{slugName}

GET /backend/api/pages/{slugName} HTTP/1.1
Host: 139.59.67.17
languageId: 1
Accept: */*

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

Last updated 1 year ago

hashtagGet widget list

hashtagGet Google Map API Key

hashtagGet a list of languages

hashtagGet store settings

hashtagGet list of available addons

hashtagGet list of product categories

hashtagGet count of custom products

hashtagGet product count and maximum price

hashtagGet question list based on the question ID

hashtagGet product details based on product code

hashtagGet related products based on product ID

hashtagGet common products based on product ID

hashtagGet product attributes based on category IDs

hashtagGet product rating count

hashtagGet product vendor count

hashtagGet Cart List

hashtagGet Abuse Reason List

hashtagAdd Product to Wishlist

hashtagGet video preview from S3

hashtagGet customer profile

hashtagGet wishlist product list

hashtagContact admin

hashtagPage List API

hashtagGet Page Detail API

Get widget list

Get Google Map API Key

Get a list of languages

Get store settings

Get list of available addons

Get list of product categories

Get count of custom products

Get product count and maximum price

Get question list based on the question ID

Get product details based on product code

Get related products based on product ID

Get common products based on product ID

Get product attributes based on category IDs

Get product rating count

Get product vendor count

Get Cart List

Get Abuse Reason List

Add Product to Wishlist

Get video preview from S3

Get customer profile

Get wishlist product list

Contact admin

Page List API

Get Page Detail API