Produkty (Products)

Tato dokumentace popisuje kolekci Produktů v backendu Rentall.cz. Veškerá komunikace probíhá ve formátu JSON.

Základní URL: https://rentall.cz
Základní cesta: /api/products

Poznámky k této dokumentaci:

Autentizace a oprávnění jsou specifické pro váš projekt. Chraňte endpointy dle potřeby.
ID jsou řetězce (např. 68b5b692be9080affaa098c3). V příkladech používáme konkrétní ID pro srozumitelnost.

Endpointy

Výpis produktů — GET /api/products
Detail produktu podle ID — GET /api/products/:id
Vytvoření/akce nad produktem s daným ID — POST /api/products/:id
Aktualizace produktu — PATCH /api/products/:id
Smazání produktu — DELETE /api/products/:id

Tip: Vaše instalace může podporovat také POST /api/products pro vytvoření nového produktu bez předem známého ID. Tento projekt navíc popisuje POST /api/products/:id pro specifické create/upsert/akční flow.

Parametry cesty

:id — ID produktu (string). Příklad: 68b5b692be9080affaa098c3

Objekt Product (shrnutí schématu)

Běžná pole v odpovědích a při create/update požadavcích:

id — jedinečný identifikátor (string)
createdAt, updatedAt — ISO časová razítka
internal_name — interní název/označení
basic — základní info o produktu
- product_name — názvem srozumitelný pro uživatele
- product_desc — popis (může mít zalomení řádků)
- location — kde se produkt fyzicky nachází
- rent_owner — informace o pronajímateli (vnořeně basic, terms, invoices, …)
additional — cena a parametry pronájmu
- price — základní cena (number)
- caution — vratná kauce (number)
- time_unit — např. day
- selectedTerm — ID podmínek aplikovaných na produkt. Musí odpovídat některému z basic.rent_owner.terms.termsArray[].id.
settings — publikace a URL detaily
- published — boolean
- slug — URL slug
gallery — pole obrázků s id, alt, filename, mimeType, url, rozměry, apod.
availability — např. reservationDates
seo, legacy — volitelná metadata/namespacing

Ukázkový produkt (zkráceno)


{
	"id": "68b5b692be9080affaa098c3",
	"createdAt": "2025-09-01T15:06:58.847Z",
	"updatedAt": "2025-09-01T15:07:09.125Z",
	"internal_name": "Example Product",
	"basic": {
		"product_name": "Example Product",
		"product_desc": "Example description ...",
		"location": "Example City",
		"rent_owner": {
			"basic": {
				"rentalName": "Example Rentals s.r.o.",
				"rentalContactPerson": "John Doe",
				"rentalPhone": "+420000000000",
				"rentalEmail": "info@rentall.cz"
			}
		}
	},
	"additional": {
		"price": 500,
		"caution": 1000,
		"time_unit": "day",
		"selectedTerm": "qjnagbx6h1j"
	},
	"settings": {
		"published": true,
		"slug": "vycepni-zarizeni-pipa-lindr-as-40-2-kohout-zwxfkxo"
	},
	"gallery": {
		"images": [
			{
				"id": "68b5b692be9080affaa098c1",
				"alt": "Example Product",
				"filename": "IMG20250614205309.jpg",
				"mimeType": "image/jpeg",
				"url": "/api/rentMedia/file/IMG20250614205309.jpg",
				"width": 819,
				"height": 614
			}
		]
	},
	"availability": {
		"reservationDates": []
	}
}

Poznámka: Osobní a firemní údaje v příkladech jsou pouze zástupné. Oficiální kontakt: info@rentall.cz.

Tvar chybové odpovědi (příklad)


{
	"errors": [
		{
			"message": "Validation failed: basic.product_name is required",
			"field": "basic.product_name"
		}
	]
}

Pokračujte na konkrétní metodu pro detailní popis a příklady:

Související: