Sync orders

Orders flow into Orderly from your connected bridges: automatically via webhooks, on a schedule via polling, or on demand by running a bridge task.

Automatic sync

Once a bridge is connected, Orderly registers webhooks with the source platform and schedules periodic polling. New and updated orders appear under GET /api/v1/orders without any action on your part.

On-demand sync

Trigger a bridge's grab-orders task to pull immediately, which is useful for backfills or after changing filters. Tasks run asynchronously through the queue, and each run is recorded in task_executions with status and retry tracking.

Reading synced orders

Filter and paginate with query parameters:

curl "https://api.orderly-hub.com/api/v1/orders?status=pending&since=2026-07-01T00:00:00Z&limit=50" \
  -H "Authorization: Bearer $ORDERLY_API_KEY" \
  -H "X-Organization-Id: $ORG_ID"

Parameter	Description
status	pending, processing, shipped, delivered, cancelled
bridge_id	Filter by source bridge
since	ISO 8601; orders created after this time
search	Order number, customer name, or email
include	Related resources, for example bridge, dispatch_assignments

Try it live on the Orders reference page.