StoreHarmony API
  1. Store Admin 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
        GET
      • Edit Store User
        PUT
      • Delete a Store User
        DELETE
      • Get Bank Account List for the Store
        GET
      • Update Bank Account Details
        PUT
      • Create Bank Account
        POST
      • Delete Bank Account
        PUT
      • Add a User to Store
        POST
      • Set Default Bank
        POST
      • List all users for a Store User
        GET
      • Get Bank Account Details
        GET
      • Delete Bank Account
        DELETE
    • 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
    • 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. Store Admin Operations

Add a User to Store

POST
/store/{storeid}/user
Store Admin Operations
Adds a new user associated with the specified store.

Request

Path Params
storeid
string 
required
ID of the store
Header Params
sessiontoken
string 
required
Session token for authentication obtained from login
Body Params application/json
User information for the new store user
firstname
string 
required
lastname
string 
required
email
string 
required
mobile
string 
required
role
string 
required
omnichannel
boolean 
optional
makeEmailOptional
boolean 
optional
address
string 
optional
deviceId
string 
optional
birthDate
integer <int32>
optional
birthMonth
integer <int32>
optional
salesCommissions
number <float>
optional
storeStaffId
string 
optional
Example
{
  "firstname": "string",
  "lastname": "string",
  "email": "string",
  "mobile": "string",
  "role": "string",
  "omnichannel": true,
  "makeEmailOptional": true,
  "address": "string",
  "deviceId": "string",
  "birthDate": 0,
  "birthMonth": 0,
  "salesCommissions": 0,
  "storeStaffId": "string"
}

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 POST 'https://gateway.storeharmony.com/cloudapi/store//user' \
--header 'sessiontoken;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstname": "string",
    "lastname": "string",
    "email": "string",
    "mobile": "string",
    "role": "string",
    "omnichannel": true,
    "makeEmailOptional": true,
    "address": "string",
    "deviceId": "string",
    "birthDate": 0,
    "birthMonth": 0,
    "salesCommissions": 0,
    "storeStaffId": "string"
}'

Responses

🟢201Created
*/*
User added successfully.
Body
updateAvailable
boolean 
optional
centralAccId
string 
optional
appType
string 
optional
mobileOnlyUser
boolean 
optional
allowAdminOverride
boolean 
optional
bankFullName
string 
optional
bankCode
string 
optional
bankAccountNo
string 
optional
bankAccountName
string 
optional
accountId
string 
optional
sessionId
string 
optional
accountToken
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
recentInfo
string 
optional
totalCreditScore
number <double>
optional
walletBalance
integer <int64>
optional
storeId
string 
optional
Example
{
  "updateAvailable": true,
  "centralAccId": "string",
  "appType": "string",
  "mobileOnlyUser": true,
  "allowAdminOverride": true,
  "bankFullName": "string",
  "bankCode": "string",
  "bankAccountNo": "string",
  "bankAccountName": "string",
  "accountId": "string",
  "sessionId": "string",
  "accountToken": "string",
  "userId": "string",
  "fullname": "string",
  "firstname": "string",
  "lastname": "string",
  "mobile": "string",
  "email": "string",
  "sessionExpireDate": "2019-08-24T14:15:22Z",
  "role": "string",
  "profilePicture": "string",
  "storeStaffId": "string",
  "transPrefix": "string",
  "smsBalance": 0,
  "recentInfo": "string",
  "totalCreditScore": 0,
  "walletBalance": 0,
  "storeId": "string"
}
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-03-27 14:31:04
Previous
Delete Bank Account
Next
Set Default Bank
Built with