Inventory

Inventory Adjustments

An InventoryAdjustment is a positive or negative change to the quantity of an inventory product at a location, capturing the reason for the change and the user who applied it.

get/inventory/adjustments

List inventory adjustments

listInventoryAdjustments

Returns the paginated list of stock adjustments — positive or negative changes to product quantities — across the caller's visible scope, optionally filtered by site.

Query parameters

site_idstringoptional
Filter results by the site they belong to
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

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

const response = await fetch('https://api.playground.try.be/inventory/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/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/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/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"
}

post/inventory/adjustments

Create a new inventory adjustment

createInventoryAdjustment

Records a stock adjustment — a positive or negative change to the quantity of a product at a location. The adjustment is timestamped and attributed to the calling user for audit.

Request body

product_iduuidrequired
Product whose stock level is being adjusted. The product must be configured on the same brand as the caller; cross-brand adjustments are rejected with 422.
quantityintegerrequired
Signed change to the on-hand stock count. Positive values increase stock (e.g. a receipt or correction upwards); negative values decrease it (e.g. waste, transfers out).
reason_codestringoptional
Machine-readable reason for the adjustment, used for reporting. Common values are waste, transfer, correction and theft. Free text — define your own codes as needed.
reason_descriptionstringoptional
Optional human-readable explanation that staff and auditors see alongside the adjustment. Use this to add detail that the reason_code doesn't capture.
location_idintegeroptionalnullable
InventoryLocation the stock is moving from. Optional for sites that don't track per-location stock; required when the product is location-aware.
site_iduuidoptional
Site the adjustment is recorded against. Used for site-level inventory reporting and to enforce the caller's site permissions.

Responses

201
A single inventory adjustment.
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/adjustments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
  "quantity": -3,
  "reason_code": "waste",
  "reason_description": "Damaged in transit — three units written off.",
  "location_id": 12,
  "site_id": "5dcb47800000000000000010"
}'

const response = await fetch('https://api.playground.try.be/inventory/adjustments', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "product_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "quantity": -3,
    "reason_code": "waste",
    "reason_description": "Damaged in transit — three units written off.",
    "location_id": 12,
    "site_id": "5dcb47800000000000000010"
  }),
})

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/adjustments",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "product_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
        "quantity": -3,
        "reason_code": "waste",
        "reason_description": "Damaged in transit — three units written off.",
        "location_id": 12,
        "site_id": "5dcb47800000000000000010"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/inventory/adjustments', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'product_id' => '5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d',
            'quantity' => -3,
            'reason_code' => 'waste',
            'reason_description' => 'Damaged in transit — three units written off.',
            'location_id' => 12,
            'site_id' => '5dcb47800000000000000010'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"product_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
		"quantity": -3,
		"reason_code": "waste",
		"reason_description": "Damaged in transit — three units written off.",
		"location_id": 12,
		"site_id": "5dcb47800000000000000010",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/inventory/adjustments", 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 adjustment.

{
  "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"
  }
}

{
  "message": "Unauthenticated"
}

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

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