Skip to main content

Overview

The Unified Cache API provides access to cached data from your connected accounts. Data is synchronized periodically, enabling fast bulk queries without hitting underlying service rate limits.

Base URL

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

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 Cache 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_cache/orders?integrated_account_id=ACCOUNT_ID&limit=100' \
  -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",
      "cached_at": "2024-01-15T11:00:00Z"
    }
  ],
  "next_cursor": "abc123"
}

Cache Freshness

The cached_at field indicates when the data was last synchronized. Set up sync jobs to control cache refresh frequency.

When to Use Cache API

Use Cached When

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

Use Realtime When

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