StoreHarmony API
  1. Data Sources & Reports
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
    • 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
      GET
    • getSalesReports
      GET
    • Sales Report with products sold
      GET
    • Sales Report by Criteria
      GET
    • Track Sales By Receipt
      GET
    • getCustomerDataSet
      GET
  • 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. Data Sources & Reports

Track Sales By Receipt

GET
/reports/{storeid}/sales/{receiptNo}
Data Sources & Reports
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.

Request

Path Params
storeid
string 
required
ID of the store where the sale occurred
receiptNo
string 
required
Receipt number for identifying the sale receipt
Header Params
sessiontoken
string 
required
Session token for the logged-in user

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

Responses

🟢200OK
*/*
Receipt details retrieved successfully.
Body
totalVolumeOrdered
number <double>
optional
totalOrderPrice
integer <int64>
optional
totalOrderPriceWithoutTax
integer <int64>
optional
totalTaxPrice
integer <int64>
optional
totalOrderWithoutShipping
integer <int64>
optional
status
string 
optional
paymentStatus
string 
optional
posted
boolean 
optional
postResponse
string 
optional
paymentOption
object (PaymentOption) 
optional
title
string 
optional
optionMessage
string 
optional
paymentToken
string 
optional
paymentLink
string 
optional
paymentType
string 
optional
active
boolean 
optional
storeId
string 
optional
storeName
string 
optional
storeAddress
string 
optional
storeEmail
string 
optional
storeState
string 
optional
storeCountry
string 
optional
orderId
string 
optional
trackingId
string 
optional
customerId
string 
optional
customerMobileNo
string 
optional
customerName
string 
optional
orderDate
string <date-time>
optional
currency
string 
optional
paymentGatewayLink
string 
optional
paymentGateway
string 
optional
totalPrice
integer <int64>
optional
totalVat
integer <int64>
optional
vatExempt
boolean 
optional
vatIncluded
boolean 
optional
totalDiscount
integer <int64>
optional
totalShipping
integer <int64>
optional
cartItems
array[object (SimpleOrderItem) {12}] 
optional
item
object (WebStoreItem) 
optional
itemId
string 
optional
barcode
string 
optional
itemName
string 
optional
quantity
number <double>
optional
unitprice
integer <int64>
optional
shelfprice
integer <int64>
optional
unitdiscount
integer <int64>
optional
unitVat
integer <int64>
optional
customerRemarks
string 
optional
packagingOption
string 
optional
type
string 
optional
paymentMethods
array[object (PayMethodInfo) {18}] 
optional
amount
integer <int64>
optional
method
string 
optional
dateOfPayment
string <date-time>
optional
reference
string 
optional
transactionId
string 
optional
paymentEntryId
string 
optional
customerId
string 
optional
statusRemark
string 
optional
merchantBank
string 
optional
merchantBankAcc
string 
optional
staffId
string 
optional
clientSessionId
string 
optional
merchantTid
string 
optional
maskedPan
string 
optional
cardName
string 
optional
cardType
string 
optional
paymentStatus
string 
optional
confirmed
boolean 
optional
Example
{
    "totalVolumeOrdered": 0,
    "totalOrderPrice": 0,
    "totalOrderPriceWithoutTax": 0,
    "totalTaxPrice": 0,
    "totalOrderWithoutShipping": 0,
    "status": "string",
    "paymentStatus": "string",
    "posted": true,
    "postResponse": "string",
    "paymentOption": {
        "title": "string",
        "optionMessage": "string",
        "paymentToken": "string",
        "paymentLink": "string",
        "paymentType": "string",
        "active": true
    },
    "storeId": "string",
    "storeName": "string",
    "storeAddress": "string",
    "storeEmail": "string",
    "storeState": "string",
    "storeCountry": "string",
    "orderId": "string",
    "trackingId": "string",
    "customerId": "string",
    "customerMobileNo": "string",
    "customerName": "string",
    "orderDate": "2019-08-24T14:15:22Z",
    "currency": "string",
    "paymentGatewayLink": "string",
    "paymentGateway": "string",
    "totalPrice": 0,
    "totalVat": 0,
    "vatExempt": true,
    "vatIncluded": true,
    "totalDiscount": 0,
    "totalShipping": 0,
    "cartItems": [
        {
            "item": {
                "specializedCategory": "string",
                "name": "string",
                "category": "string",
                "subCategory": "string",
                "slug": "string",
                "thumbnail": "string",
                "sku": "string",
                "groupSku": "string",
                "price": 0,
                "color": "string",
                "size": "string",
                "details": "string",
                "quantity": 0,
                "oldprice": 0,
                "itemId": "string",
                "unit": "string",
                "available": 0,
                "percentOff": 0,
                "newProduct": true,
                "promos": true,
                "dateAdded": "2019-08-24T14:15:22Z",
                "inStock": true
            },
            "itemId": "string",
            "barcode": "string",
            "itemName": "string",
            "quantity": 0,
            "unitprice": 0,
            "shelfprice": 0,
            "unitdiscount": 0,
            "unitVat": 0,
            "customerRemarks": "string",
            "packagingOption": "string",
            "type": "string"
        }
    ],
    "paymentMethods": [
        {
            "amount": 0,
            "method": "string",
            "dateOfPayment": "2019-08-24T14:15:22Z",
            "reference": "string",
            "transactionId": "string",
            "paymentEntryId": "string",
            "customerId": "string",
            "statusRemark": "string",
            "merchantBank": "string",
            "merchantBankAcc": "string",
            "staffId": "string",
            "clientSessionId": "string",
            "merchantTid": "string",
            "maskedPan": "string",
            "cardName": "string",
            "cardType": "string",
            "paymentStatus": "string",
            "confirmed": true
        }
    ]
}
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-03-27 14:31:04
Previous
Sales Report by Criteria
Next
getCustomerDataSet
Built with