Inventory

Stock Takes

A StockTake represents a stock take of inventory items.

The StockTake object

Attributes

iduuidrequired
The ID of the stocktake.
descriptionstringrequired
The description of the stocktake.
statusstringrequired
The status of the stocktake.
Possible values:in_progresscomplete
currencystringrequired
The currency of the stocktake.
created_by_iduuidrequirednullable
The ID of the user who created the stocktake.
created_byobjectoptionalnullable
The summary of the user who created the stocktake.
posted_by_iduuidoptionalnullable
The ID of the user who posted the stocktake.
posted_byobjectoptionalnullable
The summary of the user who posted the stocktake.
items_addedbooleanrequired
Whether items have been added to the stock take.
site_iduuidrequired
The ID of the site the stocktake belongs to.
organisation_iduuidrequired
The ID of the organisation this stocktake belongs to.
created_atdate-timerequired
The date and time the stocktake was created.
posted_atdate-timerequirednullable
The date and time the stocktake was posted.
updated_atdate-timerequired
The date and time the stocktake was last updated.

{
  "id": "00000000-0000-0000-0000-000000000000",
  "description": "Stocktake started on 01/06/2024",
  "status": "in_progress",
  "currency": "gbp",
  "created_by_id": "00000000-0000-0000-0000-000000000000",
  "created_by": {},
  "posted_by_id": "00000000-0000-0000-0000-000000000000",
  "posted_by": {
    "id": "00000000-0000-0000-0000-000000000000",
    "email": "guest@example.com",
    "first_name": "Dan",
    "last_name": "Johnson",
    "full_name": "Dan Johnson"
  },
  "items_added": false,
  "site_id": "00000000-0000-0000-0000-000000000000",
  "organisation_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-06-01T12:00:00Z",
  "posted_at": "2026-01-15T09:30:00+00:00",
  "updated_at": "2026-01-15T09:30:00+00:00"
}

get/inventory/stock-takes

Create a Stocktake

createStockTake

This endpoint creates a stocktake for the given site.

Request body

descriptionstringrequired
Free-text label shown in the admin UI and on stocktake reports, used to distinguish this stocktake from others (e.g. "Quarterly retail count Q1 2024"). 1-255 characters.

Responses

201
The stocktake was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/inventory/stock-takes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Stocktake started on 01/06/2024"
}'

const response = await fetch('https://api.playground.try.be/inventory/stock-takes', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "description": "Stocktake started on 01/06/2024"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/inventory/stock-takes",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "description": "Stocktake started on 01/06/2024"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/inventory/stock-takes', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'description' => 'Stocktake started on 01/06/2024'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"description": "Stocktake started on 01/06/2024",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/inventory/stock-takes", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 stocktake was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "description": "Stocktake started on 01/06/2024",
    "status": "in_progress",
    "currency": "gbp",
    "created_by_id": "00000000-0000-0000-0000-000000000000",
    "created_by": {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "guest@example.com",
      "first_name": "Dan",
      "last_name": "Johnson",
      "full_name": "Dan Johnson"
    },
    "posted_by_id": "00000000-0000-0000-0000-000000000000",
    "posted_by": {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "guest@example.com",
      "first_name": "Dan",
      "last_name": "Johnson",
      "full_name": "Dan Johnson"
    },
    "items_added": false,
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-06-01T12:00:00Z",
    "posted_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/inventory/stock-takes/{stockTakeId}

Show a Stocktake

getStockTake

This endpoint retrieves a stocktake for the given site.

Path parameters

stockTakeIduuidrequired
Identifier of the stocktake. Returned from createStockTake; use it to read the stocktake, list or update its items, post the final counts, or poll the async queue for export status.

Responses

200
The stocktake was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000', {
  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/stock-takes/00000000-0000-0000-0000-000000000000",
    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/stock-takes/00000000-0000-0000-0000-000000000000', [
    '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/stock-takes/00000000-0000-0000-0000-000000000000", 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 stocktake was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "description": "Stocktake started on 01/06/2024",
    "status": "in_progress",
    "currency": "gbp",
    "created_by_id": "00000000-0000-0000-0000-000000000000",
    "created_by": {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "guest@example.com",
      "first_name": "Dan",
      "last_name": "Johnson",
      "full_name": "Dan Johnson"
    },
    "posted_by_id": "00000000-0000-0000-0000-000000000000",
    "posted_by": {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "guest@example.com",
      "first_name": "Dan",
      "last_name": "Johnson",
      "full_name": "Dan Johnson"
    },
    "items_added": false,
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-06-01T12:00:00Z",
    "posted_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

put/inventory/stock-takes/{stockTakeId}

Update a Stocktake

updateStockTake

This endpoint updates a stocktake for the given site.

Path parameters

stockTakeIduuidrequired
Identifier of the stocktake. Returned from createStockTake; use it to read the stocktake, list or update its items, post the final counts, or poll the async queue for export status.

Request body

descriptionstringoptional
Free-text label shown in the admin UI and on stocktake reports, used to distinguish this stocktake from others (e.g. "Quarterly retail count Q1 2024"). 1-255 characters.

Responses

200
The stocktake was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Stocktake started on 01/06/2024"
}'

const response = await fetch('https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "description": "Stocktake started on 01/06/2024"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "description": "Stocktake started on 01/06/2024"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'description' => 'Stocktake started on 01/06/2024'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"description": "Stocktake started on 01/06/2024",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 stocktake was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "description": "Stocktake started on 01/06/2024",
    "status": "in_progress",
    "currency": "gbp",
    "created_by_id": "00000000-0000-0000-0000-000000000000",
    "created_by": {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "guest@example.com",
      "first_name": "Dan",
      "last_name": "Johnson",
      "full_name": "Dan Johnson"
    },
    "posted_by_id": "00000000-0000-0000-0000-000000000000",
    "posted_by": {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "guest@example.com",
      "first_name": "Dan",
      "last_name": "Johnson",
      "full_name": "Dan Johnson"
    },
    "items_added": false,
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-06-01T12:00:00Z",
    "posted_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/inventory/stock-takes/{stockTakeId}

Delete a Stocktake

deleteStockTake

This endpoint deletes a stocktake for the given site.

Path parameters

stockTakeIduuidrequired
Identifier of the stocktake. Returned from createStockTake; use it to read the stocktake, list or update its items, post the final counts, or poll the async queue for export status.

Responses

204
The stocktake was successfully deleted.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  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.delete(
    "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000', [
    '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("DELETE", "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000", 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 stocktake was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/inventory/stock-takes/{stockTakeId}/post

Post a Stocktake

createStockTakePosting

This endpoint posts a stocktake for the given site.

Path parameters

stockTakeIduuidrequired
Identifier of the stocktake. Returned from createStockTake; use it to read the stocktake, list or update its items, post the final counts, or poll the async queue for export status.

Responses

200
The job was successfully queued
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/post" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/post', {
  method: 'POST',
  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.post(
    "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/post",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/post', [
    '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("POST", "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/post", 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": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/inventory/stock-takes/{stockTakeId}/items

List Stocktake Items

listStockTakeItems

This endpoint retrieves a list of all the items for the given stocktake.

Path parameters

stockTakeIduuidrequired
Identifier of the stocktake. Returned from createStockTake; use it to read the stocktake, list or update its items, post the final counts, or poll the async queue for export status.

Query parameters

brand_idsstring[]optional
A comma-separated list of brand IDs to retrieve stocktake items for.
category_idsstring[]optional
A comma-separated list of category IDs to retrieve stocktake items for.
supplier_idsstring[]optional
A comma-separated list of supplier IDs to retrieve stocktake items for.
queryuuidoptional
A search query to filter stocktake items by. This will search the item name.
statusstringoptional
The status to filter the stocktake items by.
Possible values:alluncountedcounted
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The stock take items were successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items', {
  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/stock-takes/00000000-0000-0000-0000-000000000000/items",
    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/stock-takes/00000000-0000-0000-0000-000000000000/items', [
    '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/stock-takes/00000000-0000-0000-0000-000000000000/items", 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 take items were successfully retrieved

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "stock_take_id": "00000000-0000-0000-0000-000000000000",
      "product_id": "00000000-0000-0000-0000-000000000000",
      "name": "Blissful Body Butter",
      "sku": "BB-001",
      "unit_cost": 2000,
      "counted_quantity": 50.5,
      "expected_quantity": 70.5,
      "adjusted_quantity": 20.5,
      "adjusted_value": 70,
      "created_at": "2024-06-01T00:00:00Z",
      "updated_at": "2024-06-01T00:00:00Z"
    }
  ],
  "meta": {
    "totals": {
      "items": 100,
      "counted": 50,
      "uncounted": 50,
      "adjustment_value": 1000
    },
    "currency": "gbp",
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

put/inventory/stock-takes/{stockTakeId}/items/{stockTakeItemId}

Update a Stocktake Item

updateStockTakeItem

This endpoint updates a stocktake item for the given stocktake.

Path parameters

stockTakeIduuidrequired
Identifier of the stocktake. Returned from createStockTake; use it to read the stocktake, list or update its items, post the final counts, or poll the async queue for export status.
stockTakeItemIduuidrequired
The ID of the StockTakeItem

Request body

counted_quantitynumberoptionalnullable
The quantity counted for this stocktake item.

Responses

200
The stocktake item was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "counted_quantity": 50.5
}'

const response = await fetch('https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "counted_quantity": 50.5
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "counted_quantity": 50.5
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'counted_quantity' => 50.5
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"counted_quantity": 50.5,
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 stocktake item was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "stock_take_id": "00000000-0000-0000-0000-000000000000",
    "product_id": "00000000-0000-0000-0000-000000000000",
    "name": "Blissful Body Butter",
    "sku": "BB-001",
    "unit_cost": 2000,
    "counted_quantity": 50.5,
    "expected_quantity": 70.5,
    "adjusted_quantity": 20.5,
    "adjusted_value": 70,
    "created_at": "2024-06-01T00:00:00Z",
    "updated_at": "2024-06-01T00:00:00Z"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/inventory/stock-takes/{stockTakeId}/items/{stockTakeItemId}

Delete a Stocktake Item

deleteStockTakeItem

This endpoint deletes a stocktake item for the given stocktake.

Path parameters

stockTakeIduuidrequired
Identifier of the stocktake. Returned from createStockTake; use it to read the stocktake, list or update its items, post the final counts, or poll the async queue for export status.
stockTakeItemIduuidrequired
The ID of the StockTakeItem

Responses

204
The stocktake item was successfully deleted.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  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.delete(
    "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000', [
    '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("DELETE", "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000000", 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 stocktake item was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/inventory/stock-takes/{stockTakeId}/queue

Export a Stocktake

actionQueueStockTakeExport

This endpoint queues an export of a stocktake for the given site.

Path parameters

stockTakeIduuidrequired
Identifier of the stocktake whose queued export job status is being fetched. Posting a stocktake kicks off an async job; poll this endpoint until the job reports as complete.

Query parameters

site_iduuidrequired
Filter the StockTake by site.
brand_idsstring[]optional
A comma-separated list of brand IDs to retrieve stocktake items for.
category_idsstring[]optional
A comma-separated list of category IDs to retrieve stocktake items for.
supplier_idsstring[]optional
A comma-separated list of supplier IDs to retrieve stocktake items for.
statusstringoptional
The status to filter the stocktake items by.
Possible values:alluncountedcounted

Responses

200
The job was successfully queued
400
The request failed.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/queue?site_id=00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/queue?site_id=00000000-0000-0000-0000-000000000000', {
  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/stock-takes/00000000-0000-0000-0000-000000000000/queue?site_id=00000000-0000-0000-0000-000000000000",
    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/stock-takes/00000000-0000-0000-0000-000000000000/queue?site_id=00000000-0000-0000-0000-000000000000', [
    '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/stock-takes/00000000-0000-0000-0000-000000000000/queue?site_id=00000000-0000-0000-0000-000000000000", 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"
}

{
  "message": "The requested resource could not be found"
}

get/inventory/stock-takes/{stockTakeId}/items-v2

List the items of a stock take (v2)

listStockTakeItemsV2

Returns the items of a stocktake with v2 totals and filters. Use query, status, and the category/supplier/brand filters to drill into a specific slice of the stocktake while it's in progress. Compared to the v1 list (listStockTakeItems), the v2 response surfaces additional totals: total items, counted, uncounted, total adjustment value, and currency.

Path parameters

stockTakeIduuidrequired
Identifier of the stocktake. Returned from createStockTake; use it to read the stocktake, list or update its items, post the final counts, or poll the async queue for export status.

Query parameters

category_idsstring[]optional
A comma-separated list of category IDs to filter the items by.
supplier_idsstring[]optional
A comma-separated list of supplier IDs to filter the items by.
brand_idsstring[]optional
A comma-separated list of brand IDs to filter the items by.
querystringoptional
A query to filter the products on. This searches the product name.
statusstringoptional
The status to filter the stock take items on.
Possible values:alluncountedcounted

Responses

200
The stock take items were successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items-v2" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/items-v2', {
  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/stock-takes/00000000-0000-0000-0000-000000000000/items-v2",
    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/stock-takes/00000000-0000-0000-0000-000000000000/items-v2', [
    '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/stock-takes/00000000-0000-0000-0000-000000000000/items-v2", 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 take items were successfully retrieved.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "stock_take_id": "00000000-0000-0000-0000-000000000000",
      "product_id": "00000000-0000-0000-0000-000000000000",
      "name": "Blissful Body Butter",
      "sku": "BB-001",
      "unit_cost": 2000,
      "counted_quantity": 50.5,
      "expected_quantity": 70.5,
      "adjusted_quantity": 20.5,
      "adjusted_value": 70,
      "created_at": "2024-06-01T00:00:00Z",
      "updated_at": "2024-06-01T00:00:00Z"
    }
  ],
  "meta": {
    "total_items": 100,
    "total_counted": 50,
    "total_uncounted": 50,
    "total_adjustment_value": 50,
    "currency": "gbp"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

post/inventory/stock-takes/{stockTakeId}/submit

Submit a stock take

actionSubmitStockTake

Submits the stocktake, locking it from further edits and posting the resulting stock adjustments synchronously. Use this instead of createStockTakePosting when the caller wants the adjustments applied immediately rather than via the async queue.

Path parameters

stockTakeIduuidrequired
Identifier of the stocktake. Returned from createStockTake; use it to read the stocktake, list or update its items, post the final counts, or poll the async queue for export status.

Responses

200
The stocktake was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/submit', {
  method: 'POST',
  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.post(
    "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/submit",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/submit', [
    '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("POST", "https://api.playground.try.be/inventory/stock-takes/00000000-0000-0000-0000-000000000000/submit", 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 stocktake was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "description": "Stocktake started on 01/06/2024",
    "status": "in_progress",
    "currency": "gbp",
    "created_by_id": "00000000-0000-0000-0000-000000000000",
    "created_by": {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "guest@example.com",
      "first_name": "Dan",
      "last_name": "Johnson",
      "full_name": "Dan Johnson"
    },
    "posted_by_id": "00000000-0000-0000-0000-000000000000",
    "posted_by": {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "guest@example.com",
      "first_name": "Dan",
      "last_name": "Johnson",
      "full_name": "Dan Johnson"
    },
    "items_added": false,
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-06-01T12:00:00Z",
    "posted_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}