Product List | Spurtcommerce

Document API Reference Add-ons

Get Product Details

get

Retrieves details of a specific product by its ID.

Path parameters

idintegerRequired

The ID of the product to retrieve details for

Header parameters

AuthorizationstringRequired

Responses

200

Successfully retrieved product details.

400

Bad Request

401

Unauthorized

404

Product not found

500

Internal Server Error

get

GET /backend/api/vendor-product/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get productDetail</message>
</object>

Delete a Product

delete

Deletes a product by its ID.

Path parameters

idintegerRequired

The ID of the product to delete

Header parameters

AuthorizationstringRequired

Responses

200

Product deleted successfully.

400

Bad Request

401

Unauthorized

404

Product not found

500

Internal Server Error

delete

DELETE /backend/api/vendor-product/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted your product</message>
</object>

get

Header parameters

AuthorizationstringRequired

Responses

200

Successfully retrieved vendor category list

400

Bad Request

401

Unauthorized

500

Internal Server Error

get

GET /backend/api/vendor-product/vendor-category-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the vendor category list</message>
</object>

Retrieve specification list by category ID

get

Query parameters

categoryIdsintegerRequired

Category IDs to filter the specification list

Header parameters

AuthorizationstringRequired

Responses

200

Successfully retrieved specification list

400

Bad Request

401

Unauthorized

500

Internal Server Error

get

GET /backend/api/specification HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got Specification List.</message>
</object>

Retrieve all tax list

get

Header parameters

AuthorizationstringRequired

Responses

200

Successfully retrieved all tax list

400

Bad Request

401

Unauthorized

500

Internal Server Error

get

GET /backend/api/tax/tax-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully get all tax list</message>
</object>

Update attribute keyword for a vendor product

put

Updates the attribute keyword for the specified product based on the attribute slug.

Path parameters

idintegerRequired

The ID of the product for which the attribute keyword needs to be updated

Header parameters

AuthorizationstringRequired

Responses

200

Successfully updated attribute keyword.

400

Bad request. Invalid data or missing parameters.

401

Unauthorized. Authentication required.

put

PUT /backend/api/vendor-product-specification/attribute-slug/product/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Updated Attribute keyword.</message>
</object>

Get Vendor Specification Family List API

get

This API retrieves a list of vendor specification families with optional pagination.

Query parameters

limitnumberOptional

Number of records to return.

offsetnumberOptional

Number of records to skip.

countnumberOptional

If set to 1, returns only the count.

Responses

200

Successfully fetched vendor specification family list.

*/*

500

Failed to fetch vendor specification family list.

*/*

get

GET /backend/api/api/vendor-specification/vendor-family HTTP/1.1
Host: 139.59.67.17
Accept: */*

{
  "status": 1,
  "message": "Successfully fetched vendor specification family list.",
  "data": [
    {
      "createdBy": "text",
      "createdDate": "text",
      "modifiedBy": "text",
      "modifiedDate": "text",
      "id": "text",
      "familyName": "text",
      "isActive": true,
      "isDelete": true
    }
  ]
}

get

This API retrieves a list of vendor categories with optional filters and pagination.

Query parameters

limitnumberOptional

Number of records to return.

offsetnumberOptional

Number of records to skip.

keywordstringOptional

Keyword to filter categories.

familyIdnumberOptional

Family ID to filter categories.

countbooleanOptional

If set to true, returns only the count of categories.

Responses

200

Successfully retrieved the vendor category list.

*/*

500

Failed to fetch vendor category list.

*/*

get

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

{
  "status": 1,
  "message": "Successfully got the vendor category list.",
  "data": [
    {
      "categoryId": "text",
      "sortOrder": "text",
      "parentInt": "text",
      "categoryName": "text",
      "levels": "text"
    }
  ]
}

Get vendor product list

get

Query parameters

limitintegerOptional

offsetintegerOptional

keywordstringOptional

countintegerOptional

sortBystringOptional

sortOrderstringOptional

productNamestringOptional

pricestringOptional

statusstringOptional

approvalFlagstringOptional

Header parameters

AuthorizationstringRequired

Responses

200

Successfully got your product list.

400

Bad Request

401

Unauthorized

500

Internal Server Error

get

GET /backend/api/vendor-product/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

No content

Create a vendor product

post

Creates a new product or updates an existing product in the vendor's catalog.

Header parameters

AuthorizationstringRequired

Body

productTypestringRequired

1 or 2

productNamestringRequired

Name of the product (max 255 characters)

productDescriptionstringOptional

Detailed description of the product

skustringRequired

Stock Keeping Unit (SKU) (max 64 characters)

upcstringOptional

Universal Product Code

hsnstringOptional

Harmonized System Nomenclature

productSlugstringOptional

URL-friendly identifier for the product

quantityinteger · int32Required

Available stock quantity

categoryIdinteger[]Required

Array of category IDs

imagestringRequired

URL or path to the product image

pricenumber · floatRequired

Price of the product

locationstringOptional

Location of the product

outOfStockStatusinteger · int32Optional

Status indicating if the product is out of stock

requiredShippinginteger · int32Optional

Flag indicating if shipping is required

dateAvailablestring · date-timeOptional

Date when the product is available

sortOrderinteger · int32 · max: 9999Optional

Sorting order of the product (max 4 digits)

defaultImageinteger · int32Optional

Flag indicating the default image

relatedProductIdstringOptional

Comma-separated list of related product IDs

packingCostnumber · floatOptional

Packing cost of the product

shippingCostnumber · floatOptional

Shipping cost of the product

taxnumber · floatOptional

Tax applied to the product

taxTypeinteger · int32Optional

Type of tax applied to the product

othersnumber · floatOptional

Other charges applied to the product

productHighlightsstringOptional

Highlights of the product

productDiscountnumber[]Optional

Discounts applied to the product

productSpecialnumber[]Optional

Special attributes for the product

tirePricesnumber[]Optional

Tiered pricing for the product

hasTirePriceinteger · int32Optional

Flag indicating if tiered pricing is available

widthstringOptional

Width of the product

heightstringOptional

Height of the product

statusinteger · int32Optional

Status of the product (e.g., active or inactive)

weightstringOptional

Weight of the product

lengthstringOptional

Length of the product

fileNamestringOptional

File name for the product

containerNamestringOptional

Container name for storing product data

Responses

200

Product created or updated successfully.

400

Bad request. Invalid input data.

500

Internal server error.

post

POST /backend/api/vendor-product/ HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 629

"productType='text'&productName='text'&productDescription='text'&sku='text'&upc='text'&hsn='text'&productSlug='text'&quantity=1&categoryId=[1]&image='text'&price=1&location='text'&outOfStockStatus=1&requiredShipping=1&dateAvailable='2025-06-18T05:56:13.163Z'&sortOrder=1&defaultImage=1&relatedProductId='text'&packingCost=1&shippingCost=1&tax=1&taxType=1&others=1&productHighlights='text'&productDiscount=[1]&productSpecial=[1]&tirePrices=[1]&hasTirePrice=1&width='text'&height='text'&status=1&weight='text'&length='text'&fileName='text'&containerName='text'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created seller product</message>
</object>

Create SEO for a vendor product

post

Path parameters

productIdintegerRequired

The ID of the product for which SEO needs to be created

Header parameters

AuthorizationstringRequired

Body

metaTagTitlestringOptional

SEO meta title for the product

metaTagDescriptionstringOptional

SEO meta description for the product

metaTagKeywordstringOptional

SEO meta keywords for the product

Responses

200

SEO created successfully.

400

Bad Request

401

Unauthorized

500

Internal Server Error

post

POST /backend/api/vendor-product-seo/{productId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 75

"metaTagTitle='text'&metaTagDescription='text'&metaTagKeyword='text'"

No content

Create product specifications

post

This endpoint allows you to save product specifications for a given product.

Body

productIdinteger · int32Required

The ID of the product for which the specifications are being set

productSpecificationsstringRequired

Product specifications as a JSON string

Responses

200

Product specification successfully saved

400

Bad Request. The data provided is not valid.

500

Internal Server Error.

post

POST /backend/api/vendor-product-specification HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 46

"productId=1&productSpecifications='text'"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Saved Product Specification.</message>
</object>