Skip to main content

Overview

Unified APIs provide a single, standardized interface across all integrations. Instead of learning different APIs for Shopify, Amazon, ShipHero, and FedEx, you use one consistent API format.

The Problem They Solve

Without Unified APIs, you need to handle:
  • Different data formats (“order” vs “purchase” vs “transaction”)
  • Various authentication methods per service
  • Unique error responses from each platform
  • Multiple pagination styles

How Unified APIs Work

Data Normalization

All integrations return data in the same format:
// Shopify order, Amazon order, or Walmart order - same structure
{
  "id": "order_123",
  "status": "fulfilled",
  "line_items": [...],
  "shipping_address": {...}
}

Standard Operations

Every resource supports the same methods:
MethodEndpointDescription
ListGET /unified/{category}/{resource}List records
GetGET /unified/{category}/{resource}/{id}Get single record
CreatePOST /unified/{category}/{resource}Create record
UpdatePUT /unified/{category}/{resource}/{id}Update record
DeleteDELETE /unified/{category}/{resource}/{id}Delete record

Real-Time Access

Unified APIs fetch data directly from the source. No caching means:
  • Data is always current
  • No sync delays
  • No stale inventory counts

When to Use Unified vs Proxy APIs

Use Unified APIs when:

  • You need consistent data across integrations
  • Building features that work with multiple platforms
  • Data format matters more than platform-specific fields

Use Proxy APIs when:

  • You need platform-specific features
  • Accessing fields not in the unified schema
  • Building integration-specific functionality