# StoreHarmony API ## Docs - [Storeharmony API](https://api.storeharmony.com/doc-713484.md): ## API Docs - Mobile Apps > Apps Registration > Authentication [Verify User Registration from a Website](https://api.storeharmony.com/api-11429133.md): Verifies the store registration using the provided verification code sent to the user's email. This operation confirms the user's identity and activates their account, allowing them to access the services and features of the platform. - Mobile Apps > Apps Registration > Authentication [Verify User Registration](https://api.storeharmony.com/api-11197050.md): Verifies the store registration using the provided verification code sent to the user's email. This operation confirms the user's identity and activates their account, allowing them to access the services and features of the platform. - Mobile Apps > Apps Registration > Authentication [Reset User Password](https://api.storeharmony.com/api-10958268.md): Initiates the password reset process for the user with the specified username. This operation will send a password reset link or token to the user's registered email address, allowing them to securely change their password. - Mobile Apps > Apps Registration > Authentication [Register a new store](https://api.storeharmony.com/api-10726048.md): Creates a new store registration with the provided details, including the store's title, contact information, and location. This operation allows users to successfully onboard a new store into the system, enabling them to access various features and functionalities of storeharmony. - Mobile Apps > Apps Registration > Authentication [User Login For Apps](https://api.storeharmony.com/api-11197447.md): Logs in a user using their credentials (username and password) and returns an authentication result. This operation provides detailed information about the login attempt, including a session token and user roles, allowing the user to access the application securely. - Mobile Apps > Apps Registration > Authentication [Authenticate User](https://api.storeharmony.com/api-10726053.md): A call to login a user into storeharmony app and retrieve session tokens and API keys to use to access resources within storeharmony network. Requires developer API key - Mobile Apps > Stock Inventory > Stock Categories [getStoreCategories](https://api.storeharmony.com/api-12373479.md): - Mobile Apps > Stock Inventory > Stock Categories [updateStoreCategory](https://api.storeharmony.com/api-12373480.md): - Mobile Apps > Stock Inventory > Stock Categories [createStoreCategory](https://api.storeharmony.com/api-12373481.md): - Mobile Apps > Stock Inventory > Stock Categories [createStoreSubCategory](https://api.storeharmony.com/api-12373482.md): - Mobile Apps > Stock Inventory > Stock Categories [deleteStoreCategory](https://api.storeharmony.com/api-14171444.md): - Mobile Apps > Stock Inventory > Stock Categories [Upload Category Picture](https://api.storeharmony.com/api-14171445.md): Uploads an image for the specified product category - Mobile Apps > Stock Inventory > Stock Categories [createBulkStoreCategory](https://api.storeharmony.com/api-12373483.md): - Mobile Apps > Stock Inventory [Create Bulk Products](https://api.storeharmony.com/api-13480788.md): Creates multiple products in bulk and adds them to the inventory of the provided store location. - Mobile Apps > Stock Inventory [Create Product with Variants](https://api.storeharmony.com/api-13482069.md): This endpoint allows the creation of a product with variants in color and sizes. - Mobile Apps > Stock Inventory [Add Variants to Product](https://api.storeharmony.com/api-13480786.md): Adds new product variants to an existing product in the store. A product variant can be a new size, color, or any other attribute that differentiates the product from its base version. - Mobile Apps > Stock Inventory [Upload Product Picture](https://api.storeharmony.com/api-10726026.md): Uploads an image for the specified product and returns the path to the uploaded image. - Mobile Apps > Stock Inventory [Update Product Prices](https://api.storeharmony.com/api-13480784.md): Updates the prices of an existing product identified by its item ID. This allows changing the product's price. - Mobile Apps > Stock Inventory [Add New Quantity to Product](https://api.storeharmony.com/api-13480787.md): Adds a specified quantity to an existing product identified by its item ID. - Mobile Apps > Stock Inventory [Deduct Quantity from Product](https://api.storeharmony.com/api-13480785.md): Deducts a specified quantity from an existing product identified by its item ID. - Mobile Apps > Stock Inventory [Creates a simple product in the inventory](https://api.storeharmony.com/api-10726025.md): Creates a simple product in the inventory at the provided store location. This includes details like name, quantity, cost price, and more. - Mobile Apps > Stock Inventory [Get Product by Item ID](https://api.storeharmony.com/api-10726029.md): Retrieves the details of a product using its item ID. - Mobile Apps > Stock Inventory [getProductTransfers](https://api.storeharmony.com/api-10726030.md): - Mobile Apps > Stock Inventory [acceptTransferIntoStore](https://api.storeharmony.com/api-10726031.md): - Mobile Apps > Stock Inventory [listProductsPricesForRecentChanges](https://api.storeharmony.com/api-10726032.md): - Mobile Apps > Stock Inventory [listProductsPrices](https://api.storeharmony.com/api-10726033.md): - Mobile Apps > Stock Inventory [Get Inventory Stock Items](https://api.storeharmony.com/api-10726034.md): Returns a list of inventory stock items for the specified store. - Mobile Apps > Stock Inventory [getProductAudit](https://api.storeharmony.com/api-10726035.md): - Mobile Apps > Stock Inventory [findBySKU](https://api.storeharmony.com/api-10726036.md): - Mobile Apps > Stock Inventory [Update Product](https://api.storeharmony.com/api-14245720.md): Updates an existing product with the provided product details. - Mobile Apps > Stock Inventory [Removes provided variants from provided Existing Product](https://api.storeharmony.com/api-14245721.md): Revomves product variants from an existing product in the store. A product variant can be a new size, color, or any other attribute that differentiates the product from its base version. - Mobile Apps > Stock Inventory [Add Variants to Existing Product](https://api.storeharmony.com/api-14171443.md): Adds new product variants to an existing product in the store. A product variant can be a new size, color, or any other attribute that differentiates the product from its base version. - Mobile Apps > Stock Inventory [getProductsWithComplexQuery](https://api.storeharmony.com/api-13564388.md): - Mobile Apps > Stock Inventory [Removes Product by Item ID](https://api.storeharmony.com/api-14241454.md): Removes this product from the inventory. It does not completely delete but will zero the product and reclaim the SKU number provided their are no audit trails - Mobile Apps > Stock Inventory [Add Variants to Existing Product](https://api.storeharmony.com/api-14967348.md): Adds new product variants to an existing product in the store. A product variant can be a new size, color, or any other attribute that differentiates the product from its base version. - Mobile Apps > Store Admin Operations [Get Store User](https://api.storeharmony.com/api-10958269.md): Gets the user associated with the specified store and user ID. - Mobile Apps > Store Admin Operations [Edit Store User](https://api.storeharmony.com/api-10958270.md): Updates the information of the user associated with the specified store and user ID. Mostly used for firstname, lastname, and role updates. - Mobile Apps > Store Admin Operations [Delete a Store User](https://api.storeharmony.com/api-10958271.md): Deletes the user associated with the specified store and user ID. - Mobile Apps > Store Admin Operations [Get Bank Account List for the Store](https://api.storeharmony.com/api-10958272.md): Retrieves the details of bank accounts associated with the specified store. - Mobile Apps > Store Admin Operations [Update Bank Account Details](https://api.storeharmony.com/api-10958273.md): Updates the details of the specified bank account. - Mobile Apps > Store Admin Operations [Create Bank Account](https://api.storeharmony.com/api-10958274.md): Creates a new bank account associated with the specified store. - Mobile Apps > Store Admin Operations [Delete Bank Account](https://api.storeharmony.com/api-11173430.md): Deletes the bank account associated with the specified account number. - Mobile Apps > Store Admin Operations [Add a User to Store](https://api.storeharmony.com/api-10958275.md): Adds a new user associated with the specified store. - Mobile Apps > Store Admin Operations [Set Default Bank](https://api.storeharmony.com/api-10976920.md): Sets the default bank for accepting payment in the specified store location. - Mobile Apps > Store Admin Operations [List all users for a Store User](https://api.storeharmony.com/api-10973654.md): Gets the users associated with the specified store. - Mobile Apps > Store Admin Operations [Get Bank Account Details](https://api.storeharmony.com/api-10958277.md): Retrieves the details of a bank account associated with the specified account number. - Mobile Apps > Store Admin Operations [Delete Bank Account](https://api.storeharmony.com/api-10958278.md): Deletes the bank account associated with the specified account number. - Mobile Apps > Invoicing Operations [createPDFInvoiceLink](https://api.storeharmony.com/api-11173433.md): - CRM > Customer Registration [Register a new customer](https://api.storeharmony.com/api-14967349.md): Allows a user to register a new customer with a specified retail store. - CRM > Customer Registration [Log in a customer](https://api.storeharmony.com/api-14967350.md): Allows a user to log in to their account in a specified retail store. - CRM > Customer Registration [Verify Customer Email](https://api.storeharmony.com/api-14967346.md): Verifies the email address of a customer using a verification code. - CRM > Customer Registration [Verify Customer Mobile](https://api.storeharmony.com/api-14967347.md): Verifies the mobile number of a customer using a verification code. - CRM > Customer Registration [Reset Customer Password](https://api.storeharmony.com/api-14967345.md): Resets the password for a customer using the provided details. - Online Store > Restuarant Order Menus AppCalls [Place an Order](https://api.storeharmony.com/api-11608420.md): Places a new order in the specified store, taking in the order details and user session token. - Online Store > Restuarant Order Menus AppCalls [Submit Store Review](https://api.storeharmony.com/api-11608421.md): Allows a user to submit a review for a store with feedback. - Online Store > Restuarant Order Menus AppCalls [getServiceName](https://api.storeharmony.com/api-11608422.md): - Online Store > Restuarant Order Menus AppCalls [Load a Restro Store Detail](https://api.storeharmony.com/api-11608423.md): Fetches details of a specific store - Online Store > Restuarant Order Menus AppCalls [Restro Product Order](https://api.storeharmony.com/api-11608424.md): Fetches the status of a previously placed order based on the store and order ID. - Online Store > Restuarant Order Menus AppCalls [Track Order Status](https://api.storeharmony.com/api-11608425.md): Tracks the status of an order, including the time remaining for completion. - Online Store > Restuarant Order Menus AppCalls [Restro Store Tables](https://api.storeharmony.com/api-11608426.md): Fetch tables available for service delivery at the specified store. - Online Store > Restuarant Order Menus AppCalls [List Auto Categories](https://api.storeharmony.com/api-11608427.md): Fetches a list of auto categories for a specific store and tag. - Online Store > Restuarant Order Menus AppCalls [Restro Product Details](https://api.storeharmony.com/api-11608428.md): Fetch details of a specific product available in the store. - Online Store > Restuarant Order Menus AppCalls [Fetch Related Products or Recommended Pairs for a Product](https://api.storeharmony.com/api-11608429.md): Retrieves related products or recommended pairings for a specified product based on its details. Helps users to explore similar items or products frequently purchased together. - Online Store > Restuarant Order Menus AppCalls [Fetch All Categories](https://api.storeharmony.com/api-11608430.md): Retrieves all categories for the specified store, supporting pagination for large datasets. - Online Store > Restuarant Order Menus AppCalls [Fetch All Products Belonging to a Particular Category](https://api.storeharmony.com/api-11608431.md): Retrieves all products within a specified category for a given store. Supports pagination for easier navigation through large datasets. - Online Store > Restuarant Order Menus AppCalls [Fetch All Products by Store ID Based on Categories and Subcategories](https://api.storeharmony.com/api-11608432.md): Retrieves all products within a specified category and subcategory for the given store. Supports pagination for managing large datasets. - Online Store > Restuarant Order Menus AppCalls [Fetch All Categories and Subcategories by Store ID](https://api.storeharmony.com/api-11608433.md): Retrieves all categories and subcategories associated with a store, using the store ID. - Online Store [updatesOrder](https://api.storeharmony.com/api-10725971.md): - Online Store [cancelOrder](https://api.storeharmony.com/api-10725972.md): - Online Store [postCustomerReview](https://api.storeharmony.com/api-10725973.md): - Online Store [getCustomerProfile](https://api.storeharmony.com/api-10725974.md): - Online Store [updateProfile](https://api.storeharmony.com/api-10725975.md): - Online Store [updateProfileShippingAddress](https://api.storeharmony.com/api-10725976.md): - Online Store [submitIssues](https://api.storeharmony.com/api-10725977.md): - Online Store [placeOrderToStore](https://api.storeharmony.com/api-10725978.md): - Online Store [contactStore](https://api.storeharmony.com/api-10725979.md): - Online Store [calculateOrderShipping](https://api.storeharmony.com/api-10725980.md): - Online Store [passResetting](https://api.storeharmony.com/api-10725981.md): - Online Store [getStoreInfo](https://api.storeharmony.com/api-10725984.md): - Online Store [getCustomerWalletReport](https://api.storeharmony.com/api-10725985.md): - Online Store [getRegularPurchase](https://api.storeharmony.com/api-10725986.md): - Online Store [getRecentPurchase](https://api.storeharmony.com/api-10725987.md): - Online Store [getCustomerReceipts](https://api.storeharmony.com/api-10725988.md): - Online Store [getReceiptDetails_1](https://api.storeharmony.com/api-10725989.md): - Online Store [getCustomerProfileDetails](https://api.storeharmony.com/api-10725990.md): - Online Store [getCustomerOrders](https://api.storeharmony.com/api-10725991.md): - Online Store [getOrderDetails](https://api.storeharmony.com/api-10725992.md): - Online Store [getCustomerLoyaltyReport](https://api.storeharmony.com/api-10725993.md): - Online Store [getCustomerInvoices](https://api.storeharmony.com/api-10725994.md): - Online Store [trackPayment](https://api.storeharmony.com/api-10725995.md): - Online Store [trackOrder_1](https://api.storeharmony.com/api-10725996.md): - Online Store [loadDeliverypolicy](https://api.storeharmony.com/api-10725997.md): - Online Store [listAutoCategories_1](https://api.storeharmony.com/api-10725998.md): - Online Store [getShippingRates](https://api.storeharmony.com/api-10725999.md): - Online Store [shippingInformation](https://api.storeharmony.com/api-10726000.md): - Online Store [searchProducts](https://api.storeharmony.com/api-10726001.md): - Online Store [sendReceipt](https://api.storeharmony.com/api-10726002.md): - Online Store [listStoreProductsForHome](https://api.storeharmony.com/api-10726003.md): - Online Store [loadProductByItemId_1](https://api.storeharmony.com/api-10726004.md): - Online Store [getCustomerReview](https://api.storeharmony.com/api-10726005.md): - Online Store [loadProducRecommendationsByItemId](https://api.storeharmony.com/api-10726006.md): - Online Store [loadProductBySlug](https://api.storeharmony.com/api-10726007.md): - Online Store [loadRelatedProductsByItemId](https://api.storeharmony.com/api-10958263.md): - Online Store [loadPrivacypolicy](https://api.storeharmony.com/api-10726008.md): - Online Store [searchPagedProducts](https://api.storeharmony.com/api-13142745.md): - Online Store [searchPagedProductsByPages](https://api.storeharmony.com/api-13142746.md): - Online Store [getStoreLocations](https://api.storeharmony.com/api-10726009.md): - Online Store [getGeocode](https://api.storeharmony.com/api-10726010.md): - Online Store [loadHomeBanners](https://api.storeharmony.com/api-10726011.md): - Online Store [getCountries_1](https://api.storeharmony.com/api-10726012.md): - Online Store [getCountryStates_1](https://api.storeharmony.com/api-10726013.md): - Online Store [getCountryStatesLGARegion_1](https://api.storeharmony.com/api-10726014.md): - Online Store [loadStoreCategories_1](https://api.storeharmony.com/api-10726015.md): - Online Store [loadStoreSubCategories_1](https://api.storeharmony.com/api-10726016.md): - Online Store [loadStoreAllCategoriesAndSubCategories_1](https://api.storeharmony.com/api-10726017.md): - Online Store [loadStoreBanners](https://api.storeharmony.com/api-10726018.md): - Online Store [verifyMobile_1](https://api.storeharmony.com/api-10726019.md): - Online Store [verifyEmail](https://api.storeharmony.com/api-10726020.md): - Online Store [loadAboutUs](https://api.storeharmony.com/api-10726021.md): - Online Store [Log in a customer with token](https://api.storeharmony.com/api-15315495.md): Allows a user to use a redirect token to obtain their credentials - Online Store [Log in a customer](https://api.storeharmony.com/api-10725983.md): Allows a user to log in to their account in a specified retail store. - Online Store [Register a new customer](https://api.storeharmony.com/api-10725982.md): Allows a user to register a new customer with a specified retail store. - User Operations [Get User Information](https://api.storeharmony.com/api-11013136.md): Retrieves the user information represented by the specified account ID. - User Operations [Update User Information](https://api.storeharmony.com/api-11013137.md): Updates a user record such as first name and last name. - User Operations [Set Default Wallet Bank Account](https://api.storeharmony.com/api-10976919.md): Sets the default bank account for the user to accept payments or commissions. - User Operations [Set VAT, VAT Type and currency etc used for business activities in this location](https://api.storeharmony.com/api-11019292.md): Allows a logged in user to set a default store location - User Operations [Set a particular location as the default store used for business activities](https://api.storeharmony.com/api-11019293.md): Allows a logged in user to set a default store location - User Operations [Retrieve Profile Image](https://api.storeharmony.com/api-10726037.md): Fetches the profile picture URL for a user identified by the account ID. - User Operations [Upload Profile Image](https://api.storeharmony.com/api-10726038.md): Uploads a profile picture for a user identified by the account ID. - User Operations [Log a User Complaint](https://api.storeharmony.com/api-10958265.md): Records a complaint from the user associated with the specified account ID. - User Operations [createNewStoreLocation](https://api.storeharmony.com/api-11030929.md): - User Operations [Change User Password](https://api.storeharmony.com/api-10973653.md): Allows the user to change their password by providing their username, old password, and new password. - User Operations [Get the details, settings and important parameters for a store location](https://api.storeharmony.com/api-11019294.md): Allows a logged in user to retrieve details about a particular store location - User Operations [Get Bank Account Details](https://api.storeharmony.com/api-11173429.md): Retrieves the details of a bank account associated with the specified account number. - User Operations [Switch account to another store location](https://api.storeharmony.com/api-10958267.md): Allows a logged in user to point to another store location where they can operate activities - User Operations [Get User Store Locations](https://api.storeharmony.com/api-10726042.md): Returns all store locations that the user has access to. - Data Sources & Reports [getSalesReportsDetails](https://api.storeharmony.com/api-13142747.md): - Data Sources & Reports [getSalesReports](https://api.storeharmony.com/api-13142748.md): - Data Sources & Reports [Sales Report with products sold](https://api.storeharmony.com/api-13447061.md): This endpoint allows you to query sales receipts based on various parameters like customer ID, staff ID, search keyword, date range, and pagination. - Data Sources & Reports [Sales Report by Criteria](https://api.storeharmony.com/api-13142749.md): This endpoint allows you to query sales receipts based on various parameters like customer ID, staff ID, search keyword, date range, and pagination. - Data Sources & Reports [Track Sales By Receipt](https://api.storeharmony.com/api-13142750.md): Fetches detailed information about a specific sales receipt using the receipt number and store ID. This endpoint returns the receipt's details including sale amount, customer information, date, and more. - Data Sources & Reports [getCustomerDataSet](https://api.storeharmony.com/api-13142751.md): - Utility Operations [Create PDF Invoice Link](https://api.storeharmony.com/api-11173434.md): Generates a PDF invoice link based on the provided invoice details. - Utility Operations [Load Store Credentials By ID](https://api.storeharmony.com/api-15315494.md): - Utility Operations [Verify Mobile Number](https://api.storeharmony.com/api-11173435.md): Verifies that the provided mobile number is not already used by another user. - Utility Operations [Verify Email Address](https://api.storeharmony.com/api-11173436.md): Verifies that the provided email address is not already used by another user within the Storeharmony platform. - Utility Operations [Retrieve Store Profiles](https://api.storeharmony.com/api-11173437.md): Returns the categories of stores used by Storeharmony. - Utility Operations [Retrieve List of Roles](https://api.storeharmony.com/api-13044428.md): Returns a list of all roles available within the store - Utility Operations [Retrieve Registered Nigerian Banks. Only Supports Nigerian Banks](https://api.storeharmony.com/api-11173438.md): Returns a list of all registered Nigerian banks along with their IDs. - Utility Operations [Lookup Bank Account Details](https://api.storeharmony.com/api-11173439.md): Retrieves the details of a bank account based on the provided account number. This call will fail in production if the account number does not exist within the banking network. - Utility Operations [Retrieve List of Countries](https://api.storeharmony.com/api-11173440.md): Returns a list of all countries available in the system. - Utility Operations [Retrieve States in a Country](https://api.storeharmony.com/api-11173441.md): Gets the list of states based on the provided country code. - Utility Operations [Retrieve Regions within a State](https://api.storeharmony.com/api-11173442.md): Retrieves the regions, counties, and local government areas within a state of a specified country. - Payments & Webhooks [reversalMerchantPOSTerminal_1](https://api.storeharmony.com/api-14171446.md): - Payments & Webhooks [payViaMerchantPOSTerminal_1](https://api.storeharmony.com/api-14171447.md): - Payments & Webhooks [Creates a bank transfer account](https://api.storeharmony.com/api-14171448.md): Creates a bank transfer virtual account using the specified provider for making payments - Webhooks & Operations [reversalMerchantPOSTerminal](https://api.storeharmony.com/api-14977147.md): - Webhooks & Operations [payViaMerchantPOSTerminal](https://api.storeharmony.com/api-14977148.md):