ver. 0.297: REST API products endpoint — list, get, create, update
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
168
docs/API.md
168
docs/API.md
@@ -139,6 +139,173 @@ Opcjonalnie w body: `{"send_email": true}`
|
||||
PUT api.php?endpoint=orders&action=set_unpaid&id={order_id}
|
||||
```
|
||||
|
||||
### Produkty
|
||||
|
||||
#### Lista produktow
|
||||
```
|
||||
GET api.php?endpoint=products&action=list
|
||||
```
|
||||
|
||||
Parametry filtrowania (opcjonalne):
|
||||
| Parametr | Typ | Opis |
|
||||
|----------|-----|------|
|
||||
| `search` | string | Szukaj po nazwie, EAN lub SKU |
|
||||
| `status` | int (0/1) | Filtruj po statusie (1 = aktywny, 0 = nieaktywny) |
|
||||
| `promoted` | int (0/1) | Filtruj po promocji |
|
||||
| `sort` | string | Sortuj po: id, name, price_brutto, status, promoted, quantity (domyslnie id) |
|
||||
| `sort_dir` | string | Kierunek: ASC lub DESC (domyslnie DESC) |
|
||||
| `page` | int | Numer strony (domyslnie 1) |
|
||||
| `per_page` | int | Wynikow na strone (domyslnie 50, max 100) |
|
||||
|
||||
Odpowiedz:
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"data": {
|
||||
"items": [
|
||||
{
|
||||
"id": 1,
|
||||
"sku": "PROD-001",
|
||||
"ean": "5901234123457",
|
||||
"name": "Produkt testowy",
|
||||
"price_brutto": 99.99,
|
||||
"price_brutto_promo": null,
|
||||
"price_netto": 81.29,
|
||||
"price_netto_promo": null,
|
||||
"quantity": 10,
|
||||
"status": 1,
|
||||
"promoted": 0,
|
||||
"vat": 23,
|
||||
"weight": 0.5,
|
||||
"main_image": "product1.jpg",
|
||||
"date_add": "2026-01-15 10:00:00",
|
||||
"date_modify": "2026-02-19 12:00:00"
|
||||
}
|
||||
],
|
||||
"total": 1,
|
||||
"page": 1,
|
||||
"per_page": 50
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Szczegoly produktu
|
||||
```
|
||||
GET api.php?endpoint=products&action=get&id={product_id}
|
||||
```
|
||||
|
||||
Zwraca pelne dane produktu z jezykami, zdjeciami, kategoriami i atrybutami.
|
||||
|
||||
Odpowiedz:
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"data": {
|
||||
"id": 1,
|
||||
"sku": "PROD-001",
|
||||
"ean": "5901234123457",
|
||||
"price_brutto": 99.99,
|
||||
"price_brutto_promo": null,
|
||||
"price_netto": 81.29,
|
||||
"price_netto_promo": null,
|
||||
"quantity": 10,
|
||||
"status": 1,
|
||||
"promoted": 0,
|
||||
"vat": 23,
|
||||
"weight": 0.5,
|
||||
"stock_0_buy": 0,
|
||||
"custom_label_0": null,
|
||||
"set_id": null,
|
||||
"product_unit_id": 1,
|
||||
"producer_id": 3,
|
||||
"date_add": "2026-01-15 10:00:00",
|
||||
"date_modify": "2026-02-19 12:00:00",
|
||||
"languages": {
|
||||
"pl": {
|
||||
"name": "Produkt testowy",
|
||||
"short_description": "Krotki opis",
|
||||
"description": "<p>Pelny opis produktu</p>",
|
||||
"meta_description": null,
|
||||
"meta_keywords": null,
|
||||
"meta_title": null,
|
||||
"seo_link": "produkt-testowy",
|
||||
"copy_from": null,
|
||||
"warehouse_message_zero": null,
|
||||
"warehouse_message_nonzero": null,
|
||||
"tab_name_1": null,
|
||||
"tab_description_1": null,
|
||||
"tab_name_2": null,
|
||||
"tab_description_2": null,
|
||||
"canonical": null
|
||||
}
|
||||
},
|
||||
"images": [
|
||||
{"id": 1, "src": "product1.jpg", "alt": "Zdjecie produktu"}
|
||||
],
|
||||
"categories": [1, 5],
|
||||
"attributes": [
|
||||
{"attribute_id": 1, "value_id": 3}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Tworzenie produktu
|
||||
```
|
||||
POST api.php?endpoint=products&action=create
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"price_brutto": 99.99,
|
||||
"vat": 23,
|
||||
"quantity": 10,
|
||||
"status": 1,
|
||||
"sku": "PROD-001",
|
||||
"ean": "5901234123457",
|
||||
"weight": 0.5,
|
||||
"languages": {
|
||||
"pl": {
|
||||
"name": "Nowy produkt",
|
||||
"description": "<p>Opis produktu</p>"
|
||||
}
|
||||
},
|
||||
"categories": [1, 5],
|
||||
"products_related": [10, 20]
|
||||
}
|
||||
```
|
||||
|
||||
Wymagane: `languages` (min. 1 jezyk z `name`) oraz `price_brutto`.
|
||||
|
||||
Odpowiedz (HTTP 201):
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"data": {
|
||||
"id": 42
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Aktualizacja produktu
|
||||
```
|
||||
PUT api.php?endpoint=products&action=update&id={product_id}
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"price_brutto": 129.99,
|
||||
"status": 1,
|
||||
"languages": {
|
||||
"pl": {
|
||||
"name": "Zaktualizowana nazwa"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Partial update — wystarczy przeslac tylko zmienione pola. Pola nieprzeslane zachowuja aktualna wartosc.
|
||||
|
||||
Odpowiedz: pelne dane produktu (jak w `get`).
|
||||
|
||||
### Slowniki
|
||||
|
||||
#### Lista statusow zamowien
|
||||
@@ -195,4 +362,5 @@ UPDATE pp_settings SET value = 'twoj-klucz-api' WHERE param = 'api_key';
|
||||
- Router: `\api\ApiRouter` (`autoload/api/ApiRouter.php`)
|
||||
- Kontrolery: `autoload/api/Controllers/`
|
||||
- `OrdersApiController` — zamowienia (5 akcji)
|
||||
- `ProductsApiController` — produkty (4 akcje: list, get, create, update)
|
||||
- `DictionariesApiController` — slowniki (3 akcje)
|
||||
|
||||
Reference in New Issue
Block a user