Quickstart - Bonx

Each business object has its own endpoint, which returns JSON. Use the REST API for most use cases, including writing data to Bonx.

1

Create a token

In your Bonx workspace, go to Settings → API tokens (see Authentication).

2

Set up your environment

export BONX_API_URL="https://YOUR-API-URL"
export BONX_API_KEY="bxk_live_..."

$env:BONX_API_URL = "https://YOUR-API-URL"
$env:BONX_API_KEY = "bxk_live_..."

3

Send a request

curl "$BONX_API_URL/sales-orders?limit=2" \
  -H "x-api-key: $BONX_API_KEY"

const res = await fetch(`${process.env.BONX_API_URL}/sales-orders?limit=2`, {
  headers: { 'x-api-key': process.env.BONX_API_KEY },
})
const { salesOrders } = await res.json()

type SalesOrder = { reference: string; stockAvailability: string }
const res = await fetch(`${process.env.BONX_API_URL}/sales-orders?limit=2`, {
  headers: { 'x-api-key': process.env.BONX_API_KEY! },
})
const { salesOrders } = (await res.json()) as { salesOrders: SalesOrder[] }

API conventions

Authentication: Include the token in the x-api-key header with every request.
Lists: Use limit and offset as query parameters. Results are ordered with the most recent first unless stated otherwise.
Single records: Add the record ID to the path, for example /sales-orders/6.
Writing data: Use POST to create records and PUT to update them. Send request bodies as JSON.

Next steps

Reference

Browse every endpoint, including its fields and examples.

Examples

Concrete cases, ready to adapt.