Skip to main content

Quickstart

Get from an empty account to orders flowing in.

If you have not created your organization yet, complete account setup first.

1. Connect a store​

In the dashboard, go to Bridges → Add Bridge and pick your platform.

  • Shopify and other OAuth platforms just need your store subdomain. Type the mystore part of mystore.myshopify.com and authorize. No API key required.
  • API-key platforms (ShipStation, WooCommerce) ask for their credentials instead.

For the full walkthrough, see Connect a store & sync orders.

2. Let orders sync in​

Once connected, orders sync automatically: in real time if you enable webhooks, or on a schedule otherwise. To pull immediately, click Sync now on the bridge card. Your orders appear on the Orders page, updating live.

3. Automate routing (optional)​

Send orders to fulfillment automatically with a dispatcher. Route from Shopify to ShipStation (or a 3PL) when an order matches your conditions.

Prefer the API?​

Add a Custom API bridge when your application is the order source. It gives API-created orders a clear source and can optionally deliver routed orders to your HTTPS endpoint. See the Custom API bridge guide.

Create an API key under API Keys with the scopes you need, then read orders:

export ORDERLY_API_KEY="oh_live_xxx"
export ORG_ID="your-organization-uuid"

curl "https://api.orderly-hub.com/api/v1/orders?limit=20" \
  -H "Authorization: Bearer $ORDERLY_API_KEY" \
  -H "X-Organization-Id: $ORG_ID"
{
  "data": [
    {
      "id": "…",
      "order_number": "1001",
      "status": "pending",
      "customer": { "name": "Jane Doe", "email": "jane@example.com" },
      "total": 49.99,
      "currency": "USD"
    }
  ],
  "pagination": { "page": 1, "limit": 20, "total": 128 }
}

Next​