Skip to main content

API Endpoints

Authentication Endpoints

MethodEndpointAuthDescription
POST/api/auth/signupNoneRegister new user
POST/api/auth/signinNoneLogin and get JWT token
GET/api/auth/profileJWTGet user profile
GET/api/auth/agentsJWTList all agents

Waybill Endpoints

MethodEndpointAuthDescription
POST/api/waybill/createJWTCreate new waybill
GET/api/waybill/:idJWTGet waybill details
PUT/api/waybill/:idJWTUpdate waybill
DELETE/api/waybill/:idJWTCancel waybill
GET/api/waybill/track/:awbJWTTrack waybill by AWB
POST/api/waybill/bulkJWTBulk waybill creation
GET/api/waybill/view-img/:idJWTView waybill image

Check Fee Endpoints

MethodEndpointAuthDescription
POST/api/check-feeJWTCalculate shipping fee
POST/api/check-fee/bulkJWTBulk fee calculation
GET/api/check-fee/servicesJWTGet available services

Scanning Endpoints

Outgoing Scans:

MethodEndpointAuthDescription
POST/api/scan/packingJWTRecord packing scan
POST/api/scan/handoverJWTRecord handover scan
GET/api/scan/handover/:idJWTGet handover details

Incoming Scans:

MethodEndpointAuthDescription
POST/api/scan/receivingJWTRecord receiving scan
POST/api/scan/deliveryJWTRecord delivery scan
POST/api/scan/problemJWTRecord problem scan
GET/api/scan/delivery/:idJWTGet delivery details

Courier Partner Endpoints

MethodEndpointAuthDescription
GET/api/partnersJWTList all partners
GET/api/partners/:idJWTGet partner details
POST/api/partnersJWTAdd new partner
PUT/api/partners/:idJWTUpdate partner
DELETE/api/partners/:idJWTRemove partner

3rd-Party Integration Endpoints

MethodEndpointAuthDescription
POST/api/3p/jne/webhookBasicJNE status webhook
POST/api/3p/lionparcel/webhookBasicLion Parcel webhook
POST/api/3p/jtcargo/webhookBasicJT Cargo webhook
POST/api/3p/anteraja/webhookBasicAnteRaja webhook
POST/api/3p/sicepat/webhookBasicSicepat webhook

Reports Endpoints

MethodEndpointAuthDescription
GET/api/reports/monitoring-pickupJWTPickup monitoring report
GET/api/reports/monitoring-deliveryJWTDelivery monitoring report
GET/api/reports/manifestJWTManifest report
GET/api/reports/slaJWTSLA performance report
GET/api/reports/billingJWTBilling report
GET/api/reports/billing-vipJWTVIP billing report
GET/api/reports/commissionJWTCommission report
GET/api/reports/financeJWTFinance report
GET/api/reports/courier-performanceJWTCourier performance

Quality Management Endpoints

MethodEndpointAuthDescription
POST/api/qm/alter-weightJWTRecord weight alteration
POST/api/qm/podJWTUpload proof of delivery
POST/api/qm/popJWTUpload proof of pickup
GET/api/qm/pod/:awbJWTGet POD for waybill
GET/api/qm/pop/:awbJWTGet POP for waybill

Driver App Endpoints

MethodEndpointAuthDescription
GET/api/driver/tasksJWTGet assigned tasks
POST/api/driver/pickupJWTComplete pickup
POST/api/driver/deliveryJWTComplete delivery
GET/api/driver/marketplace/ordersJWTGet marketplace orders

Marketplace Endpoints

MethodEndpointAuthDescription
POST/api/marketplace/pickupJWTRecord marketplace pickup
POST/api/marketplace/receivingJWTRecord marketplace receiving
GET/api/marketplace/ordersJWTGet marketplace orders

Administration Endpoints

MethodEndpointAuthDescription
GET/api/admin/usersJWTList users
POST/api/admin/usersJWTCreate user
PUT/api/admin/users/:idJWTUpdate user
DELETE/api/admin/users/:idJWTDelete user
GET/api/admin/customersJWTList customers
POST/api/admin/feed-infoJWTPost system notification

Finance Endpoints

MethodEndpointAuthDescription
GET/api/finance/billing-vipJWTGet VIP billing configs
POST/api/finance/billing-vipJWTCreate VIP billing config
PUT/api/finance/billing-vip/:idJWTUpdate VIP billing config

File Download

MethodEndpointAuthDescription
GET/api/file/download/:filenameNoneDownload generated file

Note: File is automatically deleted after download.