Inventory

Inventory Categories

An InventoryCategory represents a category for inventory items.

get/inventory/categories

This endpoint persists the display order of inventory categories for a given site. The position of each ID in the category_ids array is stored as that category's order. All IDs must belong to the caller's site and organisation and must not be archived.

Request body

site_iduuidrequired
Identifier of the site whose inventory categories are being reordered. All IDs in category_ids must belong to this site; the caller's API key must have access to it.
category_idsstring[]required
The inventory category IDs in the desired display order. Each category's position in this array is stored as its order.

Responses

204
The inventory categories were successfully reordered.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/inventory/categories/order" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "site_id": "00000000-0000-0000-0000-000000000000",
  "category_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

const response = await fetch('https://api.playground.try.be/inventory/categories/order', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "site_id": "00000000-0000-0000-0000-000000000000",
    "category_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }),
})

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/categories/order",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "site_id": "00000000-0000-0000-0000-000000000000",
        "category_ids": [
            "00000000-0000-0000-0000-000000000000"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

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

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"site_id": "00000000-0000-0000-0000-000000000000",
		"category_ids": []interface{}{
			"00000000-0000-0000-0000-000000000000",
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/inventory/categories/order", 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 inventory categories were successfully reordered.

// empty response

{
  "message": "Unauthenticated"
}

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

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

get/inventory/categories/{categoryId}

Show an Inventory Category

getInventoryCategory

This endpoint retrieves an inventory category for the given organisation.

Path parameters

categoryIduuidrequired
The ID of the InventoryCategory

Responses

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

curl "https://api.playground.try.be/inventory/categories/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/categories/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/categories/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/categories/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/categories/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 inventory category was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Massage oils",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "order": 0
  }
}

{
  "message": "Unauthenticated"
}

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

put/inventory/categories/{categoryId}

Update an Inventory Category

updateInventoryCategory

This endpoint updates an inventory category for the given organisation.

Path parameters

categoryIduuidrequired
The ID of the InventoryCategory

Request body

namestringoptional
Human-readable name for the inventory category, used to group related inventory products in the admin UI and on reports. Trimmed; 1-120 characters.

Responses

200
The inventory category 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/categories/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Massage oils"
}'

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

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/categories/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Massage oils"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

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

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Massage oils",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/inventory/categories/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 inventory category was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Massage oils",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "order": 0
  }
}

{
  "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/categories/{categoryId}

Archive an Inventory Category

deleteInventoryCategory

This endpoint soft deletes an inventory category for the given organisation.

Path parameters

categoryIduuidrequired
The ID of the InventoryCategory

Responses

204
The inventory category was successfully archived.
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/categories/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/categories/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/categories/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/categories/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/categories/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 inventory category was successfully archived.

// empty response

{
  "message": "Unauthenticated"
}

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

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

post/inventory/categories/{categoryId}/restore

Restore an Inventory Category

restoreInventoryCategory

This endpoint restores an archived (soft-deleted) inventory category by ID.

Path parameters

categoryIduuidrequired
The ID of the InventoryCategory

Responses

200
The inventory category 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/categories/00000000-0000-0000-0000-000000000000/restore" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

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

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Massage oils",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "order": 0
  }
}

{
  "message": "Unauthenticated"
}

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

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

Inventory Categories

List Inventory Categories

Query parameters

Responses

Create an Inventory Category

Request body

Responses

Reorder Inventory Categories

Request body

Responses

Show an Inventory Category

Path parameters

Responses

Update an Inventory Category

Path parameters

Request body

Responses

Archive an Inventory Category

Path parameters

Responses

Restore an Inventory Category

Path parameters

Responses