express
This commit is contained in:
184
Get Api's.txt
184
Get Api's.txt
@@ -1,184 +0,0 @@
|
||||
👤 Users & Authorization GET APIs
|
||||
http
|
||||
|
||||
|
||||
# Get all users (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/users/getallusers?roleid=2&tenantid=8&pageno=1&pagesize=10&keyword=john
|
||||
# Get a specific user profile by ID (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/users/getusers?userid=12
|
||||
# Get a specific user profile by ID (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/users/getusers?userid=15
|
||||
👥 Customer Management GET APIs
|
||||
http
|
||||
|
||||
|
||||
# Fetch customer profile by ID or Contact (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/customers/getbyid?customerid=4082&contactno=9876543210
|
||||
# Get customer saved address locations (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/customers/getcustomerlocation?customerid=4082
|
||||
# Get customer logged support requests (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/customers/getcustomerrequests?customerid=4082&pageno=1&pagesize=10
|
||||
# Search customer names under a tenant (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/customers/search?keyword=Jane&tenantid=8
|
||||
# Retrieve customers linked to a tenant location (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/customers/gettenantcustomers?tenantid=8&locationid=2&pageno=1&pagesize=10
|
||||
# Retrieve merchant customers list (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/customers/gettenantcustomers?tenantid=8&locationid=2&pageno=1&pagesize=10&keyword=jane
|
||||
📦 Product & Catalog GET APIs
|
||||
http
|
||||
|
||||
|
||||
# Get product subcategories (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/products/getproductsubcategories?categoryid=2&tenantid=8
|
||||
# Get products stock counts (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/products/getproductscount?tenantid=8&categoryid=2&subcategoryid=12&approve=1
|
||||
# Get all global categories (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/products/getproductcategories
|
||||
# Get specific product variants (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/products/getproductvariants?tenantid=8&subcategoryid=12
|
||||
# Get master catalog listings (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/products/getcatalougeproducts?tenantid=8&locationid=2&subcategoryid=12&keyword=&pageno=1&pagesize=10
|
||||
# Get live stocks catalog (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/products/getproductstocks?tenantid=8&locationid=2
|
||||
# Get dynamic stock statement ledger (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/products/getstockstatement?tenantid=8&locationid=2&subcategoryid=12&pageno=1&pagesize=10&keyword=
|
||||
# Get outlet geofenced inventory (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/products/getlocationproducts?tenantid=8&locationid=2&subcategoryid=12&pageno=1&pagesize=10
|
||||
# Get outlet category inventory summary (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/products/getlocationproductsummary?tenantid=8&locationid=2
|
||||
# Master products search board (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/products/getallproducts?tenantid=8&locationid=2&keyword=milk&pageno=1&pagesize=10
|
||||
# Get product details by variant ID (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/products/getproductbyvariant?tenantid=8&variantid=4
|
||||
# Get product subcategories (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/products/getproductsubcategories?categoryid=2&tenantid=8
|
||||
# Search product catalog (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/products/getallproducts?keyword=milk&pageno=1&pagesize=10
|
||||
# Get structured home subcategory list (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/products/getproductsbysubcategory?categoryid=2&tenantid=8&locationid=2
|
||||
# Get mobile geofenced outlet products (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/products/getlocationproducts?tenantid=8&locationid=2&pageno=1&pagesize=20
|
||||
📋 Order Orchestration GET APIs
|
||||
http
|
||||
|
||||
|
||||
# Filtered dynamic orders board (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/orders/getorders?tenantid=8&locationid=2&status=processing&pageno=1&pagesize=10
|
||||
# Tenant orders board (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/orders/tenant/getorders?tenantid=8&locationid=2&status=processing&pageno=1&pagesize=10
|
||||
# Partner fleet orders board (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/orders/partner/getorders?partnerid=1&status=processing&pageno=1&pagesize=10
|
||||
# Individual consumer invoice histories (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/orders/customer/getorders?customerid=4082&status=delivered&pageno=1&pagesize=10
|
||||
# Operator/User orders board (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/orders/user/getorders?appuserid=12&status=processing&pageno=1&pagesize=10
|
||||
# System Admin orders board (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/orders/admin/getorders?applocationid=1&status=processing&pageno=1&pagesize=10
|
||||
# Get order dashboard stats summary (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/orders/getordersummary?tenantid=8&fromdate=2026-05-01&todate=2026-05-20
|
||||
# Get location orders summary (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/orders/getlocationsummary?tenantid=8
|
||||
# Get annual orders insights analytics (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/orders/getorderinsight?tenantid=8
|
||||
# Get order detailed lines (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/orders/getorderdetails?orderheaderid=2099
|
||||
# Get customer order history (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/orders/getcustomerorders?customerid=4082&pageno=1&pagesize=10
|
||||
# Get specific tenant store orders (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/orders/tenant/getorders?tenantid=8&locationid=2&pageno=1&pagesize=10
|
||||
# Get mobile order detailed lines (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/orders/getorderdetails?orderheaderid=2099
|
||||
🏍️ Partner & Rider GET APIs
|
||||
http
|
||||
|
||||
|
||||
# Get active riders (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/partners/getriders?partnerid=1&applocationid=1&userid=12&tenantid=8
|
||||
# Get partner profiles (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/partners/getpartners?partnerid=1&applocationid=1&userid=12
|
||||
# Get rider shifts (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/partners/getridershifts?applocationid=1
|
||||
# Get location configurations (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/partners/getlocations?userid=12&configid=1
|
||||
# Get rider log sheet (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/partners/getriderlogs?partnerid=1&applocationid=1&fromdate=2026-05-20&todate=2026-05-20
|
||||
# Get partner profiles (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/partners/getpartners?partnerid=1&applocationid=1&userid=12
|
||||
# Get rider log sheet (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/partners/getriderlogs?partnerid=1&applocationid=1&fromdate=2026-05-20&todate=2026-05-20
|
||||
# Get rider operational info (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/partners/getriderinfo?userid=15
|
||||
# Get active riders list (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/partners/getriders?partnerid=1&applocationid=1&userid=15&tenantid=8
|
||||
🚚 Logistics & Deliveries GET APIs
|
||||
http
|
||||
|
||||
|
||||
# Get deliveries performance summaries (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/deliveries/deliverysummary?tenantid=8&partnerid=1&userid=12&applocationid=1&locationid=2&fromdate=2026-05-20&todate=2026-05-20
|
||||
# Get daily delivery insights (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/deliveries/getdeliveryinsight?tenantid=8
|
||||
# Get location deliveries summary (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/deliveries/getlocationsummary?tenantid=8
|
||||
# Get deliveries financial report summary (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/deliveries/getreportsummary?tenantid=8&partnerid=1&userid=12&applocationid=1&fromdate=2026-05-01&todate=2026-05-20
|
||||
# Get fleet rider summary metrics (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/deliveries/getridersummary?applocationid=1&partnerid=1&tenantid=8&fromdate=2026-05-20&todate=2026-05-20
|
||||
# Get master deliveries board (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/deliveries/getdeliveries?tenantid=8&fromdate=2026-05-20&todate=2026-05-20
|
||||
# Get mobile dispatch summaries (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/deliveries/deliverysummary?userid=15&fromdate=2026-05-20&todate=2026-05-20
|
||||
# Get mobile deliveries board (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/deliveries/getdeliveries?userid=15&status=assigned
|
||||
# Fetch rider active shift deliveries queue (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/deliveries/getdeliveryqueues?userid=15&fromdate=2026-05-20&todate=2026-05-20
|
||||
🏪 Tenant & Outlet Location GET APIs
|
||||
http
|
||||
|
||||
|
||||
# Search registered tenants (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/tenants/search?status=Active&keyword=Fresh
|
||||
# Search tenants by keyword (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/tenants/searchbykeyword?keyword=daily
|
||||
# Get all active tenants catalog (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/tenants/getalltenants?applocationid=1&status=Active&pageno=1&pagesize=10
|
||||
# Get outlet locations assigned to a tenant (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/tenants/gettenantlocations?tenantid=8
|
||||
# Retrieve delivery time slots config (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/tenants/gettenantslot
|
||||
# Search tenants by keyword (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/tenants/searchbykeyword?keyword=grocery
|
||||
# Retrieve tenants associated with a customer (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/tenants/getcustomertenants?customerid=4082&tenant=0
|
||||
# Get outlet locations linked to a tenant (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/tenants/gettenantlocations?tenantid=8
|
||||
# Get logistics pricing slabs for a tenant (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/tenants/gettenantpricing?tenantid=8&applocationid=1
|
||||
# Get staff members under a tenant store (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/tenants/getstaffs?tenantid=8
|
||||
# Get tenant detailed profile info (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/tenants/gettenantinfo?tenantid=8&locationid=2
|
||||
⚙️ Utilities & General Configurations GET APIs
|
||||
http
|
||||
|
||||
|
||||
# Fetch application categories by tag (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/utils/getapptypes?tag=customer
|
||||
# Resolve subcategories (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/utils/getsubcategories?moduleid=1&categoryid=2
|
||||
# Fetch system active geofence details (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/utils/getapplocations?applocationid=1
|
||||
# Fetch global system categories configurations (Web)
|
||||
https://fiesta.nearle.app/live/api/v1/web/utils/getappcategories
|
||||
# Get mobile geofence configuration details (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/utils/getapplocationconfig?applocationid=1
|
||||
# Get mobile active geofence details (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/utils/getapplocations?applocationid=1
|
||||
# Fetch mobile app types by tag (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/utils/getapptypes?tag=rider
|
||||
# Fetch global payment & geofence configs (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/utils/getappconfig?configid=1
|
||||
# Get mobile category subcategories list (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/utils/getsubcategories?moduleid=1&categoryid=2
|
||||
# Fetch mobile app categories configurations (Mobile)
|
||||
https://fiesta.nearle.app/live/api/v1/mob/utils/getappcategories
|
||||
@@ -1,652 +0,0 @@
|
||||
1. User & Authentication APIs
|
||||
💻 Web Portal
|
||||
POST Tenant Web Panel Login
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/users/tenant/weblogin
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"authname": "merchant_admin_01",
|
||||
"password": "PasswordSecurityHash99!"
|
||||
}
|
||||
POST General Application Login
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/users/applogin
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"authname": "system_operator",
|
||||
"password": "OperatorSafePasswordSecret",
|
||||
"deviceid": "device_uuid_8828b",
|
||||
"devicetype": "android"
|
||||
}
|
||||
POST Register New Web Staff Account
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/users/create
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"authname": "tenant_staff_steve",
|
||||
"firstname": "Steve",
|
||||
"lastname": "Rogers",
|
||||
"password": "SteveSecurePassword12",
|
||||
"email": "steve.rogers@merchant.com",
|
||||
"dialcode": "+61",
|
||||
"contactno": "412345678",
|
||||
"roleid": 3,
|
||||
"pin": 1234,
|
||||
"address": "100 Flinders St",
|
||||
"suburb": "Melbourne",
|
||||
"city": "Melbourne",
|
||||
"state": "VIC",
|
||||
"postcode": "3000",
|
||||
"tenantid": 8,
|
||||
"locationid": 2,
|
||||
"applocationid": 1,
|
||||
"status": "active"
|
||||
}
|
||||
PUT Update Web Staff User Details
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/users/update
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"userid": 15,
|
||||
"firstname": "Steve",
|
||||
"lastname": "Captain",
|
||||
"email": "steve.captain@merchant.com",
|
||||
"contactno": "412345678",
|
||||
"address": "200 Flinders St",
|
||||
"suburb": "Melbourne",
|
||||
"city": "Melbourne",
|
||||
"state": "VIC",
|
||||
"postcode": "3000",
|
||||
"status": "active"
|
||||
}
|
||||
📱 Mobile App
|
||||
POST Rider/Merchant Mobile App Login
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/users/tenant/login
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"authname": "rider_john_01",
|
||||
"password": "RiderSecretKey"
|
||||
}
|
||||
POST Create Mobile Staff User
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/users/create
|
||||
Payload: (Uses the same schema as Web Register New Web Staff Account)
|
||||
PUT Update Mobile Staff Details
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/users/update
|
||||
Payload: (Uses the same schema as Web Update Web Staff User Details)
|
||||
2. Customer Management APIs
|
||||
📱 Mobile App
|
||||
POST Passwordless OTP Login (via Phone)
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/customers/login
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"contactno": "0499888777"
|
||||
}
|
||||
POST Register Customer Account
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/customers/create
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"firstname": "Jane",
|
||||
"lastname": "Smith",
|
||||
"profileimage": "https://storage.nearle.app/avatars/jane_smith.jpg",
|
||||
"gender": "Female",
|
||||
"dob": "1994-11-20",
|
||||
"dialcode": "+61",
|
||||
"contactno": "499888777",
|
||||
"email": "jane.smith@gmail.com",
|
||||
"deviceid": "uuid_7728b991a",
|
||||
"devicetype": "ios",
|
||||
"authmode": 1,
|
||||
"customertoken": "fcm_token_device_hash_xyz",
|
||||
"address": "456 Oak Avenue",
|
||||
"suburb": "Richmond",
|
||||
"city": "Melbourne",
|
||||
"state": "VIC",
|
||||
"postcode": "3121",
|
||||
"latitude": "-37.8212",
|
||||
"longitude": "144.9984",
|
||||
"applocationid": 1,
|
||||
"status": 1,
|
||||
"intro": "Regular subscriber of organic morning deliveries."
|
||||
}
|
||||
POST Save New Geofenced Location Address
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/customers/createlocations
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"customerid": 4082,
|
||||
"address": "123 High Street",
|
||||
"suburb": "Prahran",
|
||||
"city": "Melbourne",
|
||||
"state": "VIC",
|
||||
"postcode": "3181",
|
||||
"latitude": "-37.8502",
|
||||
"longitude": "144.9924",
|
||||
"primaryaddress": 1,
|
||||
"status": 1
|
||||
}
|
||||
POST Log Customer Support Ticket Request
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/customers/createcustomerrequest
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"customerid": 4082,
|
||||
"tenantid": 8,
|
||||
"apptypeid": 1,
|
||||
"locationid": 2,
|
||||
"subject": "Delay in Morning Milk Delivery",
|
||||
"remarks": "Order scheduled for 7:00 AM hasn't arrived.",
|
||||
"status": 1
|
||||
}
|
||||
PUT Update Customer Profile Details
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/customers/update
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"customerid": 4082,
|
||||
"firstname": "Jane",
|
||||
"lastname": "Miller",
|
||||
"email": "jane.miller@gmail.com",
|
||||
"contactno": "499888777",
|
||||
"address": "789 Pine Road",
|
||||
"suburb": "Hawthorn",
|
||||
"city": "Melbourne",
|
||||
"state": "VIC",
|
||||
"postcode": "3122",
|
||||
"status": 1
|
||||
}
|
||||
3. Catalog & Product Inventory APIs
|
||||
💻 Web Portal
|
||||
POST Add Multi-Product Stock Entry
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/products/createproductstock
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
[
|
||||
{
|
||||
"tenantid": 8,
|
||||
"locationid": 2,
|
||||
"productid": 105,
|
||||
"quantity": 150,
|
||||
"stocktype": "credit",
|
||||
"status": "active"
|
||||
},
|
||||
{
|
||||
"tenantid": 8,
|
||||
"locationid": 2,
|
||||
"productid": 109,
|
||||
"quantity": 80,
|
||||
"stocktype": "credit",
|
||||
"status": "active"
|
||||
}
|
||||
]
|
||||
POST Create Master Product Catalog Item
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/products/create
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"applocationid": 1,
|
||||
"tenantid": 8,
|
||||
"categoryid": 2,
|
||||
"subcategoryid": 12,
|
||||
"productname": "Fresh Cow Milk 1L",
|
||||
"productimage": "https://storage.nearle.app/products/cow_milk_1l.png",
|
||||
"productdesc": "Pure farm fresh cow milk pasteurized.",
|
||||
"productsku": "MILK-COW-1L",
|
||||
"productunit": "Litre",
|
||||
"unitvalue": "1",
|
||||
"productcost": 1.80,
|
||||
"retailprice": 3.50,
|
||||
"taxpercent": 5.00,
|
||||
"productstock": 100,
|
||||
"productstatus": "available",
|
||||
"approve": 1
|
||||
}
|
||||
POST Map Product to Specific Outlet Location
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/products/createproductlocation
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
[
|
||||
{
|
||||
"tenantid": 8,
|
||||
"locationid": 2,
|
||||
"productid": 105,
|
||||
"catlougeid": 1,
|
||||
"minquantity": 5,
|
||||
"maxquantity": 200,
|
||||
"price": 3.75,
|
||||
"status": "Active"
|
||||
}
|
||||
]
|
||||
POST Create Product Variant Metadata
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/products/createproductvariant
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"tenantid": 8,
|
||||
"variantname": "1.5 Liters Bottle",
|
||||
"categoryid": 2,
|
||||
"subcategoryid": 12,
|
||||
"status": "active"
|
||||
}
|
||||
PUT Update Master Product Details
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/products/update
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"productid": 105,
|
||||
"productname": "Organic Farm Cow Milk 1L",
|
||||
"productcost": 1.95,
|
||||
"retailprice": 3.75,
|
||||
"productstock": 120,
|
||||
"productstatus": "available"
|
||||
}
|
||||
PUT Update Product Outlet Constraints
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/products/updateproductlocation
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"productlocationid": 25,
|
||||
"tenantid": 8,
|
||||
"locationid": 2,
|
||||
"productid": 105,
|
||||
"minquantity": 10,
|
||||
"maxquantity": 150,
|
||||
"price": 3.99,
|
||||
"status": "Active"
|
||||
}
|
||||
DELETE Purge Master Product Catalog Entry
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/products/delete?productid=105
|
||||
Parameters:
|
||||
productid (int, required): Unique ID of the catalog item to be purged.
|
||||
📱 Mobile App
|
||||
PUT Mobile Update Product Details
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/products/update
|
||||
Payload: (Uses the same schema as Web Update Master Product Details)
|
||||
PUT Mobile Update Product Outlet Config
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/products/updateproductlocation
|
||||
Payload: (Uses the same schema as Web Update Product Outlet Constraints)
|
||||
4. Order Orchestration APIs
|
||||
💻 Web Portal
|
||||
POST Create New Web Order (Flat JSON Format)
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/orders/createorder
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"tenantid": 8,
|
||||
"locationid": 2,
|
||||
"applocationid": 1,
|
||||
"moduleid": 1,
|
||||
"customerid": 4082,
|
||||
"orderstatus": "pending",
|
||||
"deliverytype": "standard",
|
||||
"deliverytime": "2026-05-20 18:00:00",
|
||||
"pickupaddress": "Shop 4, Central Plaza, Melbourne",
|
||||
"pickuplat": "-37.8136",
|
||||
"pickuplong": "144.9631",
|
||||
"pickupcustomer": "Central Plaza Merchant",
|
||||
"pickupcontactno": "399887766",
|
||||
"deliveryaddress": "Apt 4B, Sunset Boulevard, Richmond",
|
||||
"deliverylat": "-37.8212",
|
||||
"deliverylong": "144.9984",
|
||||
"orderamount": 11.48,
|
||||
"taxamount": 1.10,
|
||||
"ordervalue": 12.58,
|
||||
"itemcount": 2,
|
||||
"paymenttype": 1,
|
||||
"paymentstatus": 0,
|
||||
"deliverycharge": 3.00,
|
||||
"ordernotes": "Please ring doorbell twice.",
|
||||
"items": [
|
||||
{
|
||||
"productid": 105,
|
||||
"productname": "Organic Whole Milk 1L",
|
||||
"orderqty": 2,
|
||||
"price": 3.99,
|
||||
"taxpercentage": 10.00,
|
||||
"taxamount": 0.80,
|
||||
"productsumprice": 7.98
|
||||
},
|
||||
{
|
||||
"productid": 109,
|
||||
"productname": "Salted Butter 250g",
|
||||
"orderqty": 1,
|
||||
"price": 3.50,
|
||||
"taxpercentage": 10.00,
|
||||
"taxamount": 0.35,
|
||||
"productsumprice": 3.50
|
||||
}
|
||||
]
|
||||
}
|
||||
PUT Update Order Status & Financial Flag
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/orders/updateorder
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"orderheaderid": 2099,
|
||||
"orderstatus": "ready",
|
||||
"paymentstatus": 1,
|
||||
"remarks": "Order packed and waiting for rider assignment."
|
||||
}
|
||||
📱 Mobile App
|
||||
POST Create Mobile Order (Wrapped JSON Format)
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/orders/createorder
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"orders": {
|
||||
"tenantid": 8,
|
||||
"locationid": 2,
|
||||
"applocationid": 1,
|
||||
"moduleid": 1,
|
||||
"customerid": 4082,
|
||||
"orderstatus": "pending",
|
||||
"deliverytype": "standard",
|
||||
"deliverytime": "2026-05-20 18:00:00",
|
||||
"pickupaddress": "Shop 4, Central Plaza, Melbourne",
|
||||
"pickuplat": "-37.8136",
|
||||
"pickuplong": "144.9631",
|
||||
"pickupcustomer": "Central Plaza Merchant",
|
||||
"pickupcontactno": "399887766",
|
||||
"deliveryaddress": "Apt 4B, Sunset Boulevard, Richmond",
|
||||
"deliverylat": "-37.8212",
|
||||
"deliverylong": "144.9984",
|
||||
"orderamount": 11.48,
|
||||
"taxamount": 1.10,
|
||||
"ordervalue": 12.58,
|
||||
"itemcount": 2,
|
||||
"paymenttype": 1,
|
||||
"paymentstatus": 0,
|
||||
"deliverycharge": 3.00,
|
||||
"ordernotes": "Leave in parcel locker.",
|
||||
"items": [
|
||||
{
|
||||
"productid": 105,
|
||||
"productname": "Organic Whole Milk 1L",
|
||||
"orderqty": 2,
|
||||
"price": 3.99,
|
||||
"taxpercentage": 10.00,
|
||||
"taxamount": 0.80,
|
||||
"productsumprice": 7.98
|
||||
},
|
||||
{
|
||||
"productid": 109,
|
||||
"productname": "Salted Butter 250g",
|
||||
"orderqty": 1,
|
||||
"price": 3.50,
|
||||
"taxpercentage": 10.00,
|
||||
"taxamount": 0.35,
|
||||
"productsumprice": 3.50
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
PUT Mobile Update Order Status
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/orders/updateorder
|
||||
Payload: (Uses the same schema as Web Update Order Status & Financial Flag)
|
||||
5. Delivery & Rider Logistics APIs
|
||||
💻 Web Portal
|
||||
POST Initialize Logistics Delivery Dispatch (Assign Rider)
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/deliveries/createdeliveries
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
[
|
||||
{
|
||||
"orderheaderid": 2100,
|
||||
"applocationid": 1,
|
||||
"partnerid": 1,
|
||||
"tenantid": 8,
|
||||
"moduleid": 1,
|
||||
"locationid": 2,
|
||||
"userid": 15,
|
||||
"orderid": "ORD-19028-4",
|
||||
"deliverydate": "2026-05-20",
|
||||
"orderstatus": "assigned",
|
||||
"assigntime": "2026-05-20 12:10:00",
|
||||
"itemcount": 2,
|
||||
"orderamount": 12.58,
|
||||
"customerid": 4082,
|
||||
"pickupcustomer": "Central Merchant Warehouse",
|
||||
"pickupcontactno": "987654321",
|
||||
"pickuplocationid": 2,
|
||||
"pickupaddress": "Shop 4, Central Plaza, Melbourne",
|
||||
"pickuplat": "-37.8136",
|
||||
"pickuplon": "144.9631",
|
||||
"deliverycustomerid": 4082,
|
||||
"deliverylocationid": 554,
|
||||
"deliverycustomer": "Jane Smith",
|
||||
"deliverycontactno": "499888777",
|
||||
"deliveryaddress": "456 Oak Avenue, Richmond, VIC, 3121",
|
||||
"droplat": "-37.8212",
|
||||
"droplon": "144.9984",
|
||||
"deliverycharges": 3.00,
|
||||
"deliveryamt": 15.58,
|
||||
"deliverytype": "standard",
|
||||
"paymenttype": 1
|
||||
}
|
||||
]
|
||||
PUT Update Rider Pickup Status
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/deliveries/updatedelivery
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"deliveryid": 8871,
|
||||
"orderheaderid": 2100,
|
||||
"userid": 15,
|
||||
"orderstatus": "picked",
|
||||
"pickuptime": "2026-05-20 12:20:00",
|
||||
"riderslat": "-37.8140",
|
||||
"riderslon": "144.9640"
|
||||
}
|
||||
📱 Mobile App
|
||||
POST Initialize Mobile Logistics Delivery
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/deliveries/createdeliveries
|
||||
Payload: (Uses the same schema as Web Initialize Logistics Delivery Dispatch)
|
||||
PUT Rider Update Dispatch Status (Delivered & GPS Tracking)
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/deliveries/updatedelivery
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"deliveryid": 8871,
|
||||
"orderheaderid": 2100,
|
||||
"userid": 15,
|
||||
"orderstatus": "delivered",
|
||||
"deliverytime": "2026-05-20 12:45:00",
|
||||
"riderslat": "-37.8210",
|
||||
"riderslon": "144.9980",
|
||||
"actualkms": "4.2",
|
||||
"feedback": "Handed over safely.",
|
||||
"smsdelivery": 1
|
||||
}
|
||||
6. Tenant & Location Configuration APIs
|
||||
💻 Web Portal
|
||||
POST Link Customer Profile to Tenant Store
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/tenants/createtenantcustomer
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"moduleid": 1,
|
||||
"tenantid": 8,
|
||||
"locationid": 2,
|
||||
"customerid": 4082,
|
||||
"customerlocationid": 554,
|
||||
"status": 1
|
||||
}
|
||||
POST Create New Geofenced Store Location
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/tenants/createlocation
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"tenantid": 8,
|
||||
"applocationid": 1,
|
||||
"moduleid": 1,
|
||||
"locationname": "Hawthorn Daily Fresh Store",
|
||||
"email": "hawthorn.store@merchant.com",
|
||||
"contactno": "399443322",
|
||||
"latitude": "-37.8222",
|
||||
"longitude": "145.0384",
|
||||
"address": "12 Glenferrie Rd",
|
||||
"suburb": "Hawthorn",
|
||||
"city": "Melbourne",
|
||||
"state": "VIC",
|
||||
"postcode": "3122",
|
||||
"opentime": "07:00:00",
|
||||
"closetime": "22:00:00",
|
||||
"partnerid": 1,
|
||||
"deliveryradius": 5000,
|
||||
"deliverymins": 30,
|
||||
"cancelsecs": 60,
|
||||
"status": "Active"
|
||||
}
|
||||
POST Map Tenant Location Linkage Entry
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/tenants/createtenantlocation
|
||||
Payload: (Uses the same schema as Create New Geofenced Store Location)
|
||||
PUT Update Store Location Configurations
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/tenants/updatelocation
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"locationid": 2,
|
||||
"tenantid": 8,
|
||||
"applocationid": 1,
|
||||
"locationname": "Richmond Daily Fresh Store",
|
||||
"email": "richmond.store@merchant.com",
|
||||
"contactno": "399887766",
|
||||
"latitude": "-37.8212",
|
||||
"longitude": "144.9984",
|
||||
"address": "Shop 4, 100 Church St",
|
||||
"suburb": "Richmond",
|
||||
"city": "Melbourne",
|
||||
"state": "VIC",
|
||||
"postcode": "3121",
|
||||
"opentime": "07:00:00",
|
||||
"closetime": "22:00:00",
|
||||
"deliveryradius": 8000,
|
||||
"deliverymins": 45,
|
||||
"cancelsecs": 120,
|
||||
"status": "Active"
|
||||
}
|
||||
PUT Modify Tenant Location Linkage Config
|
||||
URL: https://fiesta.nearle.app/live/api/v1/web/tenants/updatetenantlocation
|
||||
Payload: (Uses the same schema as Update Store Location Configurations)
|
||||
📱 Mobile App
|
||||
POST Mobile Link Customer Profile to Tenant Store
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/tenants/createtenantcustomer
|
||||
Payload: (Uses the same schema as Web Link Customer Profile to Tenant Store)
|
||||
POST Mobile Create Geofenced Store Location
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/tenants/createlocation
|
||||
Payload: (Uses the same schema as Web Create New Geofenced Store Location)
|
||||
POST Onboard/Create New Staff Member Account
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/tenants/createstaff
|
||||
Payload: (Uses the same schema as Web Register New Web Staff Account)
|
||||
POST Onboard New Tenant & Admin Profile (Joint Creation)
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/tenants/createtenantuser
|
||||
Payload:
|
||||
json
|
||||
|
||||
|
||||
{
|
||||
"tenantname": "Fresh Organic Greens",
|
||||
"configid": 1,
|
||||
"partnerid": 1,
|
||||
"moduleid": 1,
|
||||
"tenanttype": "Enterprise",
|
||||
"registrationno": "ABN-19028-299",
|
||||
"tenanttoken": "tenant_fcm_token_hash_value_xyz",
|
||||
"companyname": "Fresh Organic Greens Pty Ltd",
|
||||
"devicetype": "web",
|
||||
"firstname": "Arthur",
|
||||
"primaryemail": "arthur@organicgreens.com",
|
||||
"primarycontact": "488999000",
|
||||
"categoryid": 2,
|
||||
"subcategoryid": 12,
|
||||
"address": "400 Chapel St",
|
||||
"suburb": "South Yarra",
|
||||
"city": "Melbourne",
|
||||
"state": "VIC",
|
||||
"postcode": "3141",
|
||||
"latitude": "-37.8398",
|
||||
"longitude": "144.9953",
|
||||
"tenantimage": "https://storage.nearle.app/tenants/organic_greens.png",
|
||||
"tenantinfo": "Direct farm-to-table organic vegetables delivery provider.",
|
||||
"paymode1": 1,
|
||||
"paymode2": 1,
|
||||
"promotion": 0,
|
||||
"minorder": 15,
|
||||
"applocationid": 1,
|
||||
"approved": 1,
|
||||
"status": "Active",
|
||||
"tenantlocations": {
|
||||
"locationname": "South Yarra Main Warehouse",
|
||||
"email": "southyarra@organicgreens.com",
|
||||
"contactno": "488999000",
|
||||
"latitude": "-37.8398",
|
||||
"longitude": "144.9953",
|
||||
"address": "400 Chapel St",
|
||||
"suburb": "South Yarra",
|
||||
"city": "Melbourne",
|
||||
"state": "VIC",
|
||||
"postcode": "3141",
|
||||
"opentime": "06:00:00",
|
||||
"closetime": "21:00:00",
|
||||
"partnerid": 1,
|
||||
"deliveryradius": 6000,
|
||||
"deliverymins": 30,
|
||||
"cancelsecs": 90,
|
||||
"status": "Active"
|
||||
}
|
||||
}
|
||||
PUT Mobile Update Store Location Configurations
|
||||
URL: https://fiesta.nearle.app/live/api/v1/mob/tenants/updatelocation
|
||||
Payload: (Uses the same schema as Web Update Store Location Configurations)
|
||||
450
Xpress_api_get_docs.md
Normal file
450
Xpress_api_get_docs.md
Normal file
@@ -0,0 +1,450 @@
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v1/users/getallusers?roleid=2&tenantid=8&pageno=1&pagesize=10&keyword=john
|
||||
|
||||
# Get all users (V2)
|
||||
https://jupiter.nearle.app/live/api/v2/users/getallusers?roleid=2&tenantid=8&pageno=1&pagesize=10&keyword=john
|
||||
|
||||
---
|
||||
|
||||
## 👥 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)
|
||||
https://jupiter.nearle.app/live/api/v1/customers/getcustomerrequests?customerid=4082&pageno=1&pagesize=10
|
||||
|
||||
---
|
||||
|
||||
## 📦 Products & Catalog GET APIs
|
||||
http
|
||||
|
||||
# Retrieve all registered products with extensive filters
|
||||
https://jupiter.nearle.app/live/api/v1/products/getallproducts?categoryid=4&subcategoryid=14&productid=101&applocationid=5&tenantid=8&locationid=45&keyword=strawberry&productstatus=available&approve=approved&pageno=1&pagesize=10
|
||||
|
||||
# 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
|
||||
https://jupiter.nearle.app/live/api/v1/products/getproductsbysubcategory?categoryid=4&tenantid=8&applocationid=5&locationid=45&keyword=berry
|
||||
|
||||
# Retrieve product counts categorized by tenant and subcategory
|
||||
https://jupiter.nearle.app/live/api/v1/products/getproductscount?tenantid=8&categoryid=4&subcategoryid=14&approve=approved
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v2/products/getcatalougeproducts?tenantid=8&locationid=45&subcategoryid=14&keyword=apple&pageno=1&pagesize=10
|
||||
|
||||
# Retrieve products mapped to a physical location (V2)
|
||||
https://jupiter.nearle.app/live/api/v2/products/getlocationproducts?tenantid=8&locationid=45&subcategoryid=14&keyword=apple&pageno=1&pagesize=10
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v2/products/getstockstatement?tenantid=8&locationid=45&subcategoryid=14&keyword=apple&pageno=1&pagesize=10
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v2/products/getproductcategorywisesummary?tenantid=8&locationid=45&subcategoryid=14
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v1/orders/getorders?fromdate=2026-05-01&todate=2026-05-20&status=pending&keyword=sydney&roleid=2&tenantid=8&locationid=45&pageno=1&pagesize=10
|
||||
|
||||
# Query partner dispatch tasks (V1)
|
||||
https://jupiter.nearle.app/live/api/v1/orders/partner/getorders?partnerid=102&status=pending&pageno=1&pagesize=10
|
||||
|
||||
# Query tenant physical store orders (V1)
|
||||
https://jupiter.nearle.app/live/api/v1/orders/tenant/getorders?tenantid=8&locationid=45&pageno=1&pagesize=10
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v1/orders/getordersummary?tenantid=8&locationid=45&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v2/orders/getorders?fromdate=2026-05-01&todate=2026-05-20&status=pending&tenantid=8&locationid=45&pageno=1&pagesize=10
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v2/orders/getordersummary?tenantid=8&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v3/orders/getcustomerorders?customerid=12&tenantid=8&orderstatus=delivered&pageno=1&pagesize=10
|
||||
|
||||
---
|
||||
|
||||
## 🚚 Deliveries & Dispatch GET APIs
|
||||
http
|
||||
|
||||
# Query parameterized deliveries list with search keyword (V2)
|
||||
https://jupiter.nearle.app/live/api/v2/deliveries/getdeliveries?tenantid=8&locationid=45&partnerid=102&userid=12&status=pending&fromdate=2026-05-01&todate=2026-05-20&keyword=sydney&pageno=1&pagesize=10
|
||||
|
||||
# Query parameterized deliveries list with search keyword (V3)
|
||||
https://jupiter.nearle.app/live/api/v3/deliveries/getdeliveries?tenantid=8&locationid=45&partnerid=102&userid=12&status=pending&fromdate=2026-05-01&todate=2026-05-20&keyword=sydney&pageno=1&pagesize=10
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v1/deliveries/deliverysummary?tenantid=8&locationid=45&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v1/deliveries/getreportsummary?tenantid=8&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# Get report summaries grouped by tenant store location (V1)
|
||||
https://jupiter.nearle.app/live/api/v1/deliveries/getreportlocationsummary?tenantid=8&locationid=45&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# Query report stats per Rider per tenant store location (V1)
|
||||
https://jupiter.nearle.app/live/api/v1/deliveries/getriderlocationreportsummary?tenantid=8&userid=12&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# Retrieve active riders shift and duty metric summaries (V1)
|
||||
https://jupiter.nearle.app/live/api/v1/deliveries/getridersummary?tenantid=8&locationid=45&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# Retrieve Rider metrics summary grouped by store location (V1)
|
||||
https://jupiter.nearle.app/live/api/v1/deliveries/getriderlocationsummary?tenantid=8&locationid=45&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v1/deliveries/getuserreportsummary?userid=12&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# Query raw logs of rider activity (V1)
|
||||
https://jupiter.nearle.app/live/api/v1/deliveries/getuserdeliverylogs?userid=12&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
---
|
||||
|
||||
## 🧾 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
|
||||
https://jupiter.nearle.app/live/api/v1/invoice/getallinvoice?tenantid=8&customerid=12&status=Unpaid&pageno=1&pagesize=10
|
||||
|
||||
# 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
|
||||
https://jupiter.nearle.app/live/api/v1/utils/getapppricing?applocationid=5&configid=6&pricingtypeid=1
|
||||
|
||||
# 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
|
||||
https://jupiter.nearle.app/live/api/v1/partners/getridercount?partnerid=102&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# 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)
|
||||
https://jupiter.nearle.app/live/api/v1/partners/getriderlogs?partnerid=102&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# Query rider cumulative login logs (V2)
|
||||
https://jupiter.nearle.app/live/api/v2/partners/getriderlogs?partnerid=102&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# Get weekly cumulative kilometers traveled by rider
|
||||
https://jupiter.nearle.app/live/api/v1/partners/getriderweeklykms?userid=12&fromdate=2026-05-01&todate=2026-05-20
|
||||
|
||||
# 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
|
||||
1081
Xpress_api_write_docs.md
Normal file
1081
Xpress_api_write_docs.md
Normal file
File diff suppressed because it is too large
Load Diff
@@ -5,7 +5,7 @@
|
||||
<meta charset="UTF-8" />
|
||||
<link rel="icon" type="image/png" href="/favicon.png" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Nearle Express Developer Docs</title>
|
||||
<title>NearleXpress Developer Docs</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
@@ -26,7 +26,7 @@ export default function Introduction({ allLegacy, allRest, setActiveTopic }) {
|
||||
</div>
|
||||
|
||||
<h1 className="text-4xl lg:text-5xl font-bold text-slate-900 mb-6 tracking-tight">
|
||||
<span className="text-gradient">Nearle Express API</span>
|
||||
<span className="text-gradient">NearleXpress API</span>
|
||||
</h1>
|
||||
|
||||
<p className="text-xl text-slate-600 mb-12 max-w-2xl leading-relaxed">
|
||||
|
||||
@@ -52,7 +52,7 @@ export default function Sidebar({ legacyTopics, restTopics, activeTopic, setActi
|
||||
<div className="w-8 h-8 rounded-lg bg-gradient-to-br from-brand-500 to-indigo-600 flex items-center justify-center shadow-glow">
|
||||
<Layers className="text-white w-4 h-4" />
|
||||
</div>
|
||||
<span className="tracking-tight">Nearle Express</span>
|
||||
<span className="tracking-tight">NearleXpress</span>
|
||||
</div>
|
||||
<div className="relative group">
|
||||
<Search className="w-4 h-4 absolute left-3 top-3 text-slate-400 group-focus-within:text-brand-500 transition-colors" />
|
||||
|
||||
3180
src/data/topics.js
3180
src/data/topics.js
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user