Zaslat dokumentace
Zaslat Returns API

Zakázky

Server

Vytváření, úprava a přehled servisních zakázek.


Seznam zakázek

GET
https://nazev-spolecnosti.zaslat.cz/api/v1
/commissions
x-apikey (header)

Vrací stránkovaný seznam zakázek. Seznam je možné filtrovat podle níže uvedených parametrů.

⚠️ Zdrojová tabulka „Query parametry pro filtrování" nebyla při tvorbě této specifikace čitelná. Níže uvedené parametry jsou pouze ty, které se objevují v ukázkových dotazech ve zdrojové dokumentaci — tabulka pravděpodobně obsahuje další filtry (např. rozsah dat do, servisní středisko, typ/model výrobku). Parametry page a page_size jsou odvozeny z názvů polí v odpovědi (meta.page_current, meta.page_size), jejich přesný název na vstupu nebyl ověřen.

Seznam zakázek › query Parameters

status[]
​CommissionStatus[] · style: form · explode: true

Filtrace podle stavu zakázky. Lze zadat opakovaně pro filtraci přes více stavů.

Enum values:
pending
incoming
processing
outgoing
finished
cancelled
created_from
​string · date

Vrátí pouze zakázky vytvořené od tohoto data (včetně).

Example: 2021-06-20
number
​string

Filtrace podle čísla zakázky (i částečné shody, viz příklad Z21D02).

Example: Z21D02
page
​integer · min: 1

⚠️ Číslo stránky výsledků (název parametru odvozen, neověřeno).

page_size
​integer

⚠️ Počet položek na stránku (název parametru odvozen, neověřeno).

Seznam zakázek › Responses

200

Seznam zakázek.

status
​integer
​PageMeta

Metadata stránkování seznamu.


Detail zakázky

GET
https://nazev-spolecnosti.zaslat.cz/api/v1
/commissions/{id}
x-apikey (header)

Vrací detail jedné zakázky podle jejího interního ID.

Detail zakázky › path Parameters

id
​integer · required

Interní ID zakázky.

Detail zakázky › Responses

200

Detail zakázky.

status
​integer
​Commission

Detail servisní zakázky.


Vytvoření zakázky

POST
https://nazev-spolecnosti.zaslat.cz/api/v1
/commissions/create
x-apikey (header)

Vytvoří novou zakázku a případně objedná dopravu od zákazníka do servisu.

Zakázku lze vytvořit i bez objednávky dopravy (shipment_from_customer: false) — jde potom o jednosměrnou zakázku, sloužící pouze k zaslání výrobku zákazníkovi zpět. Obousměrná zakázka obsahuje na konci servisního procesu jak dopravu od zákazníka, tak dopravu zpět k zákazníkovi.

Při vytvoření zakázky včetně dopravy (shipment_from_customer: true) je zakázka po doručení zásilky do servisu automaticky přepnuta do stavu processing. V době od vytvoření do doručení je zakázka ve stavu incoming — zakázky vytvořené servisním střediskem přes API jsou totiž automaticky schválené (na rozdíl od zakázek zadaných koncovým zákazníkem přes frontend, které čekají ve stavu pending na schválení).

Vytvoření zakázky › Request Body

​object · required

Objekt určující adresu zákazníka.

shipment_from_customer
​boolean · required

Příznak, zda má zakázka příchozí zásilku od zákazníka (true – obousměrná zakázka) nebo ne (false – jednosměrná zakázka).

date_buy
​string · date · required

Datum zakoupení výrobku ve formátu YYYY-MM-DD.

message
​string · required

Popis závady.

type
​CommissionType · enum · required

Typ zakázky.

Enum values:
warranty
afterWarranty
​object

Vyžadováno pouze pokud shipment_from_customer: true.

product_id
​integer

ID modelu výrobku (získané voláním GET /product-model). Je nutné zvolit právě jednu z variant product_id nebo external_key — model výrobku musí existovat a být přiřazen alespoň k jednomu servisnímu středisku.

external_key
​string

Externí označení modelu výrobku (alternativa k product_id, viz výše).

invoice_file_token
​string

Token souboru dokladu o nákupu, získaný voláním POST /commissions/upload-file. Povinné v případě záruční (warranty) zakázky.

external_id
​string | null

Značka zákazníka / externí identifikátor.

product_serial_number
​string

Sériové číslo výrobku.

pre_sale_service
​boolean

Předprodejní servis.

refund_money
​boolean

Požadavek na vrácení kupní ceny výrobku po dokončení zakázky.

Vytvoření zakázky › Responses

Úspěšné vytvoření zakázky.

status
​integer
​Commission

Detail servisní zakázky.


Úprava zakázky

POST
https://nazev-spolecnosti.zaslat.cz/api/v1
/commissions/edit
x-apikey (header)

Slouží ke změně údajů zakázky a k objednání dopravy ze servisu zpět k zákazníkovi.

Pokud je objednávána doprava zpět k zákazníkovi (shipment_to_customer: true), zakázka se po doručení zásilky zpět zákazníkovi automaticky uzavře a vygenerují se příslušné notifikace. Bez zásilky zákazníkovi zůstává zakázka otevřená až do ručního uzavření (servisním střediskem, nebo nastavením status přes toto API).

Objednaná odchozí zásilka se vytvoří na nejbližší termín svozu; zakázka musí být ve stavu outgoing (lze nastavit současně s objektem shipment) a automaticky se exportuje dopravci.

⚠️ Zdrojová tabulka „BODY" pro tento endpoint nebyla při tvorbě této specifikace čitelná. Pole požadavku níže byla rekonstruována z ukázkových JSON požadavků v dokumentaci — doporučujeme ověřit proti zdrojové tabulce, zejména u pole product_model (v ukázce se objevuje jako vstupní pole, ačkoli se stejnojmenné pole jinak jeví jako odvozené z product_id/external_key).

Úprava zakázky › Request Body

Alespoň jedno z polí `id` nebo `number` je povinné a zakázka musí příslušet servisnímu středisku volajícího uživatele.
id
​integer

Interní ID zakázky (alternativa k number).

number
​string

Číslo zakázky (alternativa k id).

product_id
​integer
product_model
​string

⚠️ Objevuje se v ukázkovém požadavku jako vstupní pole; jinde v dokumentaci je stejné pole popsáno jako odvozené od product_id/external_key — nebylo možné ověřit, zda jde skutečně o přímo editovatelnou hodnotu.

product_serial_number
​string
type
​CommissionType · enum

Typ zakázky.

Enum values:
warranty
afterWarranty
external_id
​string | null
date_buy
​string · date
status
​string · enum

Nastavení jiného než aktuálního stavu zakázky vyvolá navazující akce (push notifikace, e-mailová notifikace).

Enum values:
pending
incoming
processing
outgoing
finished
cancelled
​object

Uvádí se pouze v případě, že je potřeba editovat kontaktní údaje zákazníka. Povinné firstname + surname, nebo company.

shipment_to_customer
​boolean

Příznak objednání odchozí zásilky zpět zákazníkovi.

​object

Vyžadováno společně s shipment_to_customer: true.

Úprava zakázky › Responses

Úspěšné uložení změny.

status
​integer
message
​string
​Commission

Detail servisní zakázky.


Nahrání souboru k zakázce

POST
https://nazev-spolecnosti.zaslat.cz/api/v1
/commissions/upload-file
x-apikey (header)

Slouží k nahrání souboru potřebného u záručních oprav, zejména dokladu o nákupu výrobku. Vrácený token se následně použije v poli invoice_file_token při vytvoření zakázky. Povolené koncovky: PDF, JPG, JPEG. Maximální velikost souboru je 2 MB.

Nahrání souboru k zakázce › Request Body

file
​string · required

Nahrávaný soubor (PDF, JPG nebo JPEG, max. 2 MB).

Nahrání souboru k zakázce › Responses

200

Soubor byl uložen na externí úložiště.

status
​integer
message
​string
token
​string

Token souboru, použije se v poli invoice_file_token.

url
​string

Adresa uloženého souboru na externím úložišti.

execution_time
​number · float