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 Core API
  2. Vendor API

Manage catalogue

Last updated 2 years ago

Vendor product list

get

List of vendor product

Query parameters
limitintegerOptional
offsetintegerOptional
statusstringOptional
keywordstringOptional
pricestringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /vendor-product/vendor-product-list HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got Vendor Product list. \" or \" Successfully got your product list."
}

Vendor product delete

delete

Delete a vendor product

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
application/json
400
error response
application/json
delete
DELETE /vendor-product/delete-product/{id} HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "Successfully deleted your product"
}

Vendor product detail

get

Get vendor product detail

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
400
error response
*/*
get
GET /vendor-product/vendor-product-detail/{id} HTTP/1.1
Host: 
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "Successfully get productDetail"
}

Get vendor product excel list

get

Get excel list of vendor product

Query parameters
productIdstringOptional
Header parameters
AuthorizationstringRequired
Responses
400
error response
*/*
get
GET /vendor-product/vendor-product-excel-list HTTP/1.1
Host: 
Authorization: text
Accept: */*
400

error response

{
  "status": 1,
  "message": "Invalid productId"
}

Vendor product count

get

Get count of vendor product

Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /vendor-product/product-counts HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully get Today Product count"
}

inventory vendor product list

get

Get inventory list of vendor product

Query parameters
limitintegerOptional
offsetintegerOptional
keywordstringOptional
skustringOptional
statusstringOptional
priceintegerOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /vendor-product/inventory-vendor-product-list HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got Vendor Product list. \" or \" Successfully got the complete product list."
}

Excel product list

get

Excel list of product

Query parameters
productIdstringRequired
Header parameters
AuthorizationstringRequired
Responses
400
error response
*/*
get
GET /vendor-product/product-excel-list?productId=text HTTP/1.1
Host: 
Authorization: text
Accept: */*
400

error response

{
  "status": 1,
  "message": "Invalid productId"
}

All product excel list

get

Excel list of all product

Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /vendor-product/allproduct-excel-list HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got the excel list of all product"
}

Vendor Category List

get

List of vendor category

Query parameters
limitintegerOptional
offsetintegerOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200
success response
*/*
get
GET /vendor-product/vendor-category-list HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got the vendor category list."
}
  • POSTCreate vendor product
  • PUTUpdate vendor product
  • GETVendor product list
  • DELETEVendor product delete
  • POSTDelete multiple vendor products
  • GETVendor product detail
  • PUTAdd vendor product status
  • GETGet vendor product excel list
  • GETVendor product count
  • PUTUpdate quotation available
  • GETinventory vendor product list
  • POSTUpdate stock
  • GETExcel product list
  • GETAll product excel list
  • GETVendor Category List

Create vendor product

post

Add a vendor product

Header parameters
AuthorizedstringRequired
Body
productNamestringOptional
productDescriptionstringOptional
skustringOptional
upcstringOptional
hsnstringOptional
productSlugstringOptional
quantityinteger · int32Optional
categoryIdinteger[]Optional
imagestringOptional
priceinteger · int32Optional
locationstringOptional
outOfStockStatusinteger · int32Optional
requiredShippinginteger · int32Optional
dateAvailablestringOptional
sortOrderinteger · int32Optional
defaultImageinteger · int32Optional
relatedProductIdstringOptional
packingCostinteger · int32Optional
shippingCostinteger · int32Optional
taxinteger · int32Optional
taxTypeinteger · int32Optional
othersinteger · int32Optional
productDiscountinteger[]Optional
productSpecialinteger[]Optional
tirePricesinteger[]Optional
hasTirePriceinteger · int32Optional
Responses
200
success response
application/json
400
error response
application/json
post
POST /vendor-product/create-vendor-product HTTP/1.1
Host: 
Authorized: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 507

"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='text'&sortOrder=1&defaultImage=1&relatedProductId='text'&packingCost=1&shippingCost=1&tax=1&taxType=1&others=1&productDiscount=[1]&productSpecial=[1]&tirePrices=[1]&hasTirePrice=1&productVideo=[{'name':'text','path':'text','type':'text'}]"
{
  "name": "text",
  "description": "text",
  "productSlug": "text",
  "sku": "text",
  "upc": "text",
  "hsn": "text",
  "quantity": 1,
  "serviceCharges": "text",
  "price": 1,
  "taxType": 1,
  "taxValue": 1,
  "stockStatusId": 1,
  "shipping": "text",
  "skuId": 1,
  "dateAvailable": "text",
  "hasTirePrice": 1,
  "isActive": 1,
  "sortOrder": 1,
  "keywords": "text",
  "owner": 1,
  "createdBy": 1,
  "width": 1,
  "height": 1,
  "weight": 1,
  "length": 1,
  "createdDate": "2025-06-18T12:29:21.471Z",
  "productId": 1,
  "isSimplified": 1,
  "modifiedDate": "2025-06-18T12:29:21.471Z"
}

Update vendor product

put

Update a vendor product

Path parameters
idintegerRequired
Header parameters
AuthorizedstringRequired
Body
productNamestringOptional
productDescriptionstringOptional
skustringOptional
upcstringOptional
hsnstringOptional
productSlugstringOptional
quantityinteger · int32Optional
categoryIdinteger[]Optional
imagestringOptional
priceinteger · int32Optional
locationstringOptional
outOfStockStatusinteger · int32Optional
requiredShippinginteger · int32Optional
dateAvailablestringOptional
sortOrderinteger · int32Optional
defaultImageinteger · int32Optional
relatedProductIdstringOptional
packingCostinteger · int32Optional
shippingCostinteger · int32Optional
taxinteger · int32Optional
taxTypeinteger · int32Optional
othersinteger · int32Optional
productDiscountinteger[]Optional
productSpecialinteger[]Optional
tirePricesinteger[]Optional
hasTirePriceinteger · int32Optional
Responses
200
success response
application/json
400
error response
application/json
put
PUT /vendor-product/update-vendor-product/{id} HTTP/1.1
Host: 
Authorized: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 507

"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='text'&sortOrder=1&defaultImage=1&relatedProductId='text'&packingCost=1&shippingCost=1&tax=1&taxType=1&others=1&productDiscount=[1]&productSpecial=[1]&tirePrices=[1]&hasTirePrice=1&productVideo=[{'name':'text','path':'text','type':'text'}]"
{
  "status": 1,
  "message": "Successfully updated your product"
}

Delete multiple vendor products

post

Delete multiple vendor products

Header parameters
AuthorizationstringRequired
Body
productIdstringOptional
Responses
200
success response
application/json
400
error response
application/json
post
POST /vendor-product/delete-product HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 20

"productId='text'"
{
  "status": 1,
  "message": "Successfully deleted Product"
}

Add vendor product status

put

Add a vendor product status

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
statusinteger · int32Required
Responses
200
success response
application/json
400
error response
application/json
put
PUT /vendor-product/add-vendor-product-status/{id} HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 12

"status=1"
{
  "createdBy": 1,
  "createdDate": "2025-06-18T12:29:21.471Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-06-18T12:29:21.471Z",
  "productId": 1,
  "sku": "text",
  "upc": "text",
  "hsn": "text",
  "location": "text",
  "quantity": 1,
  "minimumQuantity": 1,
  "subtractStock": 1,
  "stockStatusId": 1,
  "quotationAvailable": 1,
  "image": "text",
  "imagePath": "text",
  "manufacturerId": 1,
  "shipping": 1,
  "serviceCharges": "text",
  "taxType": 1,
  "taxValue": 1,
  "price": "text",
  "priceUpdateFileLogId": 1,
  "dateAvailable": "text",
  "sortOrder": 1,
  "name": "text",
  "description": "text",
  "amount": 1,
  "keywords": "text",
  "discount": 1,
  "deleteFlag": 1,
  "isFeatured": 1,
  "todayDeals": 1,
  "condition": 1,
  "rating": 1,
  "wishListStatus": 1,
  "productSlug": "text",
  "isActive": 1,
  "width": "text",
  "height": "text",
  "length": "text",
  "weight": "text",
  "hasStock": 1,
  "isSimplified": 1,
  "owner": 1,
  "isCommon": 1,
  "skuId": 1,
  "hasTirePrice": 1,
  "outOfStockThreshold": 1,
  "notifyMinQuantity": 1,
  "minQuantityAllowedCart": 1,
  "maxQuantityAllowedCart": 1,
  "enableBackOrders": 1,
  "pincodeBasedDelivery": 1,
  "attributeKeyword": "text",
  "settedAsCommonOn": "text"
}

Update quotation available

put

Update quotation available

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
quotationAvailableinteger · int32Required
Responses
200
success response
application/json
400
error response
application/json
put
PUT /vendor-product/update-quotation-available/{id} HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 24

"quotationAvailable=1"
{
  "createdBy": 1,
  "createdDate": "2025-06-18T12:29:21.471Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-06-18T12:29:21.471Z",
  "vendorProductId": 1,
  "productId": 1,
  "vendorId": 1,
  "approvalFlag": 1,
  "quotationAvailable": 1,
  "approvedBy": 1,
  "approvedDate": "text",
  "vendorProductCommission": 1,
  "pincodeBasedDelivery": 1,
  "sku_id": 1,
  "reuse": 1,
  "reuseStatus": 1
}

Update stock

post

Update a stock

Header parameters
AuthorizedstringRequired
Body
productIdinteger · int32Optional
hasStockinteger · int32Optional
Responses
200
success response
application/json
400
error response
application/json
post
POST /vendor-product/update-stock HTTP/1.1
Host: 
Authorized: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 178

"productId=1&hasStock=1&productStock=[{'skuId':1,'outOfStockThreshold':1,'notifyMinQuantity':1,'minQuantityAllowedCart':1,'maxQuantityAllowedCart':1,'enableBackOrders':1}]"
{
  "createdBy": 1,
  "createdDate": "2025-06-18T12:29:21.471Z",
  "modifiedBy": 1,
  "modifiedDate": "2025-06-18T12:29:21.471Z",
  "productId": 1,
  "sku": "text",
  "upc": "text",
  "hsn": "text",
  "location": "text",
  "quantity": 1,
  "minimumQuantity": 1,
  "subtractStock": 1,
  "stockStatusId": 1,
  "quotationAvailable": 1,
  "image": "text",
  "imagePath": "text",
  "manufacturerId": 1,
  "shipping": 1,
  "serviceCharges": "text",
  "taxType": 1,
  "taxValue": 1,
  "price": "text",
  "priceUpdateFileLogId": 1,
  "dateAvailable": "text",
  "sortOrder": 1,
  "name": "text",
  "description": "text",
  "amount": "text",
  "keywords": "text",
  "discount": "text",
  "deleteFlag": 1,
  "isFeatured": 1,
  "todayDeals": 1,
  "condition": 1,
  "rating": "text",
  "wishListStatus": 1,
  "productSlug": "text",
  "isActive": 1,
  "width": "text",
  "height": "text",
  "length": "text",
  "weight": "text",
  "hasStock": 1,
  "isSimplified": 1,
  "owner": 1,
  "isCommon": 1,
  "skuId": 1,
  "hasTirePrice": 1,
  "outOfStockThreshold": 1,
  "notifyMinQuantity": 1,
  "minQuantityAllowedCart": 1,
  "maxQuantityAllowedCart": 1,
  "enableBackOrders": 1,
  "pincodeBasedDelivery": 1,
  "attributeKeyword": "text",
  "settedAsCommonOn": 1
}