Export zboží do XLSX
/api/v2/export/productsVytvoří export zboží firmy do souboru XLSX. Soubor se uloží na serveru a najdete ho v aplikaci na obrazovce Import / Export. Odpověď obsahuje jen {"result":"success"}, samotný soubor nevrací. Vytvořený soubor lze použít pro import zboží (table=exports), takže export slouží i jako záloha stavu zboží.
Exportují se nesmazané produkty seřazené podle kódu. Parametr categories omezí výběr na produkty zařazené do některé z uvedených kategorií; produkt ve více kategoriích je v souboru jednou. Každé volání vytvoří nový soubor.
Soubor exportu
Název souboru má tvar {firma}_{uživatel}_zbozi_{RRRR_MM_DD_HH_MM_SS}.xlsx. Jediný list obsahuje hlavičku (názvy sloupců jsou v tabulce, většina je bez diakritiky) a jeden řádek na produkt. Měrné jednotky, měny, DPH, kategorie, sklady, ingredience a ceníky jsou uvedené kódy z nastavení firmy. Seznamy hodnot v jedné buňce jsou oddělené čárkou a jejich počty jsou ve stejném pořadí v sousedním sloupci.
| Sloupec | Hlavička | Sloupec | Hlavička |
|---|---|---|---|
| A | Kod |
S | Pocty (kusy ve skladech) |
| B | Carovy kod |
T | Hlidani min a max |
| C | Nazev |
U | Min |
| D | Alias |
V | Max |
| E | Popis |
W | ID dodavatele |
| F | Merna jednotka |
X | ID miniatury |
| G | Mena nakupni ceny |
Y | Zadavat mnozstvi |
| H | DPH (nákupní) |
Z | Hlasit do kuchyne |
| I | s DPH? (nákupní cena) |
AA | Respektovat sklad |
| J | Nakupni cena bez DPH |
AB | Samostatne prodejne |
| K | Nakupni cena s DPH |
AC | Vytezovani |
| L | Primarni DPH |
AD | Ingredience |
| M | s DPH? (prodejní cena) |
AE | Pocty (ingredience) |
| N | Prodejni cena bez DPH |
AF | Prodej do mínusu |
| O | Prodejni cena s DPH |
AG | Prumerovat nakupni cenu |
| P | Kategorie |
AH | Ceniky |
| Q | Skladove |
AI | Ceny |
| R | Sklady |
AJ | Sekundární DPH |
Význam jednotlivých sloupců a povolené hodnoty (0 a 1 u příznaků) popisuje návod Import / Export. Stejné pořadí sloupců čte import zboží.
Odpověď
Úspěch je JSON s HTTP 200. Chyby přihlášení a chybně poslaný parametr categories vrací JSON s status a message, viz Chybové stavy.
Autentizace a oprávnění
Vyžaduje API token: Bearer v hlavičce nebo URL token.
Parametry
Query parametry
| Název | Typ | Povinný | Popis | Příklad |
|---|---|---|---|---|
categories | string | ne | Filtr kategorií. Čárkou oddělené ID kategorií (například `12,15`), nebo kódy kategorií. Když jsou všechny hodnoty čísla, berou se jako ID, jinak jako kódy. Bez hodnoty se exportuje všechno zboží. | 12,15 |
Tělo požadavku
| Název | Typ | Povinný | Popis | Příklad |
|---|---|---|---|---|
categories | string | ne | Totéž co v query, posílá se jako formulářové pole (application/x-www-form-urlencoded). Hodnota musí být jeden řetězec oddělený čárkou; pole hodnot (`categories[]=...`) vrátí HTTP 400. | 12,15 |
Příklad požadavku
curl
curl -X POST 'https://www.elpokladny.cz/api/v2/export/products?categories=12%2C15' \
-H 'Authorization: Bearer elp_live_example.example_secret'PHP
<?php
$ch = curl_init('https://www.elpokladny.cz/api/v2/export/products?categories=12%2C15');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array (
0 => 'Authorization: Bearer elp_live_example.example_secret',
),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;javascript
const response = await fetch("https://www.elpokladny.cz/api/v2/export/products?categories=12%2C15", {
"method": "POST",
"headers": {
"Authorization": "Bearer elp_live_example.example_secret"
}
});
const data = await response.json();Ukázkové odpovědi
Export byl vytvořen (HTTP 200)
application/json
{
"result": "success"
}
Chybí platné přihlášení (HTTP 401)
application/json
{
"status": "error",
"message": "Unauthorized"
}
Kategorie poslané jako pole (HTTP 400)
application/json
{
"status": "error",
"message": "Input value \"categories\" contains a non-scalar value."
}
Možné chyby
| HTTP | Kdy | Podoba |
|---|---|---|
| 400 | Pole `categories` je poslané jako pole hodnot (`categories[]=12`), ne jako řetězec. | status-message |
| 401 | Chybí API token. Odpověď má hlavičku WWW-Authenticate: Bearer. | status-message |
| 401 | Neplatný, odvolaný nebo expirovaný API token (Bearer, api_token). Odpověď nemá hlavičku WWW-Authenticate. | status-message |
| 403 | API token se použil z IP adresy, která není u přístupu povolená. | status-message |