Data Room

The data_room feature gives end users read access to their orders, shipments, and tracking information. Enable it by adding data_room to your enabled_features.

This grants the orders:read, shipments:read, and tracking:read scopes to sessions.

Data Isolation

Orders and shipments are automatically associated with end users through their bridges. When an end user’s bridge syncs data, the orders and shipments are tagged with their end_user_id. End users can only see data that belongs to them.

Orders

List Orders


GET /api/embed/orders?page=1&limit=20&search=SKU-123
Authorization: Bearer est_session-token

Supports pagination and search. Returns orders belonging to the authenticated end user.

Get Order Detail


GET /api/embed/orders/:id
Authorization: Bearer est_session-token

Returns the order with its activity timeline.


{
  "data": {
    "id": "uuid",
    "external_id": "ORD-1234",
    "status": "processing",
    "customer": {
      "name": "John Doe",
      "email": "john@example.com"
    },
    "line_items": [...],
    "totals": {
      "subtotal": 99.99,
      "shipping": 9.99,
      "total": 109.98
    },
    "activities": [
      {
        "type": "status_change",
        "from": "pending",
        "to": "processing",
        "timestamp": "2026-03-20T12:00:00Z"
      }
    ]
  }
}

Shipments

List Shipments


GET /api/embed/shipments?page=1&limit=20
Authorization: Bearer est_session-token

Get Shipment Detail


GET /api/embed/shipments/:id
Authorization: Bearer est_session-token

Returns the shipment with tracking checkpoints:


{
  "data": {
    "id": "uuid",
    "tracking_number": "1Z999AA10123456784",
    "carrier": "UPS",
    "status": "in_transit",
    "ship_date": "2026-03-19T08:00:00Z",
    "estimated_delivery": "2026-03-22T18:00:00Z",
    "checkpoints": [
      {
        "status": "in_transit",
        "status_detail": "Departed facility",
        "location": "Memphis, TN",
        "checkpoint_time": "2026-03-20T06:30:00Z"
      }
    ]
  }
}

Tracking

Get Tracking Timeline


GET /api/embed/tracking/:shipmentId
Authorization: Bearer est_session-token

Returns only tracking checkpoints without PII — suitable for display in customer-facing interfaces.

Combining with Action Requests

The data room works well with action requests. End users can view their order, then submit a request to cancel or modify it — all within your embedded experience.