Dashboard Carriers Tracking API Docs

API Documentation

The River Point Works API provides a unified interface for tracking shipments across multiple carriers in the Americas. All endpoints return JSON and require authentication via API key.

Authentication

All API requests require an API key passed in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Contact our team to obtain an API key for your organization.

Tracking

Submit a tracking request to retrieve shipment status and events.

POST /api/v1/track

Request

{
  "carrier": "ups",
  "tracking_number": "1Z999AA10123456784",
  "reference": "ORDER-12345"
}

Response

{
  "tracking_number": "1Z999AA10123456784",
  "carrier": "UPS",
  "status": "in_transit",
  "status_label": "In Transit",
  "origin": "Dallas, TX",
  "destination": "Monterrey, MX",
  "estimated_delivery": "2025-01-18T14:00:00Z",
  "events": [
    {
      "timestamp": "2025-01-15T14:30:00Z",
      "status": "picked_up",
      "description": "Shipment picked up",
      "location": "Dallas, TX"
    },
    {
      "timestamp": "2025-01-16T06:20:00Z",
      "status": "in_transit",
      "description": "Crossed border",
      "location": "Nuevo Laredo, MX"
    }
  ]
}

Get Track Result

GET /api/v1/track/:tracking_number

Retrieve the current tracking result for a previously submitted tracking number.

Carriers

List all supported carriers and their configuration.

GET /api/v1/carriers 
{
  "carriers": [
    {
      "code": "ups",
      "name": "UPS",
      "region": "US",
      "type": "express",
      "active": true
    },
    {
      "code": "estafeta",
      "name": "Estafeta",
      "region": "MX",
      "type": "ground",
      "active": true
    },
    {
      "code": "correios",
      "name": "Correios",
      "region": "BR",
      "type": "postal",
      "active": true
    }
  ]
}

Carrier Detail

GET /api/v1/carriers/:carrier_code

Get detailed information about a specific carrier including supported services and coverage areas.

Webhooks

Configure webhook endpoints to receive real-time tracking event notifications.

POST /api/v1/webhooks 
{
  "url": "https://your-domain.com/webhooks/rpw",
  "events": ["tracking.updated", "tracking.delivered"],
  "secret": "whsec_your_webhook_secret"
}

Webhook Events

The following event types are available for webhook subscriptions:

Error Codes

The API uses standard HTTP status codes and returns error details in the response body.

{
  "error": {
    "code": "invalid_tracking_number",
    "message": "The provided tracking number is invalid",
    "status": 400
  }
}

Common error codes: