StoreHarmony API
  1. User Operations
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
      • Create Product with Variants
      • Add Variants to Product
      • Upload Product Picture
      • Update Product Prices
      • Add New Quantity to Product
      • Deduct Quantity from Product
      • Creates a simple product in the inventory
      • Get Product by Item ID
      • getProductTransfers
      • acceptTransferIntoStore
      • listProductsPricesForRecentChanges
      • listProductsPrices
      • Get Inventory Stock Items
      • getProductAudit
      • findBySKU
      • Update Product
      • Removes provided variants from provided Existing Product
      • Add Variants to Existing Product
      • getProductsWithComplexQuery
      • Removes Product by Item ID
      • Add Variants to Existing Product
    • 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
      PUT
    • cancelOrder
      DELETE
    • postCustomerReview
      POST
    • getCustomerProfile
      GET
    • updateProfile
      POST
    • updateProfileShippingAddress
      POST
    • submitIssues
      POST
    • placeOrderToStore
      POST
    • contactStore
      POST
    • calculateOrderShipping
      POST
    • passResetting
      POST
    • getStoreInfo
      GET
    • getCustomerWalletReport
      GET
    • getRegularPurchase
      GET
    • getRecentPurchase
      GET
    • getCustomerReceipts
      GET
    • getReceiptDetails_1
      GET
    • getCustomerProfileDetails
      GET
    • getCustomerOrders
      GET
    • getOrderDetails
      GET
    • getCustomerLoyaltyReport
      GET
    • getCustomerInvoices
      GET
    • trackPayment
      GET
    • trackOrder_1
      GET
    • loadDeliverypolicy
      GET
    • listAutoCategories_1
      GET
    • getShippingRates
      GET
    • shippingInformation
      GET
    • searchProducts
      GET
    • sendReceipt
      GET
    • listStoreProductsForHome
      GET
    • loadProductByItemId_1
      GET
    • getCustomerReview
      GET
    • loadProducRecommendationsByItemId
      GET
    • loadProductBySlug
      GET
    • loadRelatedProductsByItemId
      GET
    • loadPrivacypolicy
      GET
    • searchPagedProducts
      GET
    • searchPagedProductsByPages
      GET
    • getStoreLocations
      GET
    • getGeocode
      GET
    • loadHomeBanners
      GET
    • getCountries_1
      GET
    • getCountryStates_1
      GET
    • getCountryStatesLGARegion_1
      GET
    • loadStoreCategories_1
      GET
    • loadStoreSubCategories_1
      GET
    • loadStoreAllCategoriesAndSubCategories_1
      GET
    • loadStoreBanners
      GET
    • verifyMobile_1
      GET
    • verifyEmail
      GET
    • loadAboutUs
      GET
    • Log in a customer with token
      POST
    • Log in a customer
      POST
    • Register a new customer
      POST
  • User Operations
    • Get User Information
      GET
    • Update User Information
      PUT
    • Set Default Wallet Bank Account
      POST
    • Set VAT, VAT Type and currency etc used for business activities in this location
      POST
    • Set a particular location as the default store used for business activities
      POST
    • Retrieve Profile Image
      GET
    • Upload Profile Image
      POST
    • Log a User Complaint
      POST
    • createNewStoreLocation
      POST
    • Change User Password
      POST
    • Get the details, settings and important parameters for a store location
      GET
    • Get Bank Account Details
      GET
    • Switch account to another store location
      GET
    • Get User Store Locations
      GET
  • 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. User Operations

Get the details, settings and important parameters for a store location

GET
/user/{accountid}/{storeId}
User Operations
Allows a logged in user to retrieve details about a particular store location

Request

Path Params
accountid
string 
required
ID of the account user requesting the switch
storeId
string 
required
ID of the store that is to be switched to
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/user//' \
--header 'sessiontoken;'

Responses

🟢200OK
*/*
Store info retrieving completed successfully
Body
accessToken
string 
optional
sessionId
string 
optional
originalStoreId
string 
optional
success
boolean 
optional
sitename
string 
optional
siteTitle
string 
optional
siteSEO
string 
optional
domain
string 
optional
businessname
string 
optional
address
string 
optional
stateOfCountry
string 
optional
country
string 
optional
insuranceTrackId
string 
optional
licensePlan
string 
optional
id
string 
optional
category
string 
optional
logoPath
string 
optional
emailAddress
string 
optional
contactPhone
string 
optional
contactPhone2
string 
optional
facebookId
string 
optional
twitterId
string 
optional
instagramId
string 
optional
youtubechannel
string 
optional
whatsappline
string 
optional
currency
string 
optional
cacNo
string 
optional
bvnNo
string 
optional
tinNo
string 
optional
aboutStore
string 
optional
openingTime
string 
optional
closingTime
string 
optional
userClass
string 
optional
taxRate
number <double>
optional
taxType
string 
optional
faviconurl
string 
optional
storeGpsLatitude
number <double>
optional
storeGpsLongitude
number <double>
optional
businessTagline
string 
optional
storePolicy
string 
optional
storeRole
string 
optional
contactEmail2
string 
optional
basicStoreInfo
string 
optional
aboutUs
string 
optional
cloudOnlyStore
boolean 
optional
enableLiveStore
boolean 
optional
defaultCustomerName
string 
optional
customerId
string 
optional
newPassword
string 
optional
oldPassword
string 
optional
staffId
string 
optional
logo
string 
optional
seoTags
string 
optional
tagLine
string 
optional
secondarySiteThemeColor
string 
optional
primarySiteThemeColor
string 
optional
primaryButtonColor
string 
optional
primaryThemeFont
string 
optional
mergeWithCentral
boolean 
optional
defaultGateway
object (PaymentGatewayInfo) 
optional
gatewayProviderName
string 
optional
gatewayType
string 
optional
policyRemark
string 
optional
features
object (Features) 
optional
primaryColor
string 
optional
helpline
string 
optional
whatsappNo
string 
optional
contactEmail
string 
optional
contactAddress
string 
optional
skypeAddress
string 
optional
facebookPage
string 
optional
youtubePage
string 
optional
googlePlus
string 
optional
skypeId
string 
optional
transxIdPref
string 
optional
googleCredentials
string 
optional
reserveOrderSupport
boolean 
optional
pinterestSupport
string 
optional
deliverytime
integer <int32>
optional
returnsSupported
boolean 
optional
cashOnDelivery
boolean 
optional
socialMediaEnabled
boolean 
optional
promoOngoing
boolean 
optional
realtimeEnabled
boolean 
optional
wholesaleEnabled
boolean 
optional
mobileAppEnabled
boolean 
optional
mobileAppLink
string 
optional
vatType
string 
optional
gpsLat
number <double>
optional
gpsLng
number <double>
optional
partners
array[string]
optional
gpsEnabled
boolean 
optional
defaultBank
object (BankAccountData) 
optional
Bank account data to be created
bankCode
string 
required
internalAccountNo
string 
optional
bankFullName
string 
required
userBankAccNo
string 
required
userBankAccName
string 
required
activated
boolean 
optional
defaultAccount
boolean 
optional
accountType
string 
optional
paymentGateways
array[object (PaymentGatewayInfo) {3}] 
optional
gatewayProviderName
string 
optional
gatewayType
string 
optional
policyRemark
string 
optional
bankAccounts
array[object (BankAccountData) {8}] 
optional
bankCode
string 
required
internalAccountNo
string 
optional
bankFullName
string 
required
userBankAccNo
string 
required
userBankAccName
string 
required
activated
boolean 
optional
defaultAccount
boolean 
optional
accountType
string 
optional
deliveryPoints
array[object (DeliveryPoints) {3}] 
optional
pname
string 
optional
ptype
string 
optional
pid
string 
optional
banners
array[object (ProductBanner) {5}] 
optional
itemId
string 
optional
bannerUrl
string 
optional
serialId
integer <int32>
optional
title
string 
optional
addedDate
string <date-time>
optional
ads
array[object (AdBanner) {2}] 
optional
bannerRedirectUrl
string 
optional
bannerImageUrl
string 
optional
storeGroups
array[string]
optional
monthlyFees
integer <int64>
optional
googleCredentials
string 
optional
expireDate
string <date-time>
optional
Example
{
  "accessToken": "string",
  "sessionId": "string",
  "originalStoreId": "string",
  "success": true,
  "sitename": "string",
  "siteTitle": "string",
  "siteSEO": "string",
  "domain": "string",
  "businessname": "string",
  "address": "string",
  "stateOfCountry": "string",
  "country": "string",
  "insuranceTrackId": "string",
  "licensePlan": "string",
  "id": "string",
  "category": "string",
  "logoPath": "string",
  "emailAddress": "string",
  "contactPhone": "string",
  "contactPhone2": "string",
  "facebookId": "string",
  "twitterId": "string",
  "instagramId": "string",
  "youtubechannel": "string",
  "whatsappline": "string",
  "currency": "string",
  "cacNo": "string",
  "bvnNo": "string",
  "tinNo": "string",
  "aboutStore": "string",
  "openingTime": "string",
  "closingTime": "string",
  "userClass": "string",
  "taxRate": 0,
  "taxType": "string",
  "faviconurl": "string",
  "storeGpsLatitude": 0,
  "storeGpsLongitude": 0,
  "businessTagline": "string",
  "storePolicy": "string",
  "storeRole": "string",
  "contactEmail2": "string",
  "basicStoreInfo": "string",
  "aboutUs": "string",
  "cloudOnlyStore": true,
  "enableLiveStore": true,
  "defaultCustomerName": "string",
  "customerId": "string",
  "newPassword": "string",
  "oldPassword": "string",
  "staffId": "string",
  "logo": "string",
  "seoTags": "string",
  "tagLine": "string",
  "secondarySiteThemeColor": "string",
  "primarySiteThemeColor": "string",
  "primaryButtonColor": "string",
  "primaryThemeFont": "string",
  "mergeWithCentral": true,
  "defaultGateway": {
    "gatewayProviderName": "string",
    "gatewayType": "string",
    "policyRemark": "string"
  },
  "features": {
    "primaryColor": "string",
    "helpline": "string",
    "whatsappNo": "string",
    "contactEmail": "string",
    "contactAddress": "string",
    "skypeAddress": "string",
    "facebookPage": "string",
    "youtubePage": "string",
    "googlePlus": "string",
    "skypeId": "string",
    "transxIdPref": "string",
    "googleCredentials": "string",
    "reserveOrderSupport": true,
    "pinterestSupport": "string",
    "deliverytime": 0,
    "returnsSupported": true,
    "cashOnDelivery": true,
    "socialMediaEnabled": true,
    "promoOngoing": true,
    "realtimeEnabled": true,
    "wholesaleEnabled": true,
    "mobileAppEnabled": true,
    "mobileAppLink": "string",
    "vatType": "string",
    "gpsLat": 0,
    "gpsLng": 0,
    "partners": [
      "string"
    ],
    "gpsEnabled": true
  },
  "defaultBank": {
    "bankCode": "string",
    "internalAccountNo": "string",
    "bankFullName": "string",
    "userBankAccNo": "string",
    "userBankAccName": "string",
    "activated": true,
    "defaultAccount": true,
    "accountType": "string"
  },
  "paymentGateways": [
    {
      "gatewayProviderName": "string",
      "gatewayType": "string",
      "policyRemark": "string"
    }
  ],
  "bankAccounts": [
    {
      "bankCode": "string",
      "internalAccountNo": "string",
      "bankFullName": "string",
      "userBankAccNo": "string",
      "userBankAccName": "string",
      "activated": true,
      "defaultAccount": true,
      "accountType": "string"
    }
  ],
  "deliveryPoints": [
    {
      "pname": "string",
      "ptype": "string",
      "pid": "string"
    }
  ],
  "banners": [
    {
      "itemId": "string",
      "bannerUrl": "string",
      "serialId": 0,
      "title": "string",
      "addedDate": "2019-08-24T14:15:22Z"
    }
  ],
  "ads": [
    {
      "bannerRedirectUrl": "string",
      "bannerImageUrl": "string"
    }
  ],
  "storeGroups": [
    "string"
  ],
  "monthlyFees": 0,
  "googleCredentials": "string",
  "expireDate": "2019-08-24T14:15:22Z"
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Modified at 2025-03-27 14:31:04
Previous
Change User Password
Next
Get Bank Account Details
Built with