API v2.1

Developer Hub

Build powerful logistics applications with our REST API. Integrate shipping, tracking, and fulfillment directly into your e-commerce platform, ERP, or custom applications.

API Authentication

All API requests require authentication using Bearer tokens. Generate your API keys from the Developer Dashboard.

cURL
curl -X GET \
  "https://api.velocityultra.co.za/v2/shipments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Getting API Keys

Sign up for a developer account and generate your keys:

Endpoint Method Description
/v2/auth/register POST Register for developer access
/v2/auth/login POST Authenticate and get token
/v2/auth/keys GET List your API keys
/v2/auth/keys/create POST Create new API key

Tracking API

Track shipments in real-time with our comprehensive tracking API. Get location updates, status changes, and estimated delivery times.

JavaScript
const trackShipment = async (trackingNumber) => {
  const response = await fetch(
    `https://api.velocityultra.co.za/v2/track/${trackingNumber}`,
    {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
      }
    }
  );
  
  const data = await response.json();
  return data;
};

Tracking Endpoints

Endpoint Method Description
/v2/track/{tracking_number} GET Get tracking details for a shipment
/v2/track/batch POST Track multiple shipments in one request
/v2/track/events GET Get recent tracking events
/v2/track/live/{tracking_number} GET WebSocket for real-time updates

Tracking Status Codes

label_created
Shipping label created
picked_up
Package collected
in_transit
Package in transit
out_for_delivery
Out for delivery
delivered
Successfully delivered
exception
Delivery exception

Shipping API

Create shipments, get real-time quotes, schedule pickups, and manage your logistics programmatically.

Python
import requests

# Create a shipment
url = "https://api.velocityultra.co.za/v2/shipments"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
    "service": "express_ultra",
    "pickup": {
        "name": "John Doe",
        "address": "123 Main St, Johannesburg",
        "phone": "+27111234567"
    },
    "delivery": {
        "name": "Jane Smith",
        "address": "456 Oak Ave, Cape Town",
        "phone": "+27111234568"
    },
    "package": {
        "weight": 2.5,
        "dimensions": "30x20x10",
        "description": "Important documents"
    }
}

response = requests.post(url, json=data, headers=headers)
shipment = response.json()

Webhooks

Receive real-time notifications about shipment events. Configure webhooks to integrate with your systems.

Node.js
const express = require('express');
const app = express();

app.post('/webhooks/shipment', async (req, res) => {
  const event = req.body;
  
  // Verify webhook signature
  const signature = req.headers['velocity-signature'];
  const isValid = verifySignature(signature, event);
  
  if (!isValid) {
    return res.status(400).send('Invalid signature');
  }
  
  // Handle different event types
  switch (event.type) {
    case 'shipment.created':
      console.log('New shipment:', event.data);
      break;
    case 'shipment.delivered':
      console.log('Shipment delivered:', event.data);
      break;
    case 'tracking.updated':
      console.log('Tracking update:', event.data);
      break;
  }
  
  res.status(200).send('OK');
});

Rate Limits

API rate limits ensure fair usage and system stability. All limits are per API key.

Plan Requests/Minute Requests/Day Webhooks
Developer 60 5,000 5 endpoints
Startup 300 50,000 20 endpoints
Business 1,000 200,000 100 endpoints
Enterprise 10,000+ Unlimited Unlimited

Official SDKs

Get started quickly with our officially supported SDKs for popular programming languages.

🐍
Python SDK

A comprehensive Python client for the Velocity Ultra API with async support and type hints.

🟨
JavaScript/Node.js

Node.js and browser-compatible SDK with Promise-based API and TypeScript definitions.

Java SDK

Enterprise-grade Java client with Spring Boot integration and comprehensive error handling.

Need Help?

Our developer support team is here to help you integrate successfully.

📚

Documentation

Complete API reference with examples

💬

Community

Join our developer community forum

📧

Email Support

[email protected]

🛠️

Integration Help

Schedule a 1:1 integration session

Contact Developer Support →