Skip to main content

​
Overview

The Unified Realtime API provides instant access to data from your connected accounts. Each request fetches live data directly from the underlying service - no caching, no delays.

​
Base URL

https://api.usehandled.io/api/v1/ipaas/unified_realtime

​
Authentication

All requests require a Bearer token: 
Authorization: Bearer YOUR_API_TOKEN

​
Required Parameters

ParameterDescription
integrated_account_idThe connected account to query

​
Available Resources

The Unified Realtime API supports the following commerce primitives:
ResourceDescription
OrdersCustomer purchases with line items, pricing, shipping, and financial data
ProductsSKUs, descriptions, pricing, dimensions, and attributes
InventoryStock levels across warehouses and fulfillment centers
CustomersBuyer information, preferences, and purchase history
Fulfillment OrdersOrder allocations to locations/fulfillment partners
Fulfillment ShipmentsShipping confirmations with carrier and tracking info
ReturnsRMA requests flowing to warehouses for processing
RefundsApproved refund records triggering credits
TrackingsShipment tracking with carrier and delivery status

​
Example Request

curl 'https://api.usehandled.io/api/v1/ipaas/unified_realtime/orders?integrated_account_id=ACCOUNT_ID&limit=10' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

​
Example Response

{
  "result": [
    {
      "id": "order_123",
      "status": "pending",
      "line_items": [...],
      "shipping_address": {...},
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "next_cursor": "abc123"
}

​
When to Use Realtime API

Use Realtime When

  • You need current data immediately
  • Building dashboards or reports
  • Single record lookups
  • Real-time order management

Use Cached When

  • Bulk data operations
  • Historical analysis
  • Reducing API calls to underlying services
  • Working with rate-limited integrations