Developer API

Build on Olonka with the Developer API.

Connect Olonka to the tools you already run: a marketplace, an accounting package, a warehouse system or your own app. Products, orders, production and stock, over a REST API with scoped keys.

Read the API docs View the changelog

REST and JSON, version 1, with an OpenAPI specification

GET/api/v1/inventory200 OK

# Stock of one item at the Accra warehouse
curl "https://api.olonka.com/api/v1/inventory?locationId=3&variantId=1042" \
  -H "Authorization: Bearer $OLONKA_API_KEY"

{
  "data": [
    {
      "variantId": 1042,
      "sku": "RM-10001",
      "name": "Shea Butter (Refined)",
      "locationId": 3,
      "onHand": 140,
      "committed": 25,
      "expected": 250,
      "available": 115
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 50
}

What you can build

Connect the systems Olonka doesn't connect to yet.

Use the API when an integration doesn't exist, or when your business needs something only you can build.

Bring in orders from anywhere

Create sales orders from a marketplace, a B2B portal or your own shop. An idempotency key makes sure a retried request never creates the order twice.

Keep stock in step

Read what's on hand, committed, expected and available at each location, and post stock adjustments and transfers.

Report in your own tools

Pull orders, costs and margins into a spreadsheet or BI dashboard. Cost figures appear only for keys allowed to see them.

Run production from other systems

Create manufacturing orders, pick their materials and complete them when the work is done.

What's in the API

The same records you work with in Olonka.

Read and write the records behind every part of the app.

ProductsProducts, services, variants, recipes and operations/products · /variants
Customers and suppliersContacts with their currency and details/customers · /suppliers
Sales ordersLines, picking, fulfilment, tracking, make-to-order and buy-to-order/sales-orders
ReturnsCustomer returns, return events and restocking/returns
Purchase ordersOrdering, receiving and subcontracting/purchase-orders
Manufacturing ordersIngredients, operations, picking and completion/manufacturing-orders
InventoryStock levels, adjustments, transfers, batches and serial numbers/inventory · /stock-adjustments · /stock-transfers
Reference dataLocations, storages, units, taxes, currencies, categories, operations and resources/locations · /uom · /taxes …

All paths start with https://api.olonka.com/api/v1. See every endpoint →

Safe by design

Keys that can do only what you allow.

Scoped keysGive each key only the scopes it needs, such as sales-orders:write or inventory:read. Costs, margins and stock values stay hidden unless you grant them.
Location accessA key reaches every location, or only the ones you choose.
Keys belong to the accountA key keeps working when people change roles or leave, and every change it makes is recorded against it. Rotate or revoke keys at any time.
Clear errorsStandard status codes, a stable error code and a correlation ID to quote to support.
Fair limits120 requests a minute and 10,000 a day per key and endpoint, with headers that show what's left.
VersionedVersion 1 only changes in compatible ways. Breaking changes get a new version, and every change is in the changelog.

Example: a key for an order syncReads products, customers and stock, creates sales orders, and never sees costs.

products:readGranted
contacts:readGranted
sales-orders:writeGranted
inventory:readGranted
reference-data:readGranted
costs:readNot granted
profit-margin:readNot granted
stock-value:readNot granted

Get started

Your first request in three steps.

01
Create a key
In Olonka, open Settings › Developer API, choose the key's scopes and locations, and copy it. The full key is shown only once.
02
Send your first request
Send the key as a bearer token to https://api.olonka.com/api/v1.
03
Read the guides
Start with pagination, errors and rate limits, then explore the full API reference.

Developer documentation

IntroductionBase URL, versioning and what's in version 1 AuthenticationKeys, scopes, location access and rotation PaginationPaging and filtering list endpoints ErrorsStatus codes, error codes and retries Rate limitsLimits, headers and backing off API referenceEvery endpoint, with the OpenAPI specification

Rather not write code?

IntegrationsConnect Shopify, WooCommerce and Built in a few clicks.AI assistantAsk ChatGPT or Claude about orders, stock and sales.

Questions about the API

What does the API cost?

Nothing extra. The API is included, like every feature, while Olonka is in early access.

Who can create API keys?

People whose role covers what the key needs. You can only give a key the scopes and locations you can reach yourself.

What happens to a key when someone leaves?

Nothing changes: keys belong to the account, not to a person. Review the keys they created, then rotate or revoke the ones you no longer need.

Can we get higher rate limits?

Yes. Contact support before you increase your request volume, and tell us what your integration does.

Do we need the API to connect ChatGPT or Claude?

No. The AI assistant connects in a few clicks, without code.

Start building on Olonka.

Create a free account, then make your first key in Settings › Developer API.

Start free Read the API docs