Inventory

Inventory Locations

An InventoryLocation is a physical bucket within a site against which stock counts and adjustments are recorded — for example, "Treatment store", "Retail floor", or "Back of house".

get/inventory/locations

Create a new inventory location

createInventoryLocation

Creates a new inventory location at the given site. Locations are the buckets against which stock counts and adjustments are recorded.

Request body

namestringrequired
A display name for the location.

Responses

201
A single inventory location.
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/locations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Treatment store"
}'

const response = await fetch('https://api.playground.try.be/inventory/locations', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Treatment store"
  }),
})

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/locations",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Treatment store"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/inventory/locations', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Treatment store'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Treatment store",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/inventory/locations", 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)
}

A single inventory location.

{
  "data": {
    "id": "10000000-0000-0000-0000-000000000000",
    "organisation_id": "20000000-0000-0000-0000-000000000000",
    "site_id": "30000000-0000-0000-0000-000000000000",
    "name": "Treatment store",
    "created_at": "2019-01-15T12:00:00.000Z",
    "updated_at": "2019-01-15T12:00:00.000Z"
  }
}

{
  "message": "Unauthenticated"
}

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

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

get/inventory/locations/{locationId}

Get the details of a single inventory location

getInventoryLocation

Returns the canonical record for a single inventory location.

Path parameters

locationIduuidrequired
The ID of the inventory location.

Responses

200
A single inventory location.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/inventory/locations/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/locations/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/locations/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/locations/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/locations/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)
}

A single inventory location.

{
  "data": {
    "id": "10000000-0000-0000-0000-000000000000",
    "organisation_id": "20000000-0000-0000-0000-000000000000",
    "site_id": "30000000-0000-0000-0000-000000000000",
    "name": "Treatment store",
    "created_at": "2019-01-15T12:00:00.000Z",
    "updated_at": "2019-01-15T12:00:00.000Z"
  }
}

{
  "message": "Unauthenticated"
}

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

put/inventory/locations/{locationId}

Update an existing inventory location

updateInventoryLocation

Updates the display name of an inventory location. Stock counts and adjustments already recorded against the location are unaffected.

Path parameters

locationIduuidrequired
The ID of the inventory location.

Request body

namestringoptional
A display name for the location.

Responses

200
A single inventory location.
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/locations/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Treatment store"
}'

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

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

<?php

$client = new \GuzzleHttp\Client();

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

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

package main

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

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

A single inventory location.

{
  "data": {
    "id": "10000000-0000-0000-0000-000000000000",
    "organisation_id": "20000000-0000-0000-0000-000000000000",
    "site_id": "30000000-0000-0000-0000-000000000000",
    "name": "Treatment store",
    "created_at": "2019-01-15T12:00:00.000Z",
    "updated_at": "2019-01-15T12:00:00.000Z"
  }
}

{
  "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/locations/{locationId}

Soft-deletes an inventory location so it no longer appears in location pickers or new stock movements. Historical stock adjustments, stocktakes and order items already attached to the location remain intact and continue to reference the deleted record by ID.

Path parameters

locationIduuidrequired
The ID of the inventory location.

Responses

204
The inventory location 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/locations/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/locations/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/locations/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/locations/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/locations/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 location was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

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

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

get/inventory/locations/{locationId}/adjustments

List adjustments for a single inventory location

listInventoryLocationAdjustments

Returns the paginated list of stock adjustments scoped to a single inventory location. Use this for a per-location audit trail of stock movement.

Path parameters

locationIduuidrequired
The ID of the inventory location.

Query parameters

per_pageintegeroptional
The number of results to return per page
pageintegeroptional
The page to retrieve results from

Responses

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

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

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

Adjustments were successfully retrieved.

{
  "data": [
    {
      "id": "10000000-0000-0000-0000-000000000000",
      "organisation_id": "20000000-0000-0000-0000-000000000000",
      "site_id": "30000000-0000-0000-0000-000000000000",
      "product_id": "30000000-0000-0000-0000-000000000000",
      "quantity": 1,
      "reason_code": "string",
      "reason_description": "Free-form text from the resource.",
      "location_id": 1,
      "created_at": "2019-01-15T12:00:00.000Z"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  }
}

{
  "message": "Unauthenticated"
}

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

Inventory Locations

List inventory locations

Query parameters

Responses

Create a new inventory location

Request body

Responses

Get the details of a single inventory location

Path parameters

Responses

Update an existing inventory location

Path parameters

Request body

Responses

Delete an inventory location

Path parameters

Responses

List adjustments for a single inventory location

Path parameters

Query parameters

Responses