StoreHarmony API
  1. Schemas
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
    • 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
  • Schemas
    • Schemas
      • OnlineOrderItem
      • CloudUserEntry
      • PayMethodInfo
      • SimpleUser
      • PaymentOption
      • WebOrderV2
      • WebStoreItem
      • BankAccountData
      • SimpleProduct
      • AdBanner
      • DeliveryPoints
      • TerminalPayment
      • Features
      • PaymentGatewayInfo
      • ProductBanner
      • Store
      • User
      • WebProductReview
      • VisitorRegister
      • BillingAddress
      • StoreFinancialInfo
      • ContactUsSet
      • OrderItemUnit
      • OrderShippingRequest
      • OrderShippingInfo
      • InvoiceModel
      • AdvancedQuery
      • PDFInvoiceItem
      • RestroOrder
      • Product
      • ProductListData
      • FWAuthorization
      • ProductResponse
      • FWCustomer
      • Category
      • FWData
      • AuditFlowDateGroup
      • FWMeta
      • BankAccount
      • FWNestedData
      • BankProcessedText
      • FWResponse
      • Categories
      • Customer
      • MobileOrderResponse
      • CustomerProfile
      • CustomerSummaryBean
      • Verification
      • CustomerWalletReport
      • DataSummaryIdQuerySet
      • DeliveryInfo
      • Expense
      • ExpenseAccounts
      • BankTransferRequest
      • ExtractedItem
      • AlatAccountResponse
      • InsuranceAccount
      • ItemAuditReport
      • ItemCountBean
      • MobileOrderRequest
      • Negotiation
      • OpenAIExtracts
      • OrderHistory
      • OrderHistoryItem
      • OrderItemRequest
      • PaymentTermResponse
      • SimplePriceUpdate
      • ProductAnalysisBean
      • BulkCategory
      • SimpleQuantityUpdate
      • ProductDetail
      • ProductVariantGroup
      • VisitorReset
      • PurchaseOrder
      • VariantProduct
      • VisitorLogin
      • Result
      • SimpleProductGroup
      • ExistingProductVariantGroup
      • ResultData
      • ExistingVariantProduct
      • SalesStaffAnalysisBean
      • SalesStockDetailsSummary
      • Shipping
      • ShippingProvider
      • ShopInfo
      • RemitaBank
      • ShopVendor
      • UserComplaint
      • CustomerAuthResponse
      • StockInRequestCache
      • ChangePasswordData
      • StockerOrder
      • SimpleResult
      • StoreFinanceItem
      • UserUpdateInfo
      • StoreIntel
      • StoreInventory
      • StoreTransferOrder
      • UserInfoMap
      • UserReview
      • WalletReport
      • OldCategory
      • StoreRegister
      • NewStoreInfo
      • SimpleLogin
      • AuthResponse
      • StoreSessionToken
      • SimpleInvoice
      • SimpleOrderItem
      • SimpleReceiptDetail
      • WebStoreCustomerProfile
      • SimpleOrderReport
      • WebPayment
      • ProductGroup
      • LoginKey
      • ShippingLocationRates
      • ContentSet
      • KeyValueParam
      • WebStoreProductDetail
      • StoreLocation
      • GeoResult
      • Geometry
      • Location
      • BannerSet
      • WebCountry
      • WebCountryState
      • WebStateArea
      • DataPages
      • RestroStore
      • RestroCategory
      • RestroOrderState
      • RestroItem
      • RestroTable
      • RestroItemContent
      • RestroSubCategory
      • RestroProductDetail
      • RestroCategories
      • Authentication
      • GrantedAuthority
      • SecurityContext
      • ProductTiny
      • DateDuration
      • StoreRoleKey
      • SalesReport
      • StoreReportsData
      • PageParams
      • WebStoreProductsResult
  1. Schemas

User

{
    "accountToken": "string",
    "updateAvailable": true,
    "centralAccId": "string",
    "appType": "string",
    "mobileOnlyUser": true,
    "bankFullName": "string",
    "bankCode": "string",
    "bankAccountNo": "string",
    "bankAccountName": "string",
    "allowAdminOverride": true,
    "enforcePasswordChange": true,
    "enforceProfileUpdate": true,
    "defStore": {
        "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"
    },
    "storeGroups": [
        {
            "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"
        }
    ],
    "accountId": "string",
    "sessionId": "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,
    "appLatestVersion": "string",
    "recentInfo": "string",
    "totalCreditScore": 0,
    "walletBalance": 0,
    "storeId": "string"
}
Built with