Zaslat dokumentace
Zaslat Returns API
Zaslat Returns API

Schemas

Download schema

PageMeta

Metadata stránkování seznamu.
total
​integer

Celkový počet záznamů odpovídajících filtru.

count
​integer

Počet záznamů na aktuální stránce.

page_current
​integer

Číslo aktuální stránky.

page_total
​integer

Celkový počet stránek.

page_size
​integer

Velikost stránky.

Address

Adresa zákazníka nebo servisního střediska (návratový tvar v detailu zakázky).
firstname
​string
surname
​string
email
​string
phone
​string
company
​string
tin
​string | null

IČ.

vatin
​string | null

DIČ.

street
​string
city
​string
zip
​string
country
​string

Kód země, např. ISO 3166-1 alpha-2 (CZ).

latLng
​array | null · minItems: 2 · maxItems: 2

Zeměpisná šířka a délka adresy.

CustomerInput

Objekt zákazníka odesílaný při vytvoření nebo úpravě zakázky. ⚠️ Rekonstruováno z ukázkových požadavků v dokumentaci (zdrojová tabulka „CUSTOMER" nebyla čitelná) — pole `tin` a `vatin` jsou převzata z tvaru adresy v odpovědi a jejich zapisovatelnost přes toto API nebyla ověřena.
firstname
​string · required
surname
​string · required
company
​string

Povinné místo firstname + surname, jde-li o firemního zákazníka.

street
​string
city
​string
zip
​string
country
​string

Kód země, např. ISO 3166-1 alpha-2 (CZ).

phone
​string
email
​string
tin
​string

⚠️ IČ — nepotvrzeno jako vstupní pole.

vatin
​string

⚠️ DIČ — nepotvrzeno jako vstupní pole.

ShipmentInput

Objekt zásilky odesílaný při vytvoření zakázky (`shipment_from_customer: true`) nebo při objednání odchozí zásilky (`shipment_to_customer: true`). ⚠️ Rekonstruováno z ukázkových požadavků v dokumentaci (zdrojová tabulka „SHIPMENT" nebyla čitelná) — je pravděpodobné, že objekt podporuje další pole viditelná ve tvaru odpovědi (např. dobírku `cod`/`cod_currency`/`cod_variable`, vlastní adresy `from`/`to`), ale jejich zapisovatelnost a přesné názvy nebyly ověřeny.
collection
​Collection · enum

Číselník možností vyzvednutí zásilky.

Enum values:
pickup
dropoff
pickupPlace
collection_date
​string | null · date

Požadované datum vyzvednutí (YYYY-MM-DD), lze null.

weight
​number

Hmotnost zásilky.

CreateCommissionRequest

​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.

EditCommissionRequest

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.

Commission

Detail servisní zakázky.
id
​integer
token
​string

Token pro veřejné zobrazení zakázky zákazníkovi, např. https://nokia.zaslat.cz/commissions/<token>.

type
​CommissionType · enum

Typ zakázky.

Enum values:
warranty
afterWarranty
number
​string
product_type_id
​integer

ID kategorie produktu (viz GET /product-type).

product_model
​string

Název modelu výrobku.

product_serial_number
​string
external_id
​string | null
status
​CommissionStatus · enum

Stav zakázky.

Enum values:
pending
incoming
processing
outgoing
finished
cancelled
substatus
​string | null
date_buy
​string · date
created
​string

Datum a čas vytvoření zakázky.

customer_id
​integer
​Address

Adresa zákazníka nebo servisního střediska (návratový tvar v detailu zakázky).

service_centre_id
​integer

Interní ID servisního střediska.

​Address

Adresa zákazníka nebo servisního střediska (návratový tvar v detailu zakázky).

​Activity[]
​Shipment[]

ActivityFile

name
​string
mime
​string
url
​string

Activity

Aktivita (zpráva nebo záznam o změně stavu) přiřazená k zakázce.
id
​integer
commission_id
​integer
commission_number
​string
type
​ActivityType · enum
Enum values:
message
status
created
​string
user_name
​string
is_internal
​integer · enum

0 – veřejná (viditelná i zákazníkovi), 1 – interní.

Enum values:
0
1
is_customer
​integer | null · enum

0 – od servisního střediska, 1 – od zákazníka.

Enum values:
0
1
message
​string

CreateActivityRequest

Alespoň jedno z polí `commission_id` nebo `commission_number` je povinné.
type
​ActivityType · enum · required
Enum values:
message
status
commission_id
​integer

Interní identifikátor existující zakázky (alternativa k commission_number).

commission_number
​string

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

is_internal
​integer · enum

0 – veřejná, 1 – interní.

Enum values:
0
1
user_name
​string

Jméno přispěvatele. Pokud není vyplněno, doplní se z popisu servisního centra.

message
​string

TrackingEvent

date
​string · date
time
​string
location
​string

Místo události (depo apod.).

name
​string

Popis události.

status
​string

Interní název stavu události.

Shipment

Zásilka přiřazená k zakázce (v návratovém tvaru).
id
​integer
commission_id
​integer
commission_number
​string
number
​string

Sledovací číslo v systému Zaslat.

number_carrier
​string | null

Sledovací číslo dopravce.

carrier
​string

Název dopravce.

type
​ShipmentDirection · enum
Enum values:
incoming
outgoing
collection
​Collection · enum

Číselník možností vyzvednutí zásilky.

Enum values:
pickup
dropoff
pickupPlace
collection_date
​string | null · date
status
​ShipmentStatus · enum

Stav zásilky. ⚠️ Zdrojová dokumentace uvádí pouze výčet hodnot bez popisu jednotlivých stavů.

Enum values:
pending
created
exported
onpickup
intransit
ondelivery
delivered
cancelled
​TrackingEvent[]
label
​string | null

Odkaz na stažení štítku k zásilce (pokud je vyžadován).

label_printed
​integer · enum

0 – nevytištěn, 1 – vytištěn.

Enum values:
0
1
​Address

Adresa zákazníka nebo servisního střediska (návratový tvar v detailu zakázky).

​Address

Adresa zákazníka nebo servisního střediska (návratový tvar v detailu zakázky).

cod
​number

Hodnota dobírky.

cod_currency
​string
cod_variable
​string | null

Variabilní symbol dobírky.

cod_bank_account_id
​integer | null
weight
​number
​

Chyba při exportu zásilky dopravci, pokud k selhání dojde.

created
​string

Datum a čas vytvoření zásilky.

ProductModel

id
​integer
value
​string

Název modelu.

​

Externí označení modelu (ID z externího systému, např. Matrix).

brand_code
​string
ean
​string

ProductTypeNode

Uzel stromu kategorií výrobků (rekurzivní struktura).
value
​string
label
​string
parent_id
​string | null

UploadFileResponse

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

ValidationErrorResponse

status
​integer
message
​string
​object[]
​object

U některých chyb (např. neoprávněná editace) obsahuje pole field/message přímo.

type
​string

Interní identifikátor typu výjimky.

CommissionType

string · enum
Enum values:
warranty
afterWarranty

Typ zakázky.

CommissionStatus

string · enum
Enum values:
pending
incoming
processing
outgoing
finished
cancelled

Stav zakázky.

RepairAnywayAction

string · enum
Enum values:
repairAnyway
returnBack
ask

Číselník: co udělat, pokud se na výrobek nevztahuje záruka. Určuje zákazník/objednatel služby při zaslání výrobku do servisu.

UnrepairableAction

string · enum
Enum values:
returnBack
dispose
ask

Číselník: co udělat, pokud je výrobek neopravitelný. Určuje zákazník/objednatel služby při zaslání výrobku do servisu.

Collection

string · enum
Enum values:
pickup
dropoff
pickupPlace

Číselník možností vyzvednutí zásilky.

Source

string · enum
Enum values:
public
client
admin
webform
api

Číselník kódů zdrojů vzniku zakázky. ⚠️ Dokumentován v Notionu jako samostatný číselník, ale nebyl přímo pozorován jako pole v odpovědi GET /commissions/{id} — pravděpodobně existuje jako vlastnost zakázky, ale jeho konkrétní umístění ve schématu nebylo ověřeno.

ActivityType

string · enum
Enum values:
message
status

ShipmentDirection

string · enum
Enum values:
incoming
outgoing

ShipmentStatus

string · enum
Enum values:
pending
created
exported
onpickup
intransit
ondelivery
delivered
cancelled

Stav zásilky. ⚠️ Zdrojová dokumentace uvádí pouze výčet hodnot bez popisu jednotlivých stavů.