REST API Reference
Complete reference for the Velourcity REST API. Create orders, track deliveries, manage payments, and more.
All API requests require authentication using your API key.
Include your API key in the Authorization header of all requests:
Authorization: Bearer YOUR_API_KEYYou can obtain your API key by signing up for developer access.
API Endpoints
Create a new delivery order
POST /ordersRequest Body
TODO: Add JSON request body example for creating orders
Response (201 Created)
TODO: Add JSON response example for creating orders
Retrieve order details
GET /orders/order_idResponse (200 OK)
TODO: Add JSON response example for getting order details
Cancel an existing order
DELETE /orders/order_idOrders can only be cancelled before driver pickup. Cancellation fees may apply.
Get real-time driver location
GET /orders/order_id/locationResponse (200 OK)
TODO: Add JSON response example for live location data
Get list of available drivers in an area
GET /drivers/available?lat=40.7128&lng=-74.0060&radius=5Query Parameters
lat- Latitude coordinatelng- Longitude coordinateradius- Search radius in kilometers (default: 5)
Process payment for an order
POST /orders/order_id/paymentRequest Body
TODO: Add JSON request body example for payment processing
Possible status values for delivery orders
Standard error response format and common error codes
Error Response Format
TODO: Add JSON error response example
Common Error Codes
invalid_request - 400 Bad Requestunauthorized - 401 Unauthorizedpayment_required - 402 Payment Requiredforbidden - 403 Forbiddennot_found - 404 Not Found