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

MobileOrderRequest

{
    "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:22.123Z",
        "requestEntryId": "string",
        "responseDate": "2019-08-24T14:15:22.123Z",
        "bankAccId": "string",
        "cashierPoint": "string",
        "cashierId": "string",
        "cashierName": "string",
        "currency": "string",
        "settled": true,
        "settleDate": "2019-08-24T14:15:22.123Z",
        "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:22.123Z",
        "registerDate": "2019-08-24T14:15:22.123Z",
        "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:22.123Z",
    "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:22.123Z",
                "expireDate": "2019-08-24T14:15:22.123Z",
                "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:22.123Z",
                "discount": 0,
                "publishedOnline": true,
                "lastArrivalDate": "2019-08-24T14:15:22.123Z",
                "lastArrivalQty": 0,
                "quantity": 0,
                "picture1Url": "string",
                "picture2Url": "string",
                "picture3Url": "string",
                "supplier": "string",
                "supplierMobile": "string",
                "autoRequestSupply": true,
                "staffId": "string",
                "lastSynced": "2019-08-24T14:15:22.123Z",
                "addedDate": "2019-08-24T14:15:22.123Z",
                "batchSupplyDate": "2019-08-24T14:15:22.123Z",
                "firstSynced": "2019-08-24T14:15:22.123Z",
                "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:22.123Z",
                "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:22.123Z",
                "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:22.123Z",
            "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
        }
    ]
}
Built with