StoreHarmony API
  1. Online Store
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
    • 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. Online Store

updatesOrder

PUT
/estore/{storeid}/order/{orderid}
E-Commerce Calls

Request

Path Params
storeid
string 
required
orderid
string 
required
Header Params
sessiontoken
string 
required
Body Params application/json
locationId
string 
optional
developerKey
string 
optional
firstname
string 
optional
lastname
string 
optional
customerMobile
string 
optional
customerEmail
string 
optional
customerId
string 
optional
addressCountry
string 
optional
addressState
string 
optional
addressCity
string 
optional
fullAddress
string 
optional
addressCountryCode
string 
optional
addressStateCode
string 
optional
addressCityCode
string 
optional
shippingBookingId
string 
optional
orderRemark
string 
optional
clientIp
string 
optional
couponCode
string 
optional
locationLat
string 
optional
staffId
string 
optional
orderMethod
string 
optional
locationLong
string 
optional
gatewayType
string 
optional
paymentType
string 
optional
paymentRedirectLink
string 
optional
qrcode
string 
optional
trackingId
string 
optional
orderId
string 
optional
currency
string 
optional
paymentConfirmRef
string 
optional
paymentStatus
string 
optional
orderStatus
string 
optional
paymentGateway
string 
optional
posted
boolean 
optional
postResponse
string 
optional
orderTime
string <date-time>
optional
orderExpireTime
string <date-time>
optional
multiVendor
boolean 
optional
shippingType
string 
optional
totalVolumeOrdered
number <double>
optional
totalOrderPrice
number <double>
optional
totalOrderPriceWithoutTax
number <double>
optional
totalTaxPrice
number <double>
optional
totalShipping
number <double>
optional
totalOrderWithoutShipping
number <double>
optional
paymentOption
object (PaymentOption) 
optional
title
string 
optional
optionMessage
string 
optional
paymentToken
string 
optional
paymentLink
string 
optional
paymentType
string 
optional
active
boolean 
optional
itemUnits
array[object (OnlineOrderItem) {17}] 
optional
productSlug
string 
optional
itemId
string 
optional
qtyOrdered
number <double>
optional
sku
string 
optional
variantId
string 
optional
productId
string 
optional
itemName
string 
optional
unit
string 
optional
remark
string 
optional
barcode
string 
optional
itemPrice
number <double>
optional
itemTax
number <double>
optional
currency
string 
optional
storeId
string 
optional
item
object (WebStoreItem) 
optional
itemPriceAsLong
integer <int64>
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
{
  "locationId": "string",
  "developerKey": "string",
  "firstname": "string",
  "lastname": "string",
  "customerMobile": "string",
  "customerEmail": "string",
  "customerId": "string",
  "addressCountry": "string",
  "addressState": "string",
  "addressCity": "string",
  "fullAddress": "string",
  "addressCountryCode": "string",
  "addressStateCode": "string",
  "addressCityCode": "string",
  "shippingBookingId": "string",
  "orderRemark": "string",
  "clientIp": "string",
  "couponCode": "string",
  "locationLat": "string",
  "staffId": "string",
  "orderMethod": "string",
  "locationLong": "string",
  "gatewayType": "string",
  "paymentType": "string",
  "paymentRedirectLink": "string",
  "qrcode": "string",
  "trackingId": "string",
  "orderId": "string",
  "currency": "string",
  "paymentConfirmRef": "string",
  "paymentStatus": "string",
  "orderStatus": "string",
  "paymentGateway": "string",
  "posted": true,
  "postResponse": "string",
  "orderTime": "2019-08-24T14:15:22Z",
  "orderExpireTime": "2019-08-24T14:15:22Z",
  "multiVendor": true,
  "shippingType": "string",
  "totalVolumeOrdered": 0,
  "totalOrderPrice": 0,
  "totalOrderPriceWithoutTax": 0,
  "totalTaxPrice": 0,
  "totalShipping": 0,
  "totalOrderWithoutShipping": 0,
  "paymentOption": {
    "title": "string",
    "optionMessage": "string",
    "paymentToken": "string",
    "paymentLink": "string",
    "paymentType": "string",
    "active": true
  },
  "itemUnits": [
    {
      "productSlug": "string",
      "itemId": "string",
      "qtyOrdered": 0,
      "sku": "string",
      "variantId": "string",
      "productId": "string",
      "itemName": "string",
      "unit": "string",
      "remark": "string",
      "barcode": "string",
      "itemPrice": 0,
      "itemTax": 0,
      "currency": "string",
      "storeId": "string",
      "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
      },
      "itemPriceAsLong": 0,
      "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
    }
  ]
}

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 PUT 'https://gateway.storeharmony.com/cloudapi/estore//order/' \
--header 'sessiontoken;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "locationId": "string",
    "developerKey": "string",
    "firstname": "string",
    "lastname": "string",
    "customerMobile": "string",
    "customerEmail": "string",
    "customerId": "string",
    "addressCountry": "string",
    "addressState": "string",
    "addressCity": "string",
    "fullAddress": "string",
    "addressCountryCode": "string",
    "addressStateCode": "string",
    "addressCityCode": "string",
    "shippingBookingId": "string",
    "orderRemark": "string",
    "clientIp": "string",
    "couponCode": "string",
    "locationLat": "string",
    "staffId": "string",
    "orderMethod": "string",
    "locationLong": "string",
    "gatewayType": "string",
    "paymentType": "string",
    "paymentRedirectLink": "string",
    "qrcode": "string",
    "trackingId": "string",
    "orderId": "string",
    "currency": "string",
    "paymentConfirmRef": "string",
    "paymentStatus": "string",
    "orderStatus": "string",
    "paymentGateway": "string",
    "posted": true,
    "postResponse": "string",
    "orderTime": "2019-08-24T14:15:22Z",
    "orderExpireTime": "2019-08-24T14:15:22Z",
    "multiVendor": true,
    "shippingType": "string",
    "totalVolumeOrdered": 0,
    "totalOrderPrice": 0,
    "totalOrderPriceWithoutTax": 0,
    "totalTaxPrice": 0,
    "totalShipping": 0,
    "totalOrderWithoutShipping": 0,
    "paymentOption": {
        "title": "string",
        "optionMessage": "string",
        "paymentToken": "string",
        "paymentLink": "string",
        "paymentType": "string",
        "active": true
    },
    "itemUnits": [
        {
            "productSlug": "string",
            "itemId": "string",
            "qtyOrdered": 0,
            "sku": "string",
            "variantId": "string",
            "productId": "string",
            "itemName": "string",
            "unit": "string",
            "remark": "string",
            "barcode": "string",
            "itemPrice": 0,
            "itemTax": 0,
            "currency": "string",
            "storeId": "string",
            "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
            },
            "itemPriceAsLong": 0,
            "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
        }
    ]
}'

Responses

🟢200OK
*/*
OK
Body
locationId
string 
optional
developerKey
string 
optional
firstname
string 
optional
lastname
string 
optional
customerMobile
string 
optional
customerEmail
string 
optional
customerId
string 
optional
addressCountry
string 
optional
addressState
string 
optional
addressCity
string 
optional
fullAddress
string 
optional
addressCountryCode
string 
optional
addressStateCode
string 
optional
addressCityCode
string 
optional
shippingBookingId
string 
optional
orderRemark
string 
optional
clientIp
string 
optional
couponCode
string 
optional
locationLat
string 
optional
staffId
string 
optional
orderMethod
string 
optional
locationLong
string 
optional
gatewayType
string 
optional
paymentType
string 
optional
paymentRedirectLink
string 
optional
qrcode
string 
optional
trackingId
string 
optional
orderId
string 
optional
currency
string 
optional
paymentConfirmRef
string 
optional
paymentStatus
string 
optional
orderStatus
string 
optional
paymentGateway
string 
optional
posted
boolean 
optional
postResponse
string 
optional
orderTime
string <date-time>
optional
orderExpireTime
string <date-time>
optional
multiVendor
boolean 
optional
shippingType
string 
optional
totalVolumeOrdered
number <double>
optional
totalOrderPrice
number <double>
optional
totalOrderPriceWithoutTax
number <double>
optional
totalTaxPrice
number <double>
optional
totalShipping
number <double>
optional
totalOrderWithoutShipping
number <double>
optional
paymentOption
object (PaymentOption) 
optional
title
string 
optional
optionMessage
string 
optional
paymentToken
string 
optional
paymentLink
string 
optional
paymentType
string 
optional
active
boolean 
optional
itemUnits
array[object (OnlineOrderItem) {17}] 
optional
productSlug
string 
optional
itemId
string 
optional
qtyOrdered
number <double>
optional
sku
string 
optional
variantId
string 
optional
productId
string 
optional
itemName
string 
optional
unit
string 
optional
remark
string 
optional
barcode
string 
optional
itemPrice
number <double>
optional
itemTax
number <double>
optional
currency
string 
optional
storeId
string 
optional
item
object (WebStoreItem) 
optional
itemPriceAsLong
integer <int64>
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
{
  "locationId": "string",
  "developerKey": "string",
  "firstname": "string",
  "lastname": "string",
  "customerMobile": "string",
  "customerEmail": "string",
  "customerId": "string",
  "addressCountry": "string",
  "addressState": "string",
  "addressCity": "string",
  "fullAddress": "string",
  "addressCountryCode": "string",
  "addressStateCode": "string",
  "addressCityCode": "string",
  "shippingBookingId": "string",
  "orderRemark": "string",
  "clientIp": "string",
  "couponCode": "string",
  "locationLat": "string",
  "staffId": "string",
  "orderMethod": "string",
  "locationLong": "string",
  "gatewayType": "string",
  "paymentType": "string",
  "paymentRedirectLink": "string",
  "qrcode": "string",
  "trackingId": "string",
  "orderId": "string",
  "currency": "string",
  "paymentConfirmRef": "string",
  "paymentStatus": "string",
  "orderStatus": "string",
  "paymentGateway": "string",
  "posted": true,
  "postResponse": "string",
  "orderTime": "2019-08-24T14:15:22Z",
  "orderExpireTime": "2019-08-24T14:15:22Z",
  "multiVendor": true,
  "shippingType": "string",
  "totalVolumeOrdered": 0,
  "totalOrderPrice": 0,
  "totalOrderPriceWithoutTax": 0,
  "totalTaxPrice": 0,
  "totalShipping": 0,
  "totalOrderWithoutShipping": 0,
  "paymentOption": {
    "title": "string",
    "optionMessage": "string",
    "paymentToken": "string",
    "paymentLink": "string",
    "paymentType": "string",
    "active": true
  },
  "itemUnits": [
    {
      "productSlug": "string",
      "itemId": "string",
      "qtyOrdered": 0,
      "sku": "string",
      "variantId": "string",
      "productId": "string",
      "itemName": "string",
      "unit": "string",
      "remark": "string",
      "barcode": "string",
      "itemPrice": 0,
      "itemTax": 0,
      "currency": "string",
      "storeId": "string",
      "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
      },
      "itemPriceAsLong": 0,
      "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
    }
  ]
}
Modified at 2025-03-27 14:31:04
Previous
Fetch All Categories and Subcategories by Store ID
Next
cancelOrder
Built with