Quickstart

This guide gets the two latest sales orders from your space. Before you start, read the GraphQL API introduction.

Create an API token

In your Bonx workspace, go to Settings → API tokens and create a token. See Authentication if necessary.The same token works with the REST and GraphQL APIs.

Save the URL and token

The GraphQL URL for your space is provided with the token.

export BONX_GRAPHQL_URL="https://YOUR-GRAPHQL-URL"
export BONX_API_KEY="bxk_live_..."

$env:BONX_GRAPHQL_URL = "https://YOUR-GRAPHQL-URL"
$env:BONX_API_KEY = "bxk_live_..."

Send the request

Select the example for your environment.

curl -X POST "$BONX_GRAPHQL_URL" \
  -H "x-api-key: $BONX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"{ salesOrders(limit: 2, orderBy: {createdAt: DESC}) { id name stockAvailability } }"}'

const response = await fetch(process.env.BONX_GRAPHQL_URL, {
  method: 'POST',
  headers: {
    'x-api-key': process.env.BONX_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    query: `query GetSalesOrders($limit: Int!) {
      salesOrders(limit: $limit, orderBy: { createdAt: DESC }) {
        id
        name
        stockAvailability
      }
    }`,
    variables: { limit: 2 },
  }),
})

const { data, errors } = await response.json()

The response contains the id, name, and stockAvailability fields for each matching order.

A GraphQL request can return HTTP status 200 with an errors array. Always check errors before you use data.

Guides

Next step

Read data

Attach a document

​Next step

Read data

Attach a document

Next step