Voorraad
Raadpleeg het voorraadoverzicht en bekijk voorraadtransacties.
Endpoints
| Methode | Pad | Beschrijving |
|---|---|---|
GET | /inventory/overview | Voorraadoverzicht ophalen |
GET | /inventory/overview/:id | Voorraaddetails per content ophalen |
GET | /inventory/available | Beschikbare voorraad per artikel |
GET | /inventory/available/:sku_id | Beschikbare voorraad van één artikel |
GET | /inventory/transactions | Alle transacties ophalen |
GET | /inventory/transactions/:id | Specifieke transactie ophalen |
GET | /inventory/lostandfound | Lost & Found items ophalen |
GET | /inventory/lostandfound/:id | Lost & Found detail ophalen |
Voorraadoverzicht
GET /inventory/overview
Response 200 OK
[
{
"content_id": 1001,
"sku_id": "SKU-001",
"description": "Widget A",
"loc_id": "LOC-A01",
"qty": 100,
"qty_allocated": 10,
"qty_tasked_from": 0,
"tag_id": "TAG-0001",
"expiry_date": "2027-01-01",
"client_id": "CLIENT01",
"created_datetime": "2026-03-14 10:30:00"
}
]
| Veld | Type | Beschrijving |
|---|---|---|
content_id | number | Uniek ID van de voorraadinhoud |
sku_id | string | Artikel-ID |
description | string | Artikelomschrijving |
loc_id | string | Locatie-ID |
qty | number | Totale hoeveelheid |
qty_allocated | number | Gealloceerde hoeveelheid (gereserveerd voor orders) |
qty_tasked_from | number | Hoeveelheid in open taken vanaf deze voorraad (picken, inruimen, verplaatsen) |
qty_tasked_to | number | Hoeveelheid in open taken met deze locatie als eindbestemming (onderweg naar de locatie) |
tag_id | string | Tag/label ID |
expiry_date | string | Vervaldatum (YYYY-MM-DD) |
client_id | string | Client ID (fulfillment) |
Beschikbare voorraad
Beschikbare voorraad = qty − qty_allocated. Trek qty_tasked_from er niet ook van af: een gealloceerde hoeveelheid krijgt een picktaak met hetzelfde aantal, en de allocatie blijft staan tot de zending geladen is. Gebruik voor de beschikbare voorraad per artikel bij voorkeur GET /inventory/available.
Beschikbare voorraad
GET /inventory/available
GET /inventory/available/:sku_id
De beschikbare voorraad per artikel: wat er ligt, min wat al voor orders gereserveerd is. Artikelen zonder voorraad komen ook terug, met 0. Voorraad in Lost & Found telt niet mee. Voorraad die net ontvangen is en nog ingeruimd moet worden, telt wel mee.
Een API key die aan een opdrachtgever gekoppeld is, en een gebruiker van het klantportaal, zien alleen de artikelen van die opdrachtgever. Een API key of gebruiker zonder opdrachtgever ziet alle artikelen en kan filteren met ?client_id=.
Query parameters
| Parameter | Type | Beschrijving |
|---|---|---|
client_id | string | Alleen artikelen van deze opdrachtgever. Bij een API key of portaalgebruiker met een opdrachtgever alleen die eigen opdrachtgever; een andere geeft 403 |
Response 200 OK
GET /inventory/available geeft een lijst, GET /inventory/available/:sku_id één object:
[
{
"sku_id": "SKU-001",
"description": "Widget A",
"client_id": "CLIENT01",
"qty": 15,
"qty_allocated": 5,
"qty_available": 10
}
]
| Veld | Type | Beschrijving |
|---|---|---|
sku_id | string | Artikel-ID |
description | string | Artikelomschrijving |
client_id | string | Opdrachtgever van het artikel |
qty | number | Totale voorraad in het magazijn |
qty_allocated | number | Gereserveerd voor orders, tot de zending geladen is |
qty_available | number | Beschikbaar voor nieuwe orders: qty - qty_allocated |
Response 403 Forbidden
Er is een andere opdrachtgever gevraagd dan die van de API key of gebruiker.
Response 404 Not Found
Alleen bij /:sku_id: het artikel bestaat niet, of hoort bij een andere opdrachtgever.
Beschikbare voorraad
GET /inventory/available
GET /inventory/available/:sku_id
De beschikbare voorraad per artikel: wat er ligt, min wat al voor orders gereserveerd is. Artikelen zonder voorraad komen ook terug, met 0. Voorraad in Lost & Found telt niet mee. Voorraad die net ontvangen is en nog ingeruimd moet worden, telt wel mee.
Een API key die aan een opdrachtgever gekoppeld is, en een gebruiker van het klantportaal, zien alleen de artikelen van die opdrachtgever. Een API key of gebruiker zonder opdrachtgever ziet alle artikelen en kan filteren met ?client_id=.
Query parameters
| Parameter | Type | Beschrijving |
|---|---|---|
client_id | string | Alleen artikelen van deze opdrachtgever. Bij een API key of portaalgebruiker met een opdrachtgever alleen die eigen opdrachtgever; een andere geeft 403 |
Response 200 OK
GET /inventory/available geeft een lijst, GET /inventory/available/:sku_id één object:
[
{
"sku_id": "SKU-001",
"description": "Widget A",
"client_id": "CLIENT01",
"qty": 15,
"qty_allocated": 5,
"qty_available": 10
}
]
| Veld | Type | Beschrijving |
|---|---|---|
sku_id | string | Artikel-ID |
description | string | Artikelomschrijving |
client_id | string | Opdrachtgever van het artikel |
qty | number | Totale voorraad in het magazijn |
qty_allocated | number | Gereserveerd voor orders, tot de zending geladen is |
qty_available | number | Beschikbaar voor nieuwe orders: qty - qty_allocated |
Response 403 Forbidden
Er is een andere opdrachtgever gevraagd dan die van de API key of gebruiker.
Response 404 Not Found
Alleen bij /:sku_id: het artikel bestaat niet, of hoort bij een andere opdrachtgever.
Voorraaddetails
GET /inventory/overview/:id
Response 200 OK
Retourneert een enkel voorraadrecord met hetzelfde formaat als het overzicht.
Transacties
GET /inventory/transactions
Response 200 OK
[
{
"id": 1,
"dstamp": "2026-03-14 10:30:00",
"transaction_type": "Receipt",
"content_id": 1001,
"from_loc_id": "RECV-01",
"to_loc_id": "STAGE-01",
"final_loc_id": "LOC-A01",
"sku_id": "SKU-001",
"qty": 100,
"tag_id": "TAG-0001",
"order_id": null,
"line_id": null,
"notes": null,
"client_id": "CLIENT01"
}
]
| Veld | Type | Beschrijving |
|---|---|---|
id | number | Transactie-ID |
dstamp | string | Datum/tijd (YYYY-MM-DD HH:mm:ss) |
transaction_type | string | Type (Receipt, Allocate, Pick, etc.) |
content_id | number | Content ID |
from_loc_id | string | Van locatie |
to_loc_id | string | Naar locatie |
final_loc_id | string | Eindlocatie |
sku_id | string | Artikel-ID |
qty | number | Hoeveelheid |
tag_id | string | Tag ID |
order_id | string | Gerelateerd order ID |
line_id | number | Gerelateerd regelnummer |
notes | string | Opmerkingen |
client_id | string | Client ID |
Specifieke transactie
GET /inventory/transactions/:id
Response 200 OK
Retourneert een enkele transactie.
Response 404 Not Found
{
"message": "Inventory transaction with transactionId 999 not found"
}