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

Product Detail Page

PreviousHomeNextVendor API

Last updated 3 months ago

Get product details based on product code

get

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.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully retrieved the product details
400
Bad Request
500
Internal Server Error
get
GET /backend/api/product-store/productdetail/{productSlug} HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got product detail</message>
</object>

Get related products based on product ID

get

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.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully retrieved related products list
400
Bad Request
500
Internal Server Error
get
GET /backend/api/list/related-product-list HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Related product list is successfully being shown.</message>
</object>

Get common products based on product ID

get

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.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully retrieved the common product list
400
Bad Request
500
Internal Server Error
get
GET /backend/api/store-common-product/common-product-list/{productSlug} HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the Product List</message>
</object>

Get product attributes based on category IDs

get

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.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

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

Get product rating count

get

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
400
Bad Request
404
Product not found
500
Internal Server Error
get
GET /backend/api/product-store/rating-count/{skuId} HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the product Rating.</message>
</object>

Get product vendor count

get

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
400
Bad Request
404
Product not found
500
Internal Server Error
get
GET /backend/api/store-common-product/vendor-count/{productId} HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got vendor count.</message>
</object>

Get Abuse Reason List

get

This endpoint retrieves the list of available abuse reasons.

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 abuse reason list
400
Bad Request
500
Internal Server Error
get
GET /backend/api/store-question-answer/abuse-reason-list HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get video preview from S3

get

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.

keystringOptional

The unique key for the request.

languagekeystringOptional

The language key for the request.

Responses
200
Successfully fetched the video preview
400
Bad request, invalid parameters
500
Internal server error
get
GET /backend/api/media/video-preview-s3 HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<message>Successfully fetched the video preview.</message>
	<status>1</status>
	<videoPreviewUrl>https://s3.amazonaws.com/video/Mood_a_30-second_2D_animation.mp4</videoPreviewUrl>
</object>
  • GETGet product details based on product code
  • GETGet related products based on product ID
  • GETGet common products based on product ID
  • GETGet product attributes based on category IDs
  • GETGet product rating count
  • GETGet product vendor count
  • GETGet Abuse Reason List
  • GETGet video preview from S3