20 KiB
Nearle LiveSetup GET APIs Directory
This document lists all active GET APIs registered under the LiveSetup routing function in the Nearle backend.
- Base URL:
https://jupiter.nearle.app/ - Namespace:
/live/api/... - Format: HTTP GET query parameters
👤 Users & Authorization GET APIs
http
Get a specific user profile by ID (Mobile/Client)
https://jupiter.nearle.app/live/api/v1/users/getusers?userid=12
Get a specific user profile by Username (Mobile/Client)
https://jupiter.nearle.app/live/api/v1/users/getusers?username=rider_joe
Get all users (V1)
Get all users (V2)
👥 Customer Management GET APIs
http
Fetch customer profile by ID (Mobile)
https://jupiter.nearle.app/live/api/v1/customers/getbyid?customerid=4082
Fetch customer profile by Contact Number (Mobile)
https://jupiter.nearle.app/live/api/v1/customers/getbyno?contactno=%2B61411222333
Retrieve customers linked to a tenant
https://jupiter.nearle.app/live/api/v1/customers/getbytid?tenantid=8&pageno=1&pagesize=10
Retrieve customers linked to a tenant location/branch
https://jupiter.nearle.app/live/api/v1/customers/gettenantcustomers?tenantid=8&pageno=1&pagesize=10
Get customer saved address locations (Mobile)
https://jupiter.nearle.app/live/api/v1/customers/getcustomerlocation?customerid=4082
Retrieve customers linked to a general app location zone
https://jupiter.nearle.app/live/api/v1/customers/getcustomersbyapplocation?applocationid=5
Retrieve all registered customers with paginated keywords
https://jupiter.nearle.app/live/api/v1/customers/getallcustomers?pageno=1&pagesize=10&keyword=smith
Get customer counts and classifications summaries under a tenant
https://jupiter.nearle.app/live/api/v1/customers/getcustomersummary?tenantid=8
Search customer names under a tenant
https://jupiter.nearle.app/live/api/v1/customers/search?keyword=Jane&tenantid=8
Get customer logged support requests (Mobile)
📦 Products & Catalog GET APIs
http
Retrieve all registered products with extensive filters
Fetch detailed information of a single product (Mobile)
https://jupiter.nearle.app/live/api/v1/products/getproductinfo?productid=101
List all general product categories (Mobile)
https://jupiter.nearle.app/live/api/v1/products/getproductcategories
List product subcategories under a specific category and tenant
https://jupiter.nearle.app/live/api/v1/products/getproductsubcategories?categoryid=4&tenantid=8
Get products grouped under subcategories
Retrieve product counts categorized by tenant and subcategory
Fetch product detail matches by Variant ID
https://jupiter.nearle.app/live/api/v1/products/getproductbyvariant?tenantid=8&variantid=22
List variants available under a tenant subcategory
https://jupiter.nearle.app/live/api/v1/products/getproductvariants?tenantid=8&subcategoryid=14
Get active product discount rules under a tenant
https://jupiter.nearle.app/live/api/v1/products/getproductdiscounts?tenantid=8
Retrieve products catalog for customer order creation (Mobile V2)
Retrieve products mapped to a physical location (V2)
Retrieve summary metrics of products in a location (V2)
https://jupiter.nearle.app/live/api/v2/products/getlocationproductsummary?tenantid=8&locationid=45
Query product stock ledger statement history (V2)
Query current active product stock levels (V2)
https://jupiter.nearle.app/live/api/v2/products/getproductstocks?tenantid=8&locationid=45
Query category-wise inventory summary statistics (V2)
Fetch stock statement summaries (V2)
https://jupiter.nearle.app/live/api/v2/products/getstockstatementsummary?tenantid=8&locationid=45
🛒 Order Management GET APIs
http
Query all orders with custom filters (V1)
Query partner dispatch tasks (V1)
Query tenant physical store orders (V1)
Query specific customer orders (V1)
https://jupiter.nearle.app/live/api/v1/orders/customer/getorders?customerid=12&pageno=1&pagesize=10
Retrieve order locations count summary under a tenant (V1)
https://jupiter.nearle.app/live/api/v1/orders/tenant/getlocationsummary?tenantid=8
Query consolidated order values summaries (V1)
Query order status counts grouped by app location hubs (V1)
https://jupiter.nearle.app/live/api/v1/orders/getlocationsummary?tenantid=8
Get monthly order counts grouped by app locations (V1)
https://jupiter.nearle.app/live/api/v1/orders/getorderinsight?tenantid=8
Retrieve item line details and pricing summaries for an order (Mobile V1)
https://jupiter.nearle.app/live/api/v1/orders/getorderdetails?orderheaderid=9821
Get customer orders filtered by application location zone (V1)
https://jupiter.nearle.app/live/api/v1/orders/getorderbylocations?customerid=12&applocationid=5
Query active orders list (V2)
Retrieve monthly counts per tenant store location (V2)
https://jupiter.nearle.app/live/api/v2/orders/getorderinsight?tenantid=8
Fetch daily consolidated order summary values (V2)
Retrieve tenant location-wise active order classifications (V2)
https://jupiter.nearle.app/live/api/v2/orders/getlocationsummary?tenantid=8
Search customer orders with keywords and paging (V3)
🚚 Deliveries & Dispatch GET APIs
http
Query parameterized deliveries list with search keyword (V2)
Query parameterized deliveries list with search keyword (V3)
Query event transaction logs trail of a delivery (V1)
https://jupiter.nearle.app/live/api/v1/deliveries/getdeliverylogs?deliveryid=405
Query event log history of a delivery (V2)
https://jupiter.nearle.app/live/api/v2/deliveries/getdeliverylogs?deliveryid=405
Query event log history of a delivery (V3)
https://jupiter.nearle.app/live/api/v3/deliveries/getdeliverylogs?deliveryid=405
Query delivery status classification values (V1)
Retrieve active deliveries count statistics grouped by app location (V1)
https://jupiter.nearle.app/live/api/v1/deliveries/getlocationsummary?tenantid=8
Query active deliveries summary grouped by location (V2)
https://jupiter.nearle.app/live/api/v2/deliveries/getlocationsummary?tenantid=8
Get current dispatch tasks queue (Mobile V1)
https://jupiter.nearle.app/live/api/v1/deliveries/getdeliveryqueues?tenantid=8&locationid=45
Get picked dispatch tasks from queue (Mobile V1)
https://jupiter.nearle.app/live/api/v1/deliveries/getdeliveryqueuespicked?tenantid=8&locationid=45
Query active dispatch task queues (Mobile V2)
https://jupiter.nearle.app/live/api/v2/deliveries/getdeliveryqueues?tenantid=8&locationid=45
Get monthly delivery performance summaries (V1)
https://jupiter.nearle.app/live/api/v1/deliveries/getdeliveryinsight?tenantid=8
Get complete distance, COD collections, and tasks report summaries (V1)
Get report summaries grouped by tenant store location (V1)
Query report stats per Rider per tenant store location (V1)
Retrieve active riders shift and duty metric summaries (V1)
Retrieve Rider metrics summary grouped by store location (V1)
Fetch details of Rider assigned to a delivery task (Mobile V1)
https://jupiter.nearle.app/live/api/v1/deliveries/getriderbydelivery?deliveryid=405
Retrieve last delivery detail matching customer contact number (V1)
https://jupiter.nearle.app/live/api/v1/deliveries/getlastdeliverybycontact?contactno=%2B61411222333
Get specific rider performance report summary (V1)
Query raw logs of rider activity (V1)
🧾 Invoices & Billing GET APIs
http
Retrieve next sequence identifier for tenant invoice generation
https://jupiter.nearle.app/live/api/v1/invoice/getseqno?tenantid=8
List orders associated under an invoice
https://jupiter.nearle.app/live/api/v1/invoice/getinvoiceorders?invoiceid=402
Query invoices catalog with paging and status checks
Retrieve consolidate revenue insights for invoice billing
https://jupiter.nearle.app/live/api/v1/invoice/getinvoiceinsight?tenantid=8
🏢 Tenant & Location GET APIs
http
Fetch complete metadata and credentials of a single tenant
https://jupiter.nearle.app/live/api/v1/tenants/gettenantinfo?tenantid=8
Search tenant registries by name or email keyword
https://jupiter.nearle.app/live/api/v1/tenants/search?keyword=sydney
Query list of staff roster belonging to a tenant location
https://jupiter.nearle.app/live/api/v1/tenants/getstaffs?tenantid=8&locationid=45
Get active tenants mapped under an application hub zone
https://jupiter.nearle.app/live/api/v1/tenants/gettenants?applocationid=5
Query complete list of tenants
https://jupiter.nearle.app/live/api/v1/tenants/getalltenants?pageno=1&pagesize=10&keyword=grocery
Query consolidated location metrics under a tenant
https://jupiter.nearle.app/live/api/v1/tenants/gettenantsummary?tenantid=8
Check if tenant uses online cloud inventory storage
https://jupiter.nearle.app/live/api/v1/tenants/getcloudstore?tenantid=8
Query physical warehouses/outlets mapped to a tenant
https://jupiter.nearle.app/live/api/v1/tenants/gettenantlocations?tenantid=8&pageno=1&pagesize=10
Get operational time slots for orders fulfillment
https://jupiter.nearle.app/live/api/v1/tenants/gettenantslots?tenantid=8&locationid=45
Query coordinate and contact details of a single store location
https://jupiter.nearle.app/live/api/v1/tenants/gettenantlocation?locationid=45
Get delivery pricing rules configured for a tenant
https://jupiter.nearle.app/live/api/v1/tenants/gettenantpricing?tenantid=8
Query support ticket requests created by a tenant
https://jupiter.nearle.app/live/api/v1/tenants/gettenantrequests?tenantid=8&pageno=1&pagesize=10
Query pricing list configured for a tenant
https://jupiter.nearle.app/live/api/v1/tenants/getpricinglist?tenantid=8
Query promotional active marketing discount settings
https://jupiter.nearle.app/live/api/v1/tenants/gettenantpromotions?tenantid=8
Query location high level metric summary (V2)
https://jupiter.nearle.app/live/api/v2/tenants/getlocationsummary?tenantid=8
Query active staff roster status metrics (V2)
https://jupiter.nearle.app/live/api/v2/tenants/gettenantstaffsummary?tenantid=8&locationid=45
Query active dispatch rider metric counts (V2)
https://jupiter.nearle.app/live/api/v2/tenants/gettenantridersummary?tenantid=8&locationid=45
Query list of tenants servicing a customer location (V2)
https://jupiter.nearle.app/live/api/v2/tenants/getcustomertenants?customerid=12&applocationid=5
🛠️ Utilities & Configurations GET APIs
http
Get active app physical hub locations (V1)
https://jupiter.nearle.app/live/api/v1/utils/getapplocations?applocationid=5
Get active app physical hub locations (V2)
https://jupiter.nearle.app/live/api/v2/utils/getapplocations?userid=12
Get core app specifications and provider credentials (V1)
https://jupiter.nearle.app/live/api/v1/utils/getappconfig?configid=6
Get all system app configurations
https://jupiter.nearle.app/live/api/v1/utils/getallappconfig
Get application type classifications matching tag string
https://jupiter.nearle.app/live/api/v1/utils/getapptypes?tag=Rider
List app categories mapped under module configuration
https://jupiter.nearle.app/live/api/v1/utils/getcategories?moduleid=6
List app subcategories under category and module configurations
https://jupiter.nearle.app/live/api/v1/utils/getsubcategories?moduleid=6&categoryid=4
Query exact pricing configurations mapped to zone and config
Get all app delivery pricing ranges
https://jupiter.nearle.app/live/api/v1/utils/getallpricing?applocationid=5
Retrieve app zone configs
https://jupiter.nearle.app/live/api/v1/utils/getapplocationconfig?applocationid=5
Query push notifications history processed for tenant
https://jupiter.nearle.app/live/api/v1/utils/gettenantnotifications?tenantid=8&pageno=1&pagesize=10
Fetch third-party shopfront sync order payloads
https://jupiter.nearle.app/live/api/v1/utils/getshopfrontorders
Get rider cumulative bonus points summary
https://jupiter.nearle.app/live/api/v1/utils/getuserbonussummary?userid=12
List all system platform roles
https://jupiter.nearle.app/live/api/v1/utils/getuserroles
Retrieve app user credentials stored in Redis cache
https://jupiter.nearle.app/live/api/v1/utils/getuserredis?userid=12
Query raw rider logs cached in memory
https://jupiter.nearle.app/live/api/v1/utils/getriderperiodiclogs?userid=12
Query current cached online/duty status of a Rider
https://jupiter.nearle.app/live/api/v1/utils/getriderstatus?userid=12
🤝 Logistics Partner GET APIs
http
Get active dispatch riders summary metrics
https://jupiter.nearle.app/live/api/v1/partners/getactiveriderssummary?partnerid=102
Get available rider operational shifts
https://jupiter.nearle.app/live/api/v1/partners/getridershifts?partnerid=102&shiftdate=2026-05-20
Query delivery billing price configurations for riders
https://jupiter.nearle.app/live/api/v1/partners/getriderpricing?partnerid=102&applocationid=5
Retrieve rider pools availability status
https://jupiter.nearle.app/live/api/v1/partners/getriderpool?partnerid=102&applocationid=5
Retrieve general rider user info metadata (V1)
https://jupiter.nearle.app/live/api/v1/partners/getriderinfo?partnerid=102&userid=12
Retrieve general rider user info metadata (V2)
https://jupiter.nearle.app/live/api/v2/partners/getriderinfo?partnerid=102&userid=12
Fetch active logistics riders status metrics (V1)
https://jupiter.nearle.app/live/api/v1/partners/getriders?partnerid=102&applocationid=5
Fetch active logistics riders status metrics (V2)
https://jupiter.nearle.app/live/api/v2/partners/getriders?partnerid=102&applocationid=5
Query full details of a single rider (V1)
https://jupiter.nearle.app/live/api/v1/partners/getriderdetail?userid=12
List all registered riders in the partner pool
https://jupiter.nearle.app/live/api/v1/partners/getallriders?partnerid=102&pageno=1&pagesize=10
List partner profiles
https://jupiter.nearle.app/live/api/v1/partners/getpartners?partnerid=102
Fetch physical location configuration mappings
https://jupiter.nearle.app/live/api/v1/partners/getlocations?partnerid=102
List partner logins under user directory
https://jupiter.nearle.app/live/api/v1/partners/getpartnerusers?partnerid=102
Get order counts completed per rider
Fetch rider logs (V1)
https://jupiter.nearle.app/live/api/v1/partners/getriderlog?userid=12&logdate=2026-05-20
Query rider cumulative login logs (V1)
Query rider cumulative login logs (V2)
Get weekly cumulative kilometers traveled by rider
Get rider support requests
https://jupiter.nearle.app/live/api/v1/partners/getridersupport?userid=12
Get consolidated summary profiles of all riders
https://jupiter.nearle.app/live/api/v1/partners/getallridersummary?partnerid=102
Get summary of rider location mappings
https://jupiter.nearle.app/live/api/v1/partners/getuserlocationsummary?partnerid=102
Retrieve admin access tokens
https://jupiter.nearle.app/live/api/v1/partners/getadmintoken?partnerid=102
Get today's delivery status metrics
https://jupiter.nearle.app/live/api/v2/partners/getdeliverystats?partnerid=102
💳 Payments & Platform Admin GET APIs
http
Query payment requests log
https://jupiter.nearle.app/live/api/v1/payments/requests/getpaymentrequest?customerid=12
Retrieve specific order summaries under administrator access
https://jupiter.nearle.app/live/api/v1/admin/orders/getorders?tenantid=8&pageno=1&pagesize=10
Fetch SMS provider specifications
https://jupiter.nearle.app/live/api/v1/platform/getsmsprovider