curl "$RUN_BASE_URL/business/orders?limit=20&page=1" \
-H "Authorization: Bearer $RUN_API_KEY"
const params = new URLSearchParams({ limit: '20', page: '1' });
const res = await fetch(
`${process.env.RUN_BASE_URL}/business/orders?${params}`,
{
headers: {
Authorization: `Bearer ${process.env.RUN_API_KEY}`,
},
},
);
const data = await res.json();
import os
import requests
res = requests.get(
f"{os.environ['RUN_BASE_URL']}/business/orders",
params={"limit": 20, "page": 1},
headers={"Authorization": f"Bearer {os.environ['RUN_API_KEY']}"},
)
data = res.json()
<?php
$query = http_build_query(['limit' => 20, 'page' => 1]);
$ch = curl_init(getenv('RUN_BASE_URL') . "/business/orders?{$query}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('RUN_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest(
"GET",
os.Getenv("RUN_BASE_URL")+"/business/orders?limit=20&page=1",
nil,
)
req.Header.Set("Authorization", "Bearer "+os.Getenv("RUN_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
{
"orders": [
{
"_id": "6a7c75f801df3fbb7fad0c58",
"order_id": "RUN-A1B2C3D4",
"status": "PENDING",
"price": 5300,
"distance": 7.54,
"sender_name": "Acme Stores",
"sender_phone": "+2348011111111",
"pickup_locations": [
{
"pickup": {
"address": "12 Admiralty Way, Lekki, Lagos",
"state": "Lagos"
},
"dropoff": {
"address": "15 Admiralty Way, Lekki, Lagos",
"state": "Lagos",
"recipient_name": "Adewale Johnson",
"recipient_phone_number": "+2348022222222"
},
"item": {
"name": "Shoes",
"weight": 5,
"quantity": 1
},
"status": "PENDING"
}
],
"createdAt": "2026-08-12T10:15:00.000Z",
"updatedAt": "2026-08-12T10:15:00.000Z"
}
],
"total": 42,
"page": 1,
"limit": 20,
"pages": 3
}
{
"statusCode": 401,
"timestamp": "2026-08-12T15:18:51.396Z",
"path": "/api/v2/business/orders",
"message": "Invalid API key"
}
{
"statusCode": 403,
"timestamp": "2026-08-12T15:18:51.396Z",
"path": "/api/v2/business/orders",
"message": "Insufficient API key scope"
}
List orders
List orders for your Business with optional filters.
GET
/
business
/
orders
curl "$RUN_BASE_URL/business/orders?limit=20&page=1" \
-H "Authorization: Bearer $RUN_API_KEY"
const params = new URLSearchParams({ limit: '20', page: '1' });
const res = await fetch(
`${process.env.RUN_BASE_URL}/business/orders?${params}`,
{
headers: {
Authorization: `Bearer ${process.env.RUN_API_KEY}`,
},
},
);
const data = await res.json();
import os
import requests
res = requests.get(
f"{os.environ['RUN_BASE_URL']}/business/orders",
params={"limit": 20, "page": 1},
headers={"Authorization": f"Bearer {os.environ['RUN_API_KEY']}"},
)
data = res.json()
<?php
$query = http_build_query(['limit' => 20, 'page' => 1]);
$ch = curl_init(getenv('RUN_BASE_URL') . "/business/orders?{$query}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('RUN_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest(
"GET",
os.Getenv("RUN_BASE_URL")+"/business/orders?limit=20&page=1",
nil,
)
req.Header.Set("Authorization", "Bearer "+os.Getenv("RUN_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
{
"orders": [
{
"_id": "6a7c75f801df3fbb7fad0c58",
"order_id": "RUN-A1B2C3D4",
"status": "PENDING",
"price": 5300,
"distance": 7.54,
"sender_name": "Acme Stores",
"sender_phone": "+2348011111111",
"pickup_locations": [
{
"pickup": {
"address": "12 Admiralty Way, Lekki, Lagos",
"state": "Lagos"
},
"dropoff": {
"address": "15 Admiralty Way, Lekki, Lagos",
"state": "Lagos",
"recipient_name": "Adewale Johnson",
"recipient_phone_number": "+2348022222222"
},
"item": {
"name": "Shoes",
"weight": 5,
"quantity": 1
},
"status": "PENDING"
}
],
"createdAt": "2026-08-12T10:15:00.000Z",
"updatedAt": "2026-08-12T10:15:00.000Z"
}
],
"total": 42,
"page": 1,
"limit": 20,
"pages": 3
}
{
"statusCode": 401,
"timestamp": "2026-08-12T15:18:51.396Z",
"path": "/api/v2/business/orders",
"message": "Invalid API key"
}
{
"statusCode": 403,
"timestamp": "2026-08-12T15:18:51.396Z",
"path": "/api/v2/business/orders",
"message": "Insufficient API key scope"
}
List orders for your Business.
Requires scope:
orders:read
Your API key can only list orders that belong to your Business. Use Get order when you need the full timeline.
Headers
string
required
Bearer API key (
Bearer <api_key>).Query parameters
number
Page number (default
1).number
Page size (default
10).string
Free-text search (order code, recipient name, phone).
string
Filter by shipment status.
string
Sort field:
NEWEST, OLDEST, PRICE_LOW_TO_HIGH, PRICE_HIGH_TO_LOW, DISTANCE_LOW_TO_HIGH, DISTANCE_HIGH_TO_LOW.string
ISO start date on
createdAt.string
ISO end date on
createdAt.Response
array
Page of orders (list payload omits
timeline).number
Total matching orders.
number
Current page.
number
Page size.
number
Total pages.
curl "$RUN_BASE_URL/business/orders?limit=20&page=1" \
-H "Authorization: Bearer $RUN_API_KEY"
const params = new URLSearchParams({ limit: '20', page: '1' });
const res = await fetch(
`${process.env.RUN_BASE_URL}/business/orders?${params}`,
{
headers: {
Authorization: `Bearer ${process.env.RUN_API_KEY}`,
},
},
);
const data = await res.json();
import os
import requests
res = requests.get(
f"{os.environ['RUN_BASE_URL']}/business/orders",
params={"limit": 20, "page": 1},
headers={"Authorization": f"Bearer {os.environ['RUN_API_KEY']}"},
)
data = res.json()
<?php
$query = http_build_query(['limit' => 20, 'page' => 1]);
$ch = curl_init(getenv('RUN_BASE_URL') . "/business/orders?{$query}");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('RUN_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest(
"GET",
os.Getenv("RUN_BASE_URL")+"/business/orders?limit=20&page=1",
nil,
)
req.Header.Set("Authorization", "Bearer "+os.Getenv("RUN_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
{
"orders": [
{
"_id": "6a7c75f801df3fbb7fad0c58",
"order_id": "RUN-A1B2C3D4",
"status": "PENDING",
"price": 5300,
"distance": 7.54,
"sender_name": "Acme Stores",
"sender_phone": "+2348011111111",
"pickup_locations": [
{
"pickup": {
"address": "12 Admiralty Way, Lekki, Lagos",
"state": "Lagos"
},
"dropoff": {
"address": "15 Admiralty Way, Lekki, Lagos",
"state": "Lagos",
"recipient_name": "Adewale Johnson",
"recipient_phone_number": "+2348022222222"
},
"item": {
"name": "Shoes",
"weight": 5,
"quantity": 1
},
"status": "PENDING"
}
],
"createdAt": "2026-08-12T10:15:00.000Z",
"updatedAt": "2026-08-12T10:15:00.000Z"
}
],
"total": 42,
"page": 1,
"limit": 20,
"pages": 3
}
{
"statusCode": 401,
"timestamp": "2026-08-12T15:18:51.396Z",
"path": "/api/v2/business/orders",
"message": "Invalid API key"
}
{
"statusCode": 403,
"timestamp": "2026-08-12T15:18:51.396Z",
"path": "/api/v2/business/orders",
"message": "Insufficient API key scope"
}
⌘I