Files
Doormilexpress_console/API_ENDPOINTS.md

8.0 KiB

NearlExpress Console — API Endpoints Reference

Auto-generated reference of every API call in src/pages/api/api.js. Base URLs are resolved from the env files at the repo root.

Base URLs

Env variable Resolved value
REACT_APP_URL https://jupiter.nearle.app/live/api/v1
REACT_APP_URL2 https://jupiter.nearle.app/live/api/v2
Bike solver (hardcoded) https://routes.workolik.com
Auto solver (hardcoded) https://routemate.workolik.com
Commit service (hardcoded) https://jupiter.nearle.app

Note: In env.staging, REACT_APP_URL2 is empty — URL2 endpoints resolve to relative paths in that build.


Base REACT_APP_URLhttps://jupiter.nearle.app/live/api/v1

# Function Method Full endpoint
1 getRiderPeriodicLogs GET https://jupiter.nearle.app/live/api/v1/utils/getriderperiodiclogs?userid={userid}
2 fetchAppLocations GET https://jupiter.nearle.app/live/api/v1/partners/getlocations/?userid={userid}
3 fetchPercentageData GET https://jupiter.nearle.app/live/api/v1/orders/getordersummary/?applocationid={appId}&tenantid={tenantid}&locationid={locationid}&fromdate={startdate}&todate={enddate}
4 getTenants GET https://jupiter.nearle.app/live/api/v1/tenants/gettenants/?applocationid={appId}&status=active
5 gettenantlocations GET https://jupiter.nearle.app/live/api/v1/tenants/gettenantlocations/?tenantid={appId}
6 fetchorderscount GET https://jupiter.nearle.app/live/api/v1/orders/getordersummary/?applocationid={appId}&tenantid={tenantid}&locationid={locationid}&fromdate={startdate}&todate={enddate}&status={currentStatus}
7 fetchOrders GET https://jupiter.nearle.app/live/api/v1/orders/tenant/getorders/?applocationid={appId}&tenantid={tenantid}&locationid={locationid}&status={currentStatus}&fromdate={startdate}&todate={enddate}&keyword={search}&pageno={pageParam}&pagesize={rowsPerPage}
8 fetchPaymentType GET https://jupiter.nearle.app/live/api/v1/utils/getapptypes/?tag=paymentmode
9 fetchRidersList GET https://jupiter.nearle.app/live/api/v1/partners/getriders/?applocationid={appId}
10 notifyRider POST https://jupiter.nearle.app/live/api/v1/utils/notifyuser
11 cancelOrder PUT https://jupiter.nearle.app/live/api/v1/orders/updateorder
12 cancelMultipleOrder PUT https://jupiter.nearle.app/live/api/v1/orders/updatemultipleorders
13 fetchDeliveries (all zones) GET https://jupiter.nearle.app/live/api/v1/deliveries/getdeliveries/?appuserid={userid}&status={status}&fromdate={startdate}&todate={enddate}&pageno={pageParam}&pagesize={rowsPerPage}&keyword={search}&tenantid={tenantid}&locationid={locationid}&userid={riderid}
14 fetchDeliveries (by zone) GET https://jupiter.nearle.app/live/api/v1/deliveries/getdeliveries/?applocationid={appId}&status={status}&fromdate={startdate}&todate={enddate}&pageno={pageParam}&pagesize={rowsPerPage}&keyword={search}&tenantid={tenantid}&locationid={locationid}&userid={riderid}
15 fetchPercentageAPI GET https://jupiter.nearle.app/live/api/v1/deliveries/deliverysummary/?applocationid={appId}
16 fetchCountAPI (all zones) GET https://jupiter.nearle.app/live/api/v1/deliveries/deliverysummary/?appuserid={userid}&fromdate={startdate}&todate={enddate}
17 fetchCountAPI (by zone) GET https://jupiter.nearle.app/live/api/v1/deliveries/deliverysummary/?applocationid={appId}&fromdate={startdate}&todate={enddate}&tenantid={tenantid}&locationid={locationid}&userid={riderid}
18 cancelDeliveryAPI PUT https://jupiter.nearle.app/live/api/v1/deliveries/updatedelivery
19 getorderdetails GET https://jupiter.nearle.app/live/api/v1/orders/getorderdetails?orderheaderid={orderHeaderid}
20 changeRiderAPI PUT https://jupiter.nearle.app/live/api/v1/deliveries/updatedelivery
21 updateDeliveryAPI PUT https://jupiter.nearle.app/live/api/v1/deliveries/updatedelivery
22 fetchAllRiders GET `https://jupiter.nearle.app/live/api/v1/partners/getallriders/?applocationid={appId}&pageno={pageParam}&pagesize=20&keyword={search}&status={''
23 getallridersummary GET `https://jupiter.nearle.app/live/api/v1/partners/getallridersummary/?applocationid={appId}&status={''
24 fetchRiders GET https://jupiter.nearle.app/live/api/v1/partners/getriders/?applocationid={appId}&pageno={pageParam}&pagesize=20&keyword={search}
25 getriderstatus GET https://jupiter.nearle.app/live/api/v1/utils/getriderstatus
26 getreportsummary GET https://jupiter.nearle.app/live/api/v1/deliveries/getreportsummary/?applocationid={appId}&tenantid={tenantid}&locationid={locationid}&fromdate={startdate}&todate={enddate}
27 getreportlocationsummary GET https://jupiter.nearle.app/live/api/v1/deliveries/getreportlocationsummary/?applocationid={appId}&tenantid={tenantid}&locationid={locationid}&fromdate={startdate}&todate={enddate}
28 getriderbydelivery GET https://jupiter.nearle.app/live/api/v1/deliveries/getriderbydelivery/?applocationid={appId}&tenantid={tenantid}&locationid={locationid}&fromdate={startdate}&todate={enddate}
29 fetchCount (all zones) GET https://jupiter.nearle.app/live/api/v1/deliveries/deliverysummary/?fromdate={startdate}&todate={enddate}
30 fetchCount (by zone) GET https://jupiter.nearle.app/live/api/v1/deliveries/deliverysummary/?applocationid={appId}&fromdate={startdate}&todate={enddate}
31 fetchRidersSummary GET https://jupiter.nearle.app/live/api/v1/deliveries/getridersummary/?applocationid={appId}&fromdate={startdate}&todate={enddate}
32 fetchLocations GET https://jupiter.nearle.app/live/api/v1/partners/getpartners
33 fetchOrders1 GET https://jupiter.nearle.app/live/api/v1/orders/tenant/getorders/?tenantid={tenantid}&locationid={locationid}&status={status}&fromdate={startdate}&todate={enddate}&pageno={pageParam}&pagesize={rowsPerPage}&keyword={search}
34 getusers GET https://jupiter.nearle.app/live/api/v1/users/getusers/?configid=9&userid={userid}
35 getallriders GET https://jupiter.nearle.app/live/api/v1/partners/getallriders?partnerid=64

Base REACT_APP_URL2https://jupiter.nearle.app/live/api/v2

# Function Method Full endpoint
36 fetchorderdetails (all zones) GET https://jupiter.nearle.app/live/api/v2/orders/getorders/?appuserid={userid}&fromdate={startdate}&todate={enddate}&pageno={page+1}&pagesize={rowsPerPage}
37 fetchorderdetails (by zone) GET https://jupiter.nearle.app/live/api/v2/orders/getorders/?fromdate={startdate}&todate={enddate}&applocationid={appId}&pageno={page}&pagesize={rowsPerPage}
38 fetchRidersLogs GET https://jupiter.nearle.app/live/api/v2/partners/getriderlogs/?applocationid={appId}&fromdate={startdate}&todate={startdate}&keyword={search}

Hardcoded — Bike solver https://routes.workolik.com

# Function Method Full endpoint
39 createOptimisationDeliveries POST https://routes.workolik.com/api/v1/optimization/createdeliveries
40 reconcileSteps POST https://routes.workolik.com/api/v1/optimization/reconcile-steps
41 fetchBatchEfficiency POST https://routes.workolik.com/api/v1/batch/efficiency
42 createAutomationDeliveries (bike mode) POST https://routes.workolik.com/api/v1/optimization/riderassign?hypertuning_params={params}

Hardcoded — Auto solver https://routemate.workolik.com

# Function Method Full endpoint
43 createAutomationDeliveries (auto mode) POST https://routemate.workolik.com/api/v1/optimization/riderassign?strategy=multi_trip

Hardcoded — Commit service https://jupiter.nearle.app

# Function Method Full endpoint
44 finalCreatedeliveries POST https://jupiter.nearle.app/live/api/v1/deliveries/createdeliveries