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 Product by Item ID

GET
/app/{storeid}/stock/{itemid}
Stock Inventory Basic Functions
Retrieves the details of a product using its item ID.

Request

Path Params
storeid
string 
required
ID of the store
itemid
string 
required
Item ID of the product to retrieve
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/' \
--header 'sessiontoken;'

Responses

🟢200OK
*/*
Successfully retrieved the product details.
Body
status
string 
optional
slug
string 
optional
itemName
string 
optional
tracingId
string 
optional
price
integer <int64>
optional
costPrice
integer <int64>
optional
promoprice
integer <int64>
optional
imgUrl
array[string]
optional
barcode
string 
optional
inStock
boolean 
optional
serviceItem
boolean 
optional
specification
array [array] 
optional
string 
optional
location
string 
optional
unitsOfMeasure
string 
optional
quota
integer <int32>
optional
weightMilligram
number <double>
optional
itemWidth
number <double>
optional
dimUnit
string 
optional
colorProfile
string 
optional
shippingFeeType
string 
optional
itemLength
number <double>
optional
itemHeight
number <double>
optional
pictures
array[string]
optional
productRating
integer <int32>
optional
expireDate
string <date-time>
optional
topCategory
string 
optional
restrictedAreas
array [object] 
optional
subCategory
string 
optional
manufacturer
string 
optional
detailsInfo
string 
optional
otherInfo
string 
optional
storeId
string 
optional
deliveryMode
integer <int32>
optional
availableQty
number <double>
optional
lastUpdatedBy
string 
optional
dateRemark
string 
optional
minimumOrder
number <double>
optional
bookingSupported
boolean 
optional
deliveryPeriod
integer <int32>
optional
aboutItem
string 
optional
addedToWishList
boolean 
optional
taxable
boolean 
optional
productWriteUp
string 
optional
reviews
array[object (UserReview) {7}] 
optional
customerId
string 
optional
customerName
string 
optional
productId
string 
optional
comment
string 
optional
date
string 
optional
rating
integer <int32>
optional
reviewId
string 
optional
auditlog
array[object (AuditFlowDateGroup) {5}] 
optional
volume
number <double>
optional
count
integer <int64>
optional
auditType
string 
optional
totalValue
integer <int64>
optional
date
string <date-time>
optional
variants
array[string]
optional
relatedProducts
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
tags
array[string]
optional
negotiable
boolean 
optional
negotiation
object (Negotiation) 
optional
exists
boolean 
optional
expireDate
string <date-time>
optional
acceptedPrice
integer <int64>
optional
customerId
string 
optional
negotiatedPrice
integer <int64>
optional
accepted
boolean 
optional
Example
{
  "status": "string",
  "slug": "string",
  "itemName": "string",
  "tracingId": "string",
  "price": 0,
  "costPrice": 0,
  "promoprice": 0,
  "imgUrl": [
    "string"
  ],
  "barcode": "string",
  "inStock": true,
  "serviceItem": true,
  "specification": [
    [
      "string"
    ]
  ],
  "location": "string",
  "unitsOfMeasure": "string",
  "quota": 0,
  "weightMilligram": 0,
  "itemWidth": 0,
  "dimUnit": "string",
  "colorProfile": "string",
  "shippingFeeType": "string",
  "itemLength": 0,
  "itemHeight": 0,
  "pictures": [
    "string"
  ],
  "productRating": 0,
  "expireDate": "2019-08-24T14:15:22Z",
  "topCategory": "string",
  "restrictedAreas": [
    {}
  ],
  "subCategory": "string",
  "manufacturer": "string",
  "detailsInfo": "string",
  "otherInfo": "string",
  "storeId": "string",
  "deliveryMode": 0,
  "availableQty": 0,
  "lastUpdatedBy": "string",
  "dateRemark": "string",
  "minimumOrder": 0,
  "bookingSupported": true,
  "deliveryPeriod": 0,
  "aboutItem": "string",
  "addedToWishList": true,
  "taxable": true,
  "productWriteUp": "string",
  "reviews": [
    {
      "customerId": "string",
      "customerName": "string",
      "productId": "string",
      "comment": "string",
      "date": "string",
      "rating": 0,
      "reviewId": "string"
    }
  ],
  "auditlog": [
    {
      "volume": 0,
      "count": 0,
      "auditType": "string",
      "totalValue": 0,
      "date": "2019-08-24T14:15:22Z"
    }
  ],
  "variants": [
    "string"
  ],
  "relatedProducts": [
    {
      "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"
        ]
      ]
    }
  ],
  "tags": [
    "string"
  ],
  "negotiable": true,
  "negotiation": {
    "exists": true,
    "expireDate": "2019-08-24T14:15:22Z",
    "acceptedPrice": 0,
    "customerId": "string",
    "negotiatedPrice": 0,
    "accepted": true
  }
}
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-03-27 14:31:04
Previous
Creates a simple product in the inventory
Next
getProductTransfers
Built with