Getting Started

Copy page

RAVENT API Documentation

Welcome to RAVENT, the AI-powered Order Management System and fulfillment platform. This comprehensive API reference covers all the endpoints needed to integrate RAVENT's powerful operations optimization capabilities into your service delivery workflows.

What is RAVENT?

RAVENT transforms unstructured data from multiple channels (WhatsApp, email, PDFs, Excel, audio/video) into structured, actionable information that triggers automated workflows. The platform serves multiple verticals including:

• Food & Beverage / Farm to Table: Order processing, inventory management, last-mile delivery
• Healthcare: Lab pre-analytics, cold chain management, temperature monitoring
• Last Mile Logistics: Route optimization, real-time tracking, delivery coordination
• Transportation & Ferries: Fleet management, passenger tracking, event-based workflows
• Retail & Entertainment: Order fulfillment, event management, customer engagement

Key Features

Multi-Channel Order Processing

Accept orders through any channel:

• WhatsApp Business API
• Email ingestion
• PDF & Excel uploads
• Audio/Video messages
• Web forms
• Third-party integrations

Real-Time Operations Management

• GPS tracking with temperature monitoring (for cold chain)
• Live delivery status updates
• Geo-fencing and location-based triggers
• Driver/operator state management (on route, picked up, traveling, dropped off)

Intelligent Workflow Automation

• Visual workflow editor with drag-and-drop interface
• Conditional logic and branching
• Native integrations with 30+ platforms
• Custom webhook support
• Scheduled and event-triggered workflows

Payment & Invoicing

• Multiple payment methods (card, bank transfer, cash, payment links)
• Automated invoice generation
• Receipt printing via Zebra printers
• Payment reconciliation
• Mobile payment terminals

Digital Passes & Ticketing

• Automatic pass generation and distribution
• Integration with Apple Wallet and Google Wallet
• QR code POD (Proof of Delivery)
• Pass revocation and expiration management

Platform Architecture

RAVENT is built on a microservices architecture with the following core services:

Code
 
┌─────────────────────────────────────────────────────┐
│                    Fulfillment Platform              │
├─────────────────────────────────────────────────────┤
│  Orders API │ Users API │ Organizations API │ ...    │
├─────────────────────────────────────────────────────┤
│  Payments │ Messaging │ Integrations │ Ticketing    │
├─────────────────────────────────────────────────────┤
│  Workflows │ Analytics │ Notifications │ Reports    │
└─────────────────────────────────────────────────────┘

Quick Start

Authentication

RAVENT supports three authentication methods:

1. JWT (JSON Web Tokens) - For authenticated users and service-to-service communication

Code
 
const headers = {
  'Authorization': 'Bearer YOUR_JWT_TOKEN',
  'Content-Type': 'application/json'
};

2. API Keys - For integrations and third-party services

Code
 
const headers = {
  'X-API-Key': 'your_api_key',
  'Content-Type': 'application/json'
};

3. Public Tokens - For anonymous operations (limited scope)

Code
 
const headers = {
  'Authorization': 'Bearer PUBLIC_TOKEN',
  'Content-Type': 'application/json'
};

Your First Request

Create an order with a single API call:

Code
 
curl -X POST https://api.ravent.com/v1/orders \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "organizationId": "org_123",
    "externalId": "ORDER-20250101-001",
    "customer": {
      "name": "John Doe",
      "phone": "+1234567890",
      "email": "john@example.com"
    },
    "items": [
      {
        "sku": "ITEM-001",
        "quantity": 2,
        "price": 29.99
      }
    ],
    "deliveryLocation": {
      "latitude": 20.6596,
      "longitude": -87.0739,
      "address": "123 Main St, Cancun"
    },
    "deliveryWindow": {
      "start": "2025-01-15T09:00:00Z",
      "end": "2025-01-15T17:00:00Z"
    }
  }'

Response:

Code
 
{
  "id": "order_abc123def456",
  "externalId": "ORDER-20250101-001",
  "status": "created",
  "createdAt": "2025-01-15T08:30:00Z",
  "links": {
    "self": "/v1/orders/order_abc123def456",
    "track": "https://track.ravent.com/order_abc123def456"
  }
}

API Overview

Core APIs (10 Services, 393 Endpoints)

Service	Endpoints	Primary Functions
Orders API	185	Order management, tracking, fulfillment, analytics
Organizations API	78	Business structure, locations, teams, assets
Users API	44	User management, authentication, location tracking
Payments API	13	Payment processing, invoicing, receipts
Messaging API	21	Multi-channel notifications (WhatsApp, SMS, email)
Integrations API	23	Third-party platform connections (SAP, ODOO, Slack)
Ticketing API	8	Digital pass generation and management
FOPS API	8	Fulfillment operations and workflows
OTTS API	9	OTT platform operations and management
Actions API	4	Workflow triggers and automation

Common Integration Patterns

Pattern 1: Order Intake & Routing

Code
 
WhatsApp/Email Input 
    ↓
Order Creation (Orders API)
    ↓
Task Assignment (Users API)
    ↓
Route Optimization (FOPS API)
    ↓
Notifications (Messaging API)
    ↓
Customer Tracking Link

Pattern 2: Payment Collection & Reconciliation

Code
 
Order Delivery
    ↓
Payment Request (Payments API)
    ↓
Multiple Payment Methods
    ↓
Receipt Generation
    ↓
Automatic Reconciliation (Integrations API)
    ↓
CRM Update (via Workflows)

Pattern 3: Multi-Step Workflows

RAVENT's workflow engine enables complex operational sequences:

Code
 
Event Trigger
    ↓
Conditional Logic
    ├─ If payment received → Issue pass
    ├─ If delayed → Send alert
    └─ If completed → Request survey
    ↓
Integration Actions
    ├─ Send to ERP/CRM
    ├─ Update inventory
    └─ Archive order

Performance Considerations

Rate Limiting

• Read operations: 1,000 requests per minute
• Write operations: 100 requests per minute
• Batch operations: 50 requests per minute
• Integration syncs: 10 requests per minute

Optimization Tips

1. Always use date range filters when querying historical data (checkpoints, orders, etc.)

   Code
    
   // ✅ Good
   GET /v1/checkpoints?from=2025-01-01&to=2025-01-31
   
   // ❌ Avoid
   GET /v1/checkpoints  // Without date range

2. Batch operations for bulk tasks

   Code
    
   POST /v1/orders/batch
   // Send up to 50 orders in a single request

3. Use webhooks instead of polling for real-time updates

   Code
    
   POST /v1/webhooks
   // Subscribe to order status changes

4. Implement exponential backoff for retries

   Code
    
   // Retry: 1s → 2s → 4s → 8s (with jitter)

Error Handling

RAVENT APIs return standard HTTP status codes and detailed error responses:

Code
 
// Error Response Example
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Order validation failed",
    "details": [
      {
        "field": "externalId",
        "issue": "Duplicate order - external ID already exists",
        "solution": "Use a unique external ID or check existing orders"
      }
    ],
    "requestId": "req_12345",
    "timestamp": "2025-01-15T08:30:00Z"
  }
}

Common Status Codes:

• 200 - Success
• 201 - Created
• 400 - Bad Request (validation error)
• 401 - Unauthorized (authentication issue)
• 403 - Forbidden (insufficient permissions)
• 404 - Not Found
• 429 - Rate Limited
• 500 - Server Error (retry with backoff)

Sandbox & Testing

Test your integration safely in our sandbox environment:

Code
 
# Sandbox Base URL
https://sandbox-api.ravent.com/v1

# Get sandbox credentials
POST https://sandbox-api.ravent.com/v1/auth/sandbox-token

Sandbox data is isolated and reset daily. Perfect for development and testing workflows.

Enterprise Features

Cold Chain Monitoring (Healthcare)

• Real-time temperature tracking
• FSMA and HACCP compliance
• Automated alerts for deviations
• Compliance reporting

Route Optimization (Last Mile)

• AI-powered route planning
• Dynamic re-routing
• Traffic awareness
• Cost optimization

Multi-Tenant Management (Organizations)

• Organizational hierarchies
• Role-based access control
• Cross-location visibility
• Audit logging

Getting Help

• Documentation: Full API reference available in this portal
• Code Examples: JavaScript, Python, and cURL examples for all common tasks
• Status Page: https://status.ravent.com
• Support: support@ravent.com
• Community: Slack channel for integration partners

What's Next?

Choose your path based on your use case:

• Orders API - Start accepting and managing orders
• Workflow Automation - Set up automated processes
• Payments Integration - Accept payments from customers
• Real-Time Tracking - Integrate live GPS tracking
• Multi-Channel Messaging - Notify customers via WhatsApp, SMS, email
• Third-Party Integrations - Connect to SAP, ODOO, Salesforce, etc.

Sample Use Cases

E-Commerce Food Delivery

Code
 
Customer orders via WhatsApp
    → RAVENT ingests order
    → Validates inventory
    → Creates delivery task
    → Assigns to driver
    → Tracks delivery real-time
    → Collects payment on delivery
    → Sends receipt + survey
    → Updates e-commerce platform

Healthcare Cold Chain

Code
 
Lab sample collected
    → Temperature sensor activated
    → Sample tracked to facility
    → Alerts if temp deviation
    → Auto-generates compliance report
    → Electronic POD with signature
    → Updates hospital system

Airport Ground Transportation

Code
 
Flight lands
    → Passenger info pulled
    → Ground transport pre-arranged
    → Vehicle assigned and tracked
    → Multi-stop route optimized
    → Real-time passenger updates
    → Payment processed on arrival
    → Satisfaction survey sent

Getting Started Today

1. Sign up at https://ravent.app
2. Get API credentials from your dashboard
3. Choose an integration from our native integrations
4. Build your first workflow using our visual editor or API
5. Go live with your optimized operations

---

Last Updated: January 2025
API Version: v1
Status: Production Ready
SLA: 99.9% uptime guarantee