Spurtcommerce
DocumentAPI ReferenceAdd-ons
API Reference
API Reference
  • About Spurtcommerce APIs
  • Spurtcommerce
    • Admin API
      • Admin
        • Authentication
        • My Profile
        • Support
      • Buyers
        • Manage Buyer
      • Chat
      • CMS
        • Manage Banner
        • Manage Blogs
        • Manage Pages
        • Manage SEO
      • Dashboard
      • Marketing
        • Manage Cross Selling
          • Related Products
        • Manage Promotions
          • Coupon
      • Marketplace
        • Manage Products
        • Manage Sales
        • Manage Settlements
        • Product Configuration
        • Reports
      • Sellers
        • Seller
        • Seller Group
        • Seller KYC Request
      • Settings
        • Add-ons
        • Add-ons Product Attributes
        • Localization
        • Order Fulfilment Status
        • Personalise
        • Site Settings
        • Store Settings
        • System
        • User and Permission
        • Support-Category
    • Store API
      • Account Settings
        • Customer
        • My Order
        • My Quotation
        • My Wishlist
        • Profile
        • Support
      • Checkouts
      • Store
        • Admin Contact
        • Categories
        • Home
        • Product Detail Page
    • Vendor API
      • Page 1
      • Catalogue
        • Bulk Product Imports
          • Custom
          • Standard
        • Common Product
        • Data Export
        • Pricing
        • Product Localisation
        • Product List
        • Product Variants
        • Related Products
      • CRM
        • Customer
        • Customer Group
        • Question and Answer
        • Rating and Review
      • Dashboard
      • Marketing
      • Payments
        • Archeived Payments
        • Earnings
        • Settlements
      • Profile
        • Account Settings
          • My Business
          • My KYC
          • My Profile
          • My Shop
          • Personalised Setting
        • Chat
        • Vendor
        • Support
      • Reports
      • Sales
        • Archeive Orders
        • Back Orders
        • Failed Orders
        • Orders
        • Quotation Request
        • Stock Update
        • Variant Stock Update
      • Supplier
        • Contact
        • Supplier
Powered by GitBook
On this page
  1. Spurtcommerce
  2. Store API
  3. Store

Home

PreviousCategoriesNextProduct Detail Page

Last updated 4 months ago

Get widget list

get

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.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully retrieved the widget list.
400
Bad Request
500
Internal Server Error
get
GET /backend/api/list/widget-list HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got widget list</message>
</object>

Get Google Map API Key

get

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.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully retrieved the Google Map API key URL.
400
Bad Request
500
Internal Server Error
get
GET /backend/api/list/gmap-key HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Redirect to this url</message>
</object>

Get a list of languages

get

This endpoint retrieves a list of all available languages.

Query parameters
limitintegerOptional

Number of languages to retrieve.

offsetintegerOptional

Starting point to retrieve languages.

keywordstringOptional

Filter languages based on keyword search.

countintegerOptional

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

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully retrieved the language list.
400
Bad Request
500
Internal Server Error
get
GET /backend/api/list/language HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete language list</message>
</object>

Get store settings

get

This endpoint retrieves the store settings for a given industry.

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully retrieved the store settings.
400
Bad Request due to invalid parameters.
500
Internal Server Error
get
GET /backend/api/settings/store-setting HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got settings</message>
</object>

Get list of available addons

get

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.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully retrieved the addons list.
400
Bad Request
500
Internal Server Error
get
GET /backend/api/list/addons HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get the list</message>
</object>

Get Cart List

get

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.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully got the cart list
400
Bad Request
500
Internal Server Error
get
GET /backend/api/cart HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the cart list</message>
</object>

Get customer profile

get

This API allows customers to retrieve their profile information.

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully retrieved the customer profile
400
Bad request
500
Internal server error
get
GET /backend/api/customer/get-profile HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Get the Profile.</message>
</object>

Get wishlist product list

get

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

Query parameters
limitintegerOptional

Limit the number of products returned.

offsetintegerOptional

Offset for pagination.

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully retrieved the wishlist product list
400
Bad request
500
Internal server error
get
GET /backend/api/customer/wishlist-product-list HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully show the wishlist product list</message>
</object>

Page List API

get

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
400
Invalid input
401
Unauthorized request
500
Internal server error
get
GET /backend/api/pages HTTP/1.1
Host: 139.59.67.17
languageId: 1
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the group list</message>
</object>

Get Page Detail API

get

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
400
Invalid request parameters
401
Unauthorized request
404
Page not found
500
Internal server error
get
GET /backend/api/pages/{slugName} HTTP/1.1
Host: 139.59.67.17
languageId: 1
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get page Details</message>
</object>
  • GETGet widget list
  • GETGet Google Map API Key
  • GETGet a list of languages
  • GETGet store settings
  • GETGet list of available addons
  • GETGet Cart List
  • POSTAdd Product to Wishlist
  • GETGet customer profile
  • GETGet wishlist product list
  • GETPage List API
  • GETGet Page Detail API

Add Product to Wishlist

post
Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Body
productIdintegerRequiredExample: 2023
productOptionValueIdstringOptional
Responses
200
Product successfully added to wishlist
400
Bad request
500
Internal server error
post
POST /backend/api/customer/add-product-to-wishlist HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 44

"productId=2023&productOptionValueId=''"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>You have Successfully add to wishlist</message>
</object>