StoreHarmony API
  1. Stock Inventory
StoreHarmony API
  • Storeharmony API
  • Mobile Apps
    • Apps Registration
      • Authentication
        • Verify User Registration from a Website
        • Verify User Registration
        • Reset User Password
        • Register a new store
        • User Login For Apps
        • Authenticate User
    • Stock Inventory
      • Stock Categories
        • getStoreCategories
        • updateStoreCategory
        • createStoreCategory
        • createStoreSubCategory
        • deleteStoreCategory
        • Upload Category Picture
        • createBulkStoreCategory
      • Create Bulk Products
        POST
      • Create Product with Variants
        POST
      • Add Variants to Product
        POST
      • Upload Product Picture
        POST
      • Update Product Prices
        POST
      • Add New Quantity to Product
        POST
      • Deduct Quantity from Product
        POST
      • Creates a simple product in the inventory
        POST
      • Get Product by Item ID
        GET
      • getProductTransfers
        GET
      • acceptTransferIntoStore
        GET
      • listProductsPricesForRecentChanges
        GET
      • listProductsPrices
        GET
      • Get Inventory Stock Items
        GET
      • getProductAudit
        GET
      • findBySKU
        GET
      • Update Product
        PUT
      • Removes provided variants from provided Existing Product
        PUT
      • Add Variants to Existing Product
        POST
      • getProductsWithComplexQuery
        POST
      • Removes Product by Item ID
        DELETE
      • Add Variants to Existing Product
        GET
    • Store Admin Operations
      • Get Store User
      • Edit Store User
      • Delete a Store User
      • Get Bank Account List for the Store
      • Update Bank Account Details
      • Create Bank Account
      • Delete Bank Account
      • Add a User to Store
      • Set Default Bank
      • List all users for a Store User
      • Get Bank Account Details
      • Delete Bank Account
    • Invoicing Operations
      • createPDFInvoiceLink
  • CRM
    • Customer Registration
      • Register a new customer
      • Log in a customer
      • Verify Customer Email
      • Verify Customer Mobile
      • Reset Customer Password
  • Online Store
    • Restuarant Order Menus AppCalls
      • Place an Order
      • Submit Store Review
      • getServiceName
      • Load a Restro Store Detail
      • Restro Product Order
      • Track Order Status
      • Restro Store Tables
      • List Auto Categories
      • Restro Product Details
      • Fetch Related Products or Recommended Pairs for a Product
      • Fetch All Categories
      • Fetch All Products Belonging to a Particular Category
      • Fetch All Products by Store ID Based on Categories and Subcategories
      • Fetch All Categories and Subcategories by Store ID
    • updatesOrder
    • cancelOrder
    • postCustomerReview
    • getCustomerProfile
    • updateProfile
    • updateProfileShippingAddress
    • submitIssues
    • placeOrderToStore
    • contactStore
    • calculateOrderShipping
    • passResetting
    • getStoreInfo
    • getCustomerWalletReport
    • getRegularPurchase
    • getRecentPurchase
    • getCustomerReceipts
    • getReceiptDetails_1
    • getCustomerProfileDetails
    • getCustomerOrders
    • getOrderDetails
    • getCustomerLoyaltyReport
    • getCustomerInvoices
    • trackPayment
    • trackOrder_1
    • loadDeliverypolicy
    • listAutoCategories_1
    • getShippingRates
    • shippingInformation
    • searchProducts
    • sendReceipt
    • listStoreProductsForHome
    • loadProductByItemId_1
    • getCustomerReview
    • loadProducRecommendationsByItemId
    • loadProductBySlug
    • loadRelatedProductsByItemId
    • loadPrivacypolicy
    • searchPagedProducts
    • searchPagedProductsByPages
    • getStoreLocations
    • getGeocode
    • loadHomeBanners
    • getCountries_1
    • getCountryStates_1
    • getCountryStatesLGARegion_1
    • loadStoreCategories_1
    • loadStoreSubCategories_1
    • loadStoreAllCategoriesAndSubCategories_1
    • loadStoreBanners
    • verifyMobile_1
    • verifyEmail
    • loadAboutUs
    • Log in a customer with token
    • Log in a customer
    • Register a new customer
  • User Operations
    • Get User Information
    • Update User Information
    • Set Default Wallet Bank Account
    • Set VAT, VAT Type and currency etc used for business activities in this location
    • Set a particular location as the default store used for business activities
    • Retrieve Profile Image
    • Upload Profile Image
    • Log a User Complaint
    • createNewStoreLocation
    • Change User Password
    • Get the details, settings and important parameters for a store location
    • Get Bank Account Details
    • Switch account to another store location
    • Get User Store Locations
  • Data Sources & Reports
    • getSalesReportsDetails
    • getSalesReports
    • Sales Report with products sold
    • Sales Report by Criteria
    • Track Sales By Receipt
    • getCustomerDataSet
  • Utility Operations
    • Create PDF Invoice Link
    • Load Store Credentials By ID
    • Verify Mobile Number
    • Verify Email Address
    • Retrieve Store Profiles
    • Retrieve List of Roles
    • Retrieve Registered Nigerian Banks. Only Supports Nigerian Banks
    • Lookup Bank Account Details
    • Retrieve List of Countries
    • Retrieve States in a Country
    • Retrieve Regions within a State
  • Payments & Webhooks
    • reversalMerchantPOSTerminal_1
    • payViaMerchantPOSTerminal_1
    • Creates a bank transfer account
  • Webhooks & Operations
    • reversalMerchantPOSTerminal
    • payViaMerchantPOSTerminal
  1. Stock Inventory

Get Inventory Stock Items

GET
/app/{storeid}/stock/items
Stock Inventory Basic Functions
Returns a list of inventory stock items for the specified store.

Request

Path Params
storeid
string 
required
ID of the store
Query Params
customerid
string 
optional
Customer ID for filtering products
pagesize
string 
optional
Number of products per page
Default:
50
page
string 
optional
Page number for pagination
Default:
0
category
string 
optional
Category to filter products
search
string 
optional
Search term to filter products
filter
string 
optional
Additional filters for products
sortby
string 
optional
Sort by specific field
Header Params
sessiontoken
string 
required
Session token for authentication

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://gateway.storeharmony.com/cloudapi/app//stock/items' \
--header 'sessiontoken;'

Responses

🟢200OK
*/*
Successfully retrieved the list of products.
Body
total
integer <int32>
optional
page
integer <int32>
optional
totalCount
number <double>
optional
totalCostWorth
integer <int64>
optional
totalSalesWorth
integer <int64>
optional
totalSkuVolume
integer <int64>
optional
queryStartDate
string 
optional
queryEndDate
string 
optional
pagesize
integer <int32>
optional
querystr
string 
optional
categoryName
string 
optional
categoryId
string 
optional
groupPicture
string 
optional
refreshSite
boolean 
optional
expiredStore
boolean 
optional
remarks
string 
optional
items
array[object (Product) {26}] 
optional
itemId
string 
optional
slug
string 
optional
itemName
string 
optional
itemBarcode
string 
optional
itemForm
string 
optional
itemPictureId1
string 
optional
itemPictureId2
string 
optional
category
string 
optional
manufacturer
string 
optional
color
string 
optional
size
string 
optional
price
integer <int64>
optional
taxable
boolean 
optional
promoprice
integer <int64>
optional
unitsOfMeasure
string 
optional
inStock
boolean 
optional
minOrder
number <double>
optional
addedBy
string 
optional
addedDate
string <date-time>
optional
expireDate
string <date-time>
optional
batchNo
string 
optional
maxOrder
integer <int32>
optional
availableQty
number <double>
optional
aboutItem
string 
optional
tags
string 
optional
specification
array [array] 
optional
Example
{
  "total": 0,
  "page": 0,
  "totalCount": 0,
  "totalCostWorth": 0,
  "totalSalesWorth": 0,
  "totalSkuVolume": 0,
  "queryStartDate": "string",
  "queryEndDate": "string",
  "pagesize": 0,
  "querystr": "string",
  "categoryName": "string",
  "categoryId": "string",
  "groupPicture": "string",
  "refreshSite": true,
  "expiredStore": true,
  "remarks": "string",
  "items": [
    {
      "itemId": "string",
      "slug": "string",
      "itemName": "string",
      "itemBarcode": "string",
      "itemForm": "string",
      "itemPictureId1": "string",
      "itemPictureId2": "string",
      "category": "string",
      "manufacturer": "string",
      "color": "string",
      "size": "string",
      "price": 0,
      "taxable": true,
      "promoprice": 0,
      "unitsOfMeasure": "string",
      "inStock": true,
      "minOrder": 0,
      "addedBy": "string",
      "addedDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "batchNo": "string",
      "maxOrder": 0,
      "availableQty": 0,
      "aboutItem": "string",
      "tags": "string",
      "specification": [
        [
          "string"
        ]
      ]
    }
  ]
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Modified at 2025-03-27 14:31:04
Previous
listProductsPrices
Next
getProductAudit
Built with