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

Switch account to another store location

GET
/user/{accountid}/switchStore/{storeId}
User Operations
Allows a logged in user to point to another store location where they can operate activities

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//switchStore/' \
--header 'sessiontoken;'

Responses

🟢200OK
*/*
Store switching completed successfully
Body
serverTime
string <date-time>
optional
errorCode
integer <int32>
optional
timestamp
integer <int64>
optional
lastActive
string 
optional
active
boolean 
optional
success
boolean 
optional
message
string 
optional
user
object (User) 
optional
accountToken
string 
optional
updateAvailable
boolean 
optional
centralAccId
string 
optional
appType
string 
optional
mobileOnlyUser
boolean 
optional
bankFullName
string 
optional
bankCode
string 
optional
bankAccountNo
string 
optional
bankAccountName
string 
optional
allowAdminOverride
boolean 
optional
enforcePasswordChange
boolean 
optional
enforceProfileUpdate
boolean 
optional
defStore
object (Store) 
optional
storeGroups
array[object (Store) {71}] 
optional
accountId
string 
optional
sessionId
string 
optional
userId
string 
optional
fullname
string 
optional
firstname
string 
optional
lastname
string 
optional
mobile
string 
optional
email
string 
optional
sessionExpireDate
string <date-time>
optional
role
string 
optional
profilePicture
string 
optional
storeStaffId
string 
optional
transPrefix
string 
optional
smsBalance
number <double>
optional
appLatestVersion
string 
optional
recentInfo
string 
optional
totalCreditScore
number <double>
optional
walletBalance
integer <int64>
optional
storeId
string 
optional
fields
string 
optional
refresh
boolean 
optional
data
object (ResultData) 
optional
attributes
object 
optional
customerId
string 
optional
storeId
string 
optional
paymentRedirectLink
string 
optional
paymentCaptureBase64
string 
optional
customerProfileResult
object (CustomerProfile) 
optional
customerResult
object (Customer) 
optional
customerWalletResult
array[object (CustomerWalletReport) {5}] 
optional
customerWishlistResult
object (ProductListData) 
optional
productListResult
object (ProductListData) 
optional
pendingsTransfers
array[object (StoreTransferOrder) {26}] 
optional
itemAuditLogs
array[object (ItemAuditReport) {9}] 
optional
purchaseOrders
array[object (PurchaseOrder) {44}] 
optional
distributors
array[object (ShopInfo) {33}] 
optional
orderPaymentMethods
array[object (PayMethodInfo) {18}] 
optional
orderPaymentReports
array[object (PayMethodInfo) {18}] 
optional
orderCartItems
array[object (OrderItemRequest) {20}] 
optional
expenseAccounts
array[object (ExpenseAccounts) {4}] 
optional
expenseList
array[object (Expense) {34}] 
optional
storeLevels
object (StoreFinanceItem) 
optional
analyticsBean
array[object (ProductAnalysisBean) {12}] 
optional
shippingRequests
array[object (StockerOrder) {35}] 
optional
salesReportDetails
array[object (SalesStockDetailsSummary) {8}] 
optional
customerSummaryReport
array[object (CustomerSummaryBean) {6}] 
optional
staffSummaryReport
array[object (SalesStaffAnalysisBean) {5}] 
optional
insurePolicy
object (InsuranceAccount) 
optional
paymentGroupReport
array[object (DataSummaryIdQuerySet) {4}] 
optional
salesReportFeeds
array[object (StoreIntel) {23}] 
optional
storeVendorList
array[object (ShopVendor) {38}] 
optional
banklist
array[object (RemitaBank) {7}] 
optional
storeResult
object (Store) 
optional
deliveryAreasListResult
object (DeliveryInfo) 
optional
categoryListResult
object (Categories) 
optional
productInfoResult
object (Product) 
optional
productDetailResult
object (ProductDetail) 
optional
orderHistoryResult
object (OrderHistory) 
optional
orderResult
object (MobileOrderRequest) 
optional
orderShippingResult
object (ShippingProvider) 
optional
listProvidersResult
object (Shipping) 
optional
walletBalance
integer <int64>
optional
walletReport
array[object (WalletReport) {5}] 
optional
categoryGroupsResult
array[string]
optional
userGroups
array[object (User) {33}] 
optional
bankAccounts
array[object (BankAccount) {21}] 
optional
referrals
array[object (UserInfoMap) {23}] 
optional
referralBalance
integer <int64>
optional
openAiExtracts
object (OpenAIExtracts) 
optional
stockInRequestCache
array[object (StockInRequestCache) {19}] 
optional
processSMSAlerts
array[object (BankProcessedText) {8}] 
optional
pendingOrderRequests
array[object (MobileOrderRequest) {46}] 
optional
ads
array[object (AdBanner) {2}] 
optional
Example
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Modified at 2025-03-27 14:31:04
Previous
Get Bank Account Details
Next
Get User Store Locations
Built with