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. Vendor API
  3. Sales

Stock Update

PreviousQuotation RequestNextVariant Stock Update

Last updated 4 months ago

  • GETRetrieve Vendor Product Inventory List
  • POSTUpdate Stock for a Product

Retrieve Vendor Product Inventory List

get

This endpoint retrieves the list of products in the vendor's inventory with the ability to filter by parameters like limit, offset, current page, and count.

Query parameters
limitintegerOptional

The number of items to retrieve per page

Default: 10
offsetintegerOptional

The number of items to skip before starting to collect the result set

Default: 0
currentPageintegerOptional

Current page number for pagination

Default: 1
countbooleanOptional

Indicates whether the response should include the total count

Default: false
Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200
Successfully retrieved the vendor product inventory list
400
Invalid request parameters
500
Internal server error
get
GET /backend/api/vendor-product/inventory-vendor-product-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete product list</message>
</object>

Update Stock for a Product

post

This endpoint updates the stock information for a given product. The details include stock quantity, SKU, back-order settings, and other stock-related parameters.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
productIdinteger · int32Required

The ID of the product

hasStockinteger · int32Required

Whether the product has stock or not

skuIdinteger · int32Required

The SKU ID for the product

outOfStockThresholdinteger · int32Optional

Threshold when the product will be considered out of stock

notifyMinQuantityinteger · int32Optional

Minimum quantity to notify when stock is low

minQuantityAllowedCartinteger · int32Optional

Minimum quantity allowed in the cart

maxQuantityAllowedCartinteger · int32Optional

Maximum quantity allowed in the cart

enableBackOrdersstringOptional

Whether backorders are allowed for the product

backOrderStockLimitstringOptional

The limit for backorder stock

Responses
200
Successfully updated the stock information
400
Invalid request data
500
Internal server error
post
POST /backend/api/vendor-product/update-stock HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 193

"productId=1&hasStock=1&skuId=1&outOfStockThreshold=1&notifyMinQuantity=1&minQuantityAllowedCart=1&maxQuantityAllowedCart=1&enableBackOrders='text'&backOrderStockLimit='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>