Download OpenAPI specification:Download
This is API overview
Returns array of items both with serial and with quantity
location_ids | Array of integers List of location IDs to filter items by |
category_id | integer Category ID to filter items by |
category_type | string Enum: "asset" "stock" Type of items to retrieve (asset or stock) |
category_label | string Category label to filter items by |
[- {
- "id": 321,
- "serial": "XYZ321",
- "pyrcode": "PYR0L100",
- "location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}
}
]
serial | string |
category_id | string |
origin | string Enum: "druga-era" "probis" "targowe" "personal-{}" "other-{}" Where is it from, default types are enum, but it allows to pass also personal & other, it just need to contain "keyword" to pass like druga-era-external |
{- "serial": "string",
- "category_id": "string",
- "origin": "druga-era"
}
{- "id": 321,
- "serial": "XYZ321",
- "pyrcode": "PYR0L100",
- "location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}
}
pyrcode required | string Barcode value of item |
{- "id": 321,
- "serial": "XYZ321",
- "pyrcode": "PYR0L100",
- "location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}
}
Creates multiple assets with the same category, location and status
serials | Array of strings List of serial numbers for assets to create |
location_id | integer Location ID where assets will be stored (defaults to 1 if not specified) |
status | string Status of the assets (defaults to "available" if not specified) |
category_id | integer Category ID for the assets |
origin | string Origin of the assets (e.g. "purchase") |
{- "serials": [
- "string"
], - "location_id": 0,
- "status": "string",
- "category_id": 0,
- "origin": "string"
}
{- "created": [
- {
- "id": 321,
- "serial": "XYZ321",
- "pyrcode": "PYR0L100",
- "location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}
}
], - "errors": [
- "string"
]
}
Create stock item
category_id | integer category of stock |
quantity | integer |
{- "category_id": 4,
- "quantity": 99
}
{- "id": 0,
- "category_id": 4,
- "quantity": 99
}
{- "assets": [
- {
- "id": 321,
- "serial": "XYZ321",
- "pyrcode": "PYR0L100",
- "location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}
}
], - "stock_items": [
- {
- "id": 0,
- "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}, - "quantity": 0
}
]
}
Search for items in a specific location by serial number, category name, or category label
locationID required | integer Numeric ID of the location |
q required | string Search query (minimum 1 character) |
[- {
- "id": 321,
- "serial": "XYZ321",
- "pyrcode": "PYR0L100",
- "location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}
}
]
Zwraca listę wszystkich transferów w systemie
[- {
- "id": 0,
- "from_location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "to_location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "assets_collection": [
- {
- "id": 321,
- "serial": "XYZ321",
- "pyrcode": "PYR0L100",
- "location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}
}
], - "stock_items_collection": [
- {
- "id": 0,
- "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}, - "quantity": 0
}
], - "transfer_date": "2019-08-24T14:15:22Z",
- "status": "in_transit"
}
]
Tworzy nowy transfer zasobów i pozycji magazynowych między lokalizacjami
from_location_id required | integer Identyfikator lokalizacji źródłowej |
location_id required | integer Identyfikator lokalizacji docelowej |
Array of objects Kolekcja zasobów serializowanych do transferu | |
Array of objects Kolekcja pozycji magazynowych do transferu |
{- "from_location_id": 1,
- "location_id": 2,
- "asset_item_collection": [
- {
- "id": 0
}
], - "stock_item_collection": [
- {
- "id": 0,
- "quantity": 0
}
]
}
{- "id": 0,
- "from_location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "to_location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "assets_collection": [
- {
- "id": 321,
- "serial": "XYZ321",
- "pyrcode": "PYR0L100",
- "location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}
}
], - "stock_items_collection": [
- {
- "id": 0,
- "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}, - "quantity": 0
}
], - "transfer_date": "2019-08-24T14:15:22Z",
- "status": "in_transit"
}
Zwraca szczegółowe informacje o transferze na podstawie jego ID
transferID required | integer Identyfikator transferu |
{- "id": 0,
- "from_location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "to_location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "assets_collection": [
- {
- "id": 321,
- "serial": "XYZ321",
- "pyrcode": "PYR0L100",
- "location": {
- "id": 3,
- "name": "Gzdaczroom"
}, - "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}
}
], - "stock_items_collection": [
- {
- "id": 0,
- "category": {
- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}, - "quantity": 0
}
], - "transfer_date": "2019-08-24T14:15:22Z",
- "status": "in_transit"
}
Potwierdza transfer i aktualizuje lokalizację zasobów
transferID required | integer Identyfikator transferu |
{- "transfer_id": 3,
- "status": "completed",
- "message": "Transfer confirmed successfully"
}
Anuluje transfer i przywraca wszystkie zasoby i pozycje magazynowe do oryginalnej lokalizacji
transferID required | integer Identyfikator transferu |
{- "transfer_id": 3,
- "status": "cancelled",
- "message": "Transfer cancelled successfully"
}
Usuwa zasób z transferu i przywraca go do wskazanej lokalizacji
transferID required | integer Identyfikator transferu |
itemID required | integer Identyfikator zasobu |
location_id required | integer Identyfikator lokalizacji, do której należy przywrócić zasób |
{- "location_id": 1
}
{- "transfer_id": 3
}
Usuwa pozycję magazynową z transferu i przywraca ją do wskazanej lokalizacji
transferID required | integer Identyfikator transferu |
categoryID required | integer Identyfikator kategorii pozycji magazynowej |
location_id required | integer Identyfikator lokalizacji, do której należy przywrócić pozycję magazynową |
quantity required | integer Ilość, która powinna zostać przywrócona |
{- "location_id": 1,
- "quantity": 32
}
{- "message": "Stock item removed from transfer successfully"
}
Aktualizuje lokalizację dostawy dla transferu w trakcie lub zakończonego
transferID required | integer Identyfikator transferu |
required | object |
{- "delivery_location": {
- "lat": 50.00366850638076,
- "lng": 20.235703352753667,
- "timestamp": "2025-04-18T21:43:12.473Z"
}
}
{- "message": "Lokalizacja dostawy została zaktualizowana"
}
This can only be done by the logged in user.
type | string |
label | string |
{- "type": "laptop",
- "label": "Laptop"
}
{- "id": 0,
- "type": "asset",
- "name": "laptop",
- "label": "Laptop"
}
This can only be done by the logged in user with admin role.
Created user object
username required | string |
password required | string |
fullname | string |
role required | string (Role) Enum: "user" "moderator" "admin" Poziom uprawnień użytkownika |
{- "username": "johndoe",
- "password": "password123",
- "fullname": "John Doe",
- "role": "user"
}
{- "message": "User registered successfully"
}
Updates an existing user. Requires admin role.
id required | integer <int64> User ID |
Updated user object
fullname | string |
password | string |
role | string (Role) Enum: "user" "moderator" "admin" Poziom uprawnień użytkownika |
{- "fullname": "John Doe Updated",
- "password": "newpassword123",
- "role": "user"
}
{- "id": 1,
- "username": "johndoe",
- "fullname": "John Doe",
- "role": "user",
- "points": 0
}
Updates points for an existing user. Requires admin role.
id required | integer <int64> User ID |
Points update request
points required | integer New points value for the user |
{- "points": 100
}
{- "message": "User points updated successfully"
}
Adds or subtracts points from an existing user. Use positive values to add points, negative to subtract. Requires admin role.
id required | integer <int64> User ID |
Points adjustment request
points required | integer Points to add (positive) or subtract (negative) |
{- "points": 10
}
{- "message": "User points updated successfully",
- "points": 110
}