Skip to Content
Embed SystemBridge Management

Bridge Management

The bridges feature is always enabled in the embed system. It lets your end users connect their own platforms (Shopify, ShipStation, etc.) without accessing the Orderly portal.

How It Works

  1. End user authenticates with their session token
  2. They browse available bridge types (filtered by your config)
  3. They enter their credentials or go through OAuth
  4. The bridge is created under your organization, scoped to their end user ID

Endpoints

All bridge endpoints require a valid est_ session token.

List Bridges

GET /api/v1/embed/bridges
Authorization: Bearer est_session-token

Returns only bridges belonging to the authenticated end user.

Create Bridge

POST /api/embed/bridges
Authorization: Bearer est_session-token
Content-Type: application/json
 
{
  "bridgeTypeId": "uuid",
  "name": "My Shopify Store",
  "config": {
    "shopDomain": "mystore.myshopify.com",
    "apiKey": "shpat_..."
  }
}

The bridge type must be in the session’s allowedBridgeTypes and your config’s allowed_bridge_types.

Update Bridge

PATCH /api/embed/bridges/:id
Authorization: Bearer est_session-token
Content-Type: application/json
 
{
  "name": "Updated Name",
  "status": "active",
  "config": {
    "apiKey": "shpat_new-key"
  }
}

Config fields are merged — you only need to send the fields you’re changing.

Delete Bridge

DELETE /api/embed/bridges/:id
Authorization: Bearer est_session-token

Test Bridge Connection

POST /api/embed/bridges/:id/test
Authorization: Bearer est_session-token

Tests connectivity to the external platform and returns success/failure.

List Available Bridge Types

GET /api/v1/embed/bridge-types
Authorization: Bearer est_session-token

Returns bridge types filtered by your embed config and the session’s allowed types.

OAuth Bridges

For platforms that use OAuth (like Shopify), the embed system handles the flow:

POST /api/embed/bridges/shopify/oauth/start
Authorization: Bearer est_session-token
Content-Type: application/json
 
{
  "shopDomain": "mystore.myshopify.com"
}

This creates a bridge in oauth_pending status and returns the OAuth authorization URL. The end user completes authorization, and the bridge status updates to active automatically.

See OAuth for more details.

Scoping

Bridges created through embeds are always scoped:

  • End users can only see and manage their own bridges
  • Data synced through their bridges is tagged with their end user ID
  • You retain full access to all bridges at the organization level
End UsersData Room