Inventory

Stock On Hand

The StockOnHand report lists out the stock on hand for a site.

get/inventory/reports/stock-on-hand

Stock on Hand report

listStockOnHand

This endpoint provides a report of stock on hand for the given parameters.

Query parameters

site_iduuidrequired
Filter stock on hand by site.
datedaterequired
The date to filter stock on hand by.
brand_idsstring[]optional
A comma-separated list of brand IDs to filter stock on hand by.
category_idsstring[]optional
A comma-separated list of category IDs to filter stock on hand by.
supplier_idsstring[]optional
A comma-separated list of supplier IDs to filter stock on hand by.

Responses

200
The stock on hand was successfully retrieved
401
The user is unauthenticated

curl "https://api.playground.try.be/inventory/reports/stock-on-hand?site_id=00000000-0000-0000-0000-000000000000&date=2026-01-15" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/inventory/reports/stock-on-hand?site_id=00000000-0000-0000-0000-000000000000&date=2026-01-15', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/inventory/reports/stock-on-hand?site_id=00000000-0000-0000-0000-000000000000&date=2026-01-15",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/inventory/reports/stock-on-hand?site_id=00000000-0000-0000-0000-000000000000&date=2026-01-15', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/inventory/reports/stock-on-hand?site_id=00000000-0000-0000-0000-000000000000&date=2026-01-15", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The stock on hand was successfully retrieved

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Blissful Body Butter",
      "stock_level": 100.5,
      "stock_value": 2000,
      "average_cost": 2000
    }
  ],
  "meta": {
    "total_stock_value": 2000,
    "currency": "gbp"
  }
}

{
  "message": "Unauthenticated"
}

get/inventory/reports/stock-on-hand/queue

Stock on Hand report queue

getStockOnHandQueue

This endpoint queues an export of the report of stock on hand for the given parameters.

Query parameters

site_iduuidrequired
Filter stock on hand by site.
datedaterequired
The date to filter stock on hand by.
brand_idsstring[]optional
A comma-separated list of brand IDs to filter stock on hand by.
category_idsstring[]optional
A comma-separated list of category IDs to filter stock on hand by.
supplier_idsstring[]optional
A comma-separated list of supplier IDs to filter stock on hand by.

Responses

200
The job was successfully queued
400
The request failed.
401
The user is unauthenticated

curl "https://api.playground.try.be/inventory/reports/stock-on-hand/queue?site_id=00000000-0000-0000-0000-000000000000&date=2026-01-15" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/inventory/reports/stock-on-hand/queue?site_id=00000000-0000-0000-0000-000000000000&date=2026-01-15', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/inventory/reports/stock-on-hand/queue?site_id=00000000-0000-0000-0000-000000000000&date=2026-01-15",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/inventory/reports/stock-on-hand/queue?site_id=00000000-0000-0000-0000-000000000000&date=2026-01-15', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/inventory/reports/stock-on-hand/queue?site_id=00000000-0000-0000-0000-000000000000&date=2026-01-15", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The job was successfully queued

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "output": {},
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}