Developer Documentation

API endpoints for tracking, intake, and operations workflows.

Veridock APIs power shipment tracking, correction submission, customer portal features, and admin operations tooling.

Developer workstation

Base URLs

Endpoints relative to the same host as the web app.

API prefix: /api

Health: GET /api/health

Config: GET /api/config

Public Endpoints

Tracking and intake APIs.

Shipment Data

GET /api/shipments/:id

GET /api/shipments/:id/events

GET /api/shipments/:id/exceptions

Receiver Confirmation

POST /api/shipments/:id/view

POST /api/shipments/:id/confirm

GET /api/shipments/:id/confirmation

Corrections

POST /api/corrections

GET /api/shipments/:id/correction-status

Commercial Intake

POST /api/rates/estimate

POST /api/pickups

POST /api/pet-intake

Authentication APIs

Admin and client portal sessions.

Admin

  • POST /api/admin/login
  • GET /api/admin/session
  • POST /api/admin/logout

Customer Portal

  • POST /api/customer/login
  • GET /api/customer/session
  • POST /api/customer/logout

Customer Dashboard

  • GET /api/customer/dashboard
  • POST /api/customer/saved-shipments
  • POST /api/customer/notification-prefs

Admin Operations

Role-protected operational APIs.

Shipments: GET/POST /api/admin/shipments, GET/PUT /api/admin/shipments/:id, POST /api/admin/shipments/:id/pod

Corrections: GET /api/admin/corrections, POST /api/admin/corrections/:requestId/review

Exceptions: GET/POST /api/admin/exceptions, POST /api/admin/exceptions/:id/resolve

Notifications: GET /api/admin/notifications, POST /api/admin/notifications/trigger

Queues: GET /api/admin/pickups, GET /api/admin/pet-intake

Superadmin: GET/POST /api/admin/users, POST /api/admin/users/:username/toggle-active, GET /api/admin/audit-logs

Sample Call

Fetch a shipment record.

curl -s http://localhost:4174/api/shipments/AFR-884291