StoreHarmony API
  1. Restuarant Order Menus AppCalls
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
        POST
      • Submit Store Review
        POST
      • getServiceName
        GET
      • Load a Restro Store Detail
        GET
      • Restro Product Order
        GET
      • Track Order Status
        GET
      • Restro Store Tables
        GET
      • List Auto Categories
        GET
      • Restro Product Details
        GET
      • Fetch Related Products or Recommended Pairs for a Product
        GET
      • Fetch All Categories
        GET
      • Fetch All Products Belonging to a Particular Category
        GET
      • Fetch All Products by Store ID Based on Categories and Subcategories
        GET
      • Fetch All Categories and Subcategories by Store ID
        GET
    • 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. Restuarant Order Menus AppCalls

Place an Order

POST
/restro/{storeid}/place-order
Restuarant Order Menus AppCalls
Places a new order in the specified store, taking in the order details and user session token.

Request

Path Params
storeid
string 
required
Store identifier to place the order in
Header Params
sessiontoken
string 
required
Session token for user authentication
Body Params application/json
Order details for placing a new order
tableId
string 
optional
orderTime
string <date-time>
optional
totalItemsPrice
integer <int64>
optional
paymentMethod
string 
optional
viewTrackerId
string 
optional
itemList
array[object (RestroItem) {8}] 
optional
itemId
string 
optional
image
string 
optional
name
string 
optional
description
string 
optional
price
integer <int64>
optional
quantity
number <double>
optional
totalPrice
integer <int32>
optional
additionalOptions
array[string]
optional
Example
{
  "tableId": "string",
  "orderTime": "2019-08-24T14:15:22Z",
  "totalItemsPrice": 0,
  "paymentMethod": "string",
  "viewTrackerId": "string",
  "itemList": [
    {
      "itemId": "string",
      "image": "string",
      "name": "string",
      "description": "string",
      "price": 0,
      "quantity": 0,
      "totalPrice": 0,
      "additionalOptions": [
        "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/restro//place-order' \
--header 'sessiontoken;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tableId": "string",
    "orderTime": "2019-08-24T14:15:22Z",
    "totalItemsPrice": 0,
    "paymentMethod": "string",
    "viewTrackerId": "string",
    "itemList": [
        {
            "itemId": "string",
            "image": "string",
            "name": "string",
            "description": "string",
            "price": 0,
            "quantity": 0,
            "totalPrice": 0,
            "additionalOptions": [
                "string"
            ]
        }
    ]
}'

Responses

🟢200OK
*/*
Order placed successfully and a response with order details is returned.
Body
status
boolean 
optional
orderId
string 
optional
comment
string 
optional
customerId
string 
optional
errorCode
integer <int32>
optional
clientSessionId
string 
optional
cardPaymentUrl
string 
optional
order
object (MobileOrderRequest) 
optional
payableBankAccount
string 
optional
payableBank
string 
optional
freqType
string 
optional
freqValue
integer <int32>
optional
repeat
boolean 
optional
status
string 
optional
paymentStatus
string 
optional
bankName
string 
optional
bankAccountNo
string 
optional
bankAccountName
string 
optional
paymentGatewayKey
string 
optional
totalChange
integer <int64>
optional
payResponse
object (PaymentTermResponse) 
optional
storeId
string 
optional
clientSessionId
string 
optional
transactionid
string 
optional
customerId
string 
optional
customerMobileNo
string 
optional
customerName
string 
optional
customerRegister
object (CustomerProfile) 
optional
dateTime
string <date-time>
optional
currency
string 
optional
terminalType
string 
optional
terminalId
string 
optional
salesStaffId
string 
optional
postChangeToWallet
boolean 
optional
sendEmailIfAvailable
boolean 
optional
sendSMSIfAvailable
boolean 
optional
generateAsOrderOnly
boolean 
optional
generateBankTransfer
boolean 
optional
generateTicketOnly
boolean 
optional
sendOrderToLocalStore
boolean 
optional
locationLat
string 
optional
locationLong
string 
optional
createPaymentUrl
boolean 
optional
paymentGatewayLink
string 
optional
paymentGateway
string 
optional
orderType
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 (OrderItemRequest) {20}] 
optional
paymentMethods
array[object (PayMethodInfo) {18}] 
optional
bankPayment
object (FWResponse) 
optional
status
string 
optional
message
string 
optional
data
object (FWData) 
optional
txreference
string 
optional
meta
object (FWMeta) 
optional
Example
{
  "status": true,
  "orderId": "string",
  "comment": "string",
  "customerId": "string",
  "errorCode": 0,
  "clientSessionId": "string",
  "cardPaymentUrl": "string",
  "order": {
    "payableBankAccount": "string",
    "payableBank": "string",
    "freqType": "string",
    "freqValue": 0,
    "repeat": true,
    "status": "string",
    "paymentStatus": "string",
    "bankName": "string",
    "bankAccountNo": "string",
    "bankAccountName": "string",
    "paymentGatewayKey": "string",
    "totalChange": 0,
    "payResponse": {
      "id": 0,
      "entryId": "string",
      "statusCode": "string",
      "statusDescription": "string",
      "responseCode": "string",
      "responseDescription": "string",
      "auditNumber": "string",
      "ecrId": "string",
      "terminalId": "string",
      "gettID": "string",
      "tranNumber": "string",
      "tranDate": "string",
      "transactionType": "string",
      "modeOfPayment": "string",
      "bankName": "string",
      "maskedPan": "string",
      "rrn1": "string",
      "rrn2": "string",
      "cardType": "string",
      "approvalCode": "string",
      "holderName": "string",
      "holderPhone": "string",
      "carExpiryDate": "string",
      "bufferLenght": "string",
      "duplicateResponseCode": "string",
      "amount": 0,
      "feeAmount": 0,
      "centralId": "string",
      "paymentSuccess": true,
      "status": "string",
      "salesInvoiceNo": "string",
      "requestDate": "2019-08-24T14:15:22Z",
      "requestEntryId": "string",
      "responseDate": "2019-08-24T14:15:22Z",
      "bankAccId": "string",
      "cashierPoint": "string",
      "cashierId": "string",
      "cashierName": "string",
      "currency": "string",
      "settled": true,
      "settleDate": "2019-08-24T14:15:22Z",
      "storeId": "string",
      "webId": "string"
    },
    "storeId": "string",
    "clientSessionId": "string",
    "transactionid": "string",
    "customerId": "string",
    "customerMobileNo": "string",
    "customerName": "string",
    "customerRegister": {
      "customerId": "string",
      "webchannelid": "string",
      "firstname": "string",
      "lastname": "string",
      "mobile": "string",
      "state": "string",
      "country": "string",
      "email": "string",
      "lastVisitDate": "2019-08-24T14:15:22Z",
      "registerDate": "2019-08-24T14:15:22Z",
      "otherChannelId": "string",
      "deliveryAddress": "string",
      "photoId": "string",
      "generalPrefs": "string",
      "birthdayMonth": 0,
      "birthdayDate": 0,
      "birthdayYear": 0,
      "gender": "string",
      "activated": true,
      "mobileVerified": true,
      "emailVerified": true,
      "loyaltycard": "string",
      "attributes": {
        "property1": "string",
        "property2": "string"
      }
    },
    "dateTime": "2019-08-24T14:15:22Z",
    "currency": "string",
    "terminalType": "string",
    "terminalId": "string",
    "salesStaffId": "string",
    "postChangeToWallet": true,
    "sendEmailIfAvailable": true,
    "sendSMSIfAvailable": true,
    "generateAsOrderOnly": true,
    "generateBankTransfer": true,
    "generateTicketOnly": true,
    "sendOrderToLocalStore": true,
    "locationLat": "string",
    "locationLong": "string",
    "createPaymentUrl": true,
    "paymentGatewayLink": "string",
    "paymentGateway": "string",
    "orderType": "string",
    "totalPrice": 0,
    "totalVat": 0,
    "vatExempt": true,
    "vatIncluded": true,
    "totalDiscount": 0,
    "totalShipping": 0,
    "cartItems": [
      {
        "product": {
          "itemId": "string",
          "slug": "string",
          "itemName": "string",
          "itemBarcode": "string",
          "itemForm": "string",
          "itemPictureId1": "string",
          "itemPictureId2": "string",
          "category": "string",
          "manufacturer": "string",
          "color": "string",
          "size": "string",
          "price": 0,
          "taxable": true,
          "promoprice": 0,
          "unitsOfMeasure": "string",
          "inStock": true,
          "minOrder": 0,
          "addedBy": "string",
          "addedDate": "2019-08-24T14:15:22Z",
          "expireDate": "2019-08-24T14:15:22Z",
          "batchNo": "string",
          "maxOrder": 0,
          "availableQty": 0,
          "aboutItem": "string",
          "tags": "string",
          "specification": [
            [
              "string"
            ]
          ]
        },
        "itemCache": {
          "beanCounts": {
            "property1": {
              "storeId": "string",
              "barcode": "string",
              "count": 0
            },
            "property2": {
              "storeId": "string",
              "barcode": "string",
              "count": 0
            }
          },
          "transfers": {
            "property1": 0,
            "property2": 0
          },
          "totalAllChannels": 0,
          "auditedQty": 0,
          "damagedQty": 0,
          "expiredQty": 0,
          "stolenQty": 0,
          "giftedQty": 0,
          "excessOutQty": 0,
          "excessInQty": 0,
          "returnQty": 0,
          "rates": 0,
          "auditedType": "string",
          "id": 0,
          "webId": "string",
          "uniqueWebId": "string",
          "getuProductOrderId": "string",
          "categoryDetails": "string",
          "itemDescription": "string",
          "topCategory": "string",
          "subCategory": "string",
          "manufacturer": "string",
          "variant": "string",
          "additionalInfo": "string",
          "batchNo": "string",
          "consignmentNo": "string",
          "composition": "string",
          "slug": "string",
          "storeId": "string",
          "ageGroup": "string",
          "parentCode": "string",
          "parentItemId": "string",
          "colorProfile": "string",
          "barcode": "string",
          "internalCode": "string",
          "manuBarcode": "string",
          "shelfPrice": 0,
          "promoPrice": 0,
          "memberPrice": 0,
          "qtyPerCarton": 0,
          "cartonPrice": 0,
          "onlinePrice": 0,
          "costPrice": 0,
          "costPriceAtForex": 0,
          "exchRates": 0,
          "currency": "string",
          "remarks": "string",
          "discountable": true,
          "onGoingPromo": true,
          "promoExpireDate": "2019-08-24T14:15:22Z",
          "discount": 0,
          "publishedOnline": true,
          "lastArrivalDate": "2019-08-24T14:15:22Z",
          "lastArrivalQty": 0,
          "quantity": 0,
          "picture1Url": "string",
          "picture2Url": "string",
          "picture3Url": "string",
          "supplier": "string",
          "supplierMobile": "string",
          "autoRequestSupply": true,
          "staffId": "string",
          "lastSynced": "2019-08-24T14:15:22Z",
          "addedDate": "2019-08-24T14:15:22Z",
          "batchSupplyDate": "2019-08-24T14:15:22Z",
          "firstSynced": "2019-08-24T14:15:22Z",
          "lowQtyCount": 0,
          "minimumQtyOrder": 0,
          "minPreOrderDeposit": 0,
          "supplierTriggerType": "string",
          "reOrderCycle": 0,
          "reOrderQty": 0,
          "unitOfMeasure": "string",
          "unitOfWeight": "string",
          "unitOfVolume": "string",
          "form": "string",
          "type": "string",
          "taxable": true,
          "expirable": true,
          "expireDate": "2019-08-24T14:15:22Z",
          "lifeSpanValue": 0,
          "lifeSpanMetric": "string",
          "barCodeType": "string",
          "shelfLocation": "string",
          "localStoreQty": 0,
          "onlineStoreQty": 0,
          "categoryId": "string",
          "vatRates": 0,
          "shippingMethod": 0,
          "quantityPerBatch": 0,
          "createdOnline": true,
          "lastUpdatedBy": "string",
          "lastUpdatedOn": "2019-08-24T14:15:22Z",
          "version": 0,
          "enableCommision": true,
          "commissionRate": 0,
          "freeShipping": true,
          "supportedPreOrder": true,
          "sellsAsCartonOnly": true,
          "pricingPlans": "string",
          "memberShipPlans": "string",
          "getnUnitPrice": 0,
          "getnCostPrice": 0,
          "getnGroupCode": "string",
          "wooCommerceId": 0,
          "onlineStoreId": "string",
          "virtualStoreId": "string",
          "centralId": "string",
          "accessible": true
        },
        "itemId": "string",
        "transactionId": "string",
        "itemOrderTrackingId": "string",
        "barcode": "string",
        "itemName": "string",
        "quantity": 0,
        "unitprice": 0,
        "shelfprice": 0,
        "totalLinePrice": 0,
        "unitdiscount": 0,
        "unitVat": 0,
        "storeid": "string",
        "customerRemarks": "string",
        "packagingOption": "string",
        "type": "string",
        "subscribe": true,
        "usebarcode": true,
        "frequency": 0
      }
    ],
    "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
      }
    ]
  },
  "bankPayment": {
    "status": "string",
    "message": "string",
    "data": {
      "txid": 0,
      "txref": "string",
      "link": "string",
      "flwref": "string",
      "devicefingerprint": "string",
      "cycle": "string",
      "amount": 0,
      "currency": "string",
      "appfee": 0,
      "merchantfee": 0,
      "merchantbearsfee": 0,
      "chargecode": "string",
      "chargemessage": "string",
      "authmodel": "string",
      "ip": "string",
      "narration": "string",
      "status": "string",
      "vbvcode": "string",
      "vbvmessage": "string",
      "authurl": "string",
      "acctcode": "string",
      "acctmessage": "string",
      "paymenttype": "string",
      "paymentid": "string",
      "fraudstatus": "string",
      "chargetype": "string",
      "createdday": 0,
      "createddayname": "string",
      "createdweek": 0,
      "createdmonth": 0,
      "createdmonthname": "string",
      "createdquarter": 0,
      "createdyear": 0,
      "createdyearisleap": true,
      "createddayispublicholiday": 0,
      "createdhour": 0,
      "createdminute": 0,
      "createdpmam": "string",
      "created": "string",
      "customerid": 0,
      "custphone": "string",
      "custnetworkprovider": "string",
      "custname": "string",
      "custemail": "string",
      "custemailprovider": "string",
      "custcreated": "string",
      "accountid": 0,
      "acctbusinessname": "string",
      "acctcontactperson": "string",
      "acctcountry": "string",
      "acctbearsfeeattransactiontime": 0,
      "acctparent": 0,
      "acctvpcmerchant": "string",
      "acctalias": {},
      "acctisliveapproved": 0,
      "orderref": "string",
      "paymentplan": {},
      "paymentpage": {},
      "raveref": {},
      "amountsettledforthistransaction": 0,
      "meta": [
        {}
      ],
      "data": {
        "amount": "string",
        "type": "string",
        "redirect": true,
        "note": "string",
        "transactionDate": "string",
        "transactionReference": "string",
        "flwReference": "string",
        "redirectUrl": {},
        "paymentCode": "string",
        "typeData": "string",
        "metaData": {}
      },
      "settlementToken": "string",
      "chargedAmount": 0,
      "chargedcardAmount": 0,
      "chargeResponseCode": "string",
      "raveRef": {},
      "chargeResponseMessage": "string",
      "authModelUsed": "string",
      "getiP": "string",
      "modalauditid": "string",
      "vbvrespmessage": "string",
      "vbvrespcode": "string",
      "acctvalrespmsg": {},
      "acctvalrespcode": {},
      "paymentType": "string",
      "paymentPlan": {},
      "paymentPage": {},
      "paymentId": "string",
      "fraudStatus": "string",
      "chargeType": "string",
      "isLive": 0,
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": {},
      "customerId": 0,
      "accountId": 0,
      "customer": {
        "id": 0,
        "phone": {},
        "fullName": "string",
        "customertoken": {},
        "email": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "deletedAt": {},
        "accountId": 0
      },
      "validateInstructions": "string",
      "qrImage": "string"
    },
    "txreference": "string",
    "meta": {
      "authorization": {
        "transferReference": "string",
        "transferAccount": "string",
        "transferBank": "string",
        "accountExpiration": "string",
        "transferNote": "string",
        "transferAmount": 0,
        "mode": "string"
      }
    }
  }
}
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-03-27 14:31:04
Previous
Reset Customer Password
Next
Submit Store Review
Built with