Skip to Content
Quick Start

Quick Start

This guide takes you from zero to your first successful POST /v1/orders in 3 minutes using a sandbox API key. No production credentials needed.

Step 1 — Get your sandbox API key

  1. Log in to the merchant dashboard .
  2. Navigate to Settings → API Keys.
  3. Click Create key and select the orders:write scope.
  4. Copy the key — it begins with ilv_test_….

Keep your API key secret. Never commit it to version control or expose it in client-side code.

Step 2 — Create your first order

Replace YOUR_API_KEY with the key you just copied.

curl -X POST https://api.ideliver.ng/v1/orders \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "schema_version": "1",
    "source": "api",
    "external_order_id": "my-order-001",
    "raw_payload": {},
    "standardized": {
      "pickup_address": "12 Bode Thomas Street, Surulere, Lagos",
      "dropoff_address": "14 Awolowo Road, Ikoyi, Lagos",
      "customer_phone": "+2348011122233",
      "customer_name": "Amara Obi",
      "notes": "Birthday cake",
      "scheduled_pickup_at": "2030-06-01T14:00:00.000Z",
      "delivery_window_start": "2030-06-01T15:00:00.000Z",
      "delivery_window_end": "2030-06-01T18:00:00.000Z"
    }
  }'
import Ideliver from "@ideliver/node";
 
const client = new Ideliver({ apiKey: "YOUR_API_KEY" });
 
const order = await client.orders.create({
  schema_version: "1",
  source: "api",
  external_order_id: "my-order-001",
  raw_payload: {},
  standardized: {
    pickup_address: "12 Bode Thomas Street, Surulere, Lagos",
    dropoff_address: "14 Awolowo Road, Ikoyi, Lagos",
    customer_phone: "+2348011122233",
    customer_name: "Amara Obi",
    notes: "Birthday cake",
    scheduled_pickup_at: "2030-06-01T14:00:00.000Z",
    delivery_window_start: "2030-06-01T15:00:00.000Z",
    delivery_window_end: "2030-06-01T18:00:00.000Z",
  },
});
 
console.log(order.id);

A successful response returns HTTP 200 or 201 with the order (id, customer_tracking_url when configured, tracking_token, etc.). Use future ISO datetimes for the three scheduling fields — see Orders & Deliveries for Idempotency-Key, lat/lng, and COD fields.

Step 3 — Track your order

Use the tracking_token from the response to check the order status:

curl https://api.ideliver.ng/v1/tracking/TOKEN

Or point your customer to the public tracking page:

https://tracking.ideliver.ng/TOKEN

What’s next?

OverviewAuthentication