API Reference

Overview

The BOMEO API is organized around REST. All requests and responses use JSON. Monetary values are in minor currency units (e.g. kobo for NGN, cents for USD). Currency is resolved from your tenant configuration.

https://api.bomeo.xyz/v1

Authentication

Authenticate by including your API key in the Authorization header. Generate keys from Settings → Integrations in the BOMEO dashboard.

Authorization: Bearer YOUR_API_KEY

API keys are scoped per tenant. Keep them secret; rotate if compromised.

Response Format

Every response follows a consistent envelope. Check ok for success, read data for the payload, and use meta.pagination for cursor-based paging.

{
  "ok": true,
  "data": { ... },
  "meta": {
    "apiVersion": "v1",
    "pagination": {
      "total": 42,
      "limit": 25,
      "hasMore": true,
      "nextCursor": "eyJ..."
    }
  }
}

Endpoints

All endpoints live under /api/v1.

Public IDs

All entities use human-readable prefixed IDs for easy debugging and correlation across systems.

Quick Start

Install an SDK and make your first API call.

import { BomeoClient } from "bomeo-sdk";

const bomeo = new BomeoClient({
  apiKey: process.env.BOMEO_API_KEY!,
  baseUrl: "https://api.bomeo.xyz/v1",
});

// List products
const { data, pagination } = await bomeo.products.list({
  limit: 25,
  search: "catfish",
});

// Create an order
const order = await bomeo.orders.create({
  subtotal: 450000,
  total: 450000,
  lines: [
    { productId: "prod_abc", quantity: 3, unitPrice: 150000 },
  ],
});

SDKs & Libraries

First-party SDKs that mirror the REST API.

Integration Guides

Step-by-step guides for connecting your e-commerce platform.