Schemas

Download schema

CreateShipmentRequest

object

Sender address. Omitted → filled from the account default sender.

object

Recipient address

array | null

Packages. Omitted → filled from the account default package.

pickupBranch

string | null

Code of the pickup branch (parcel point where the sender drops off the shipment), or "1" to use the account default pickup branch. Requires carrierCode.

Example: CZ10037

deliveryBranch

string | null

Code of the delivery branch (parcel point where the recipient collects the shipment). Requires carrierCode.

Example: CZ10046

autoDeliveryBranch

boolean | null

Automatically pick the nearest delivery point to the recipient address

serviceId

integer | null

Service (tariff) ID. Omitted → cheapest selectable service is chosen automatically.

referenceNumber

string | null

Reference number / variable symbol

Example: OBJ-2026-0001

currency

string | null

Currency

Example: CZK

carrierCode

string | null

Carrier code

Example: DPD

type

string | null · enum

Pickup type

Enum values:

ONDEMAND

REGULAR

OCCASIONAL

Example: ONDEMAND

pickupDate

string | null · Y-m-d

Pickup date (Y-m-d), must not be in the past

Example: 2030-06-22

fromTime

string | null · H:i

Earliest pickup time (H:i)

Example: 10:00

array | null

Shipment-level additional services

object

Customs declaration (for international shipments)

CreateShipmentResponse

id

integer · required

ID of the created draft shipment

Example: 42

source

string · required

Shipment source

Example: API

referenceNumber

string | null · required

Reference number / variable symbol, echoed back

Example: OBJ-2026-0001

errors

required

Business validation messages; null when the draft is valid

rates

required

Computed price offers; null until the async quote job finishes

modified

string · required

Last modification timestamp (Y-m-d H:i:s)

Example: 2026-06-18 10:30:00

ProblemResponse

message

string · required

object[]

CancelRequest

carrier

string · enum · required

Valid carrier code.

Enum values:

dpd

gls

gls-sk

liftago

toptrans

ups

wedo

ppl

date

string · Y-m-d · required

RunIntegrationsResponse

integrationsCount

integer · required

Number of active e-shop integrations that were run

Example: 2

integrationsFailedCount

integer · required

Number of integrations whose run failed, e.g. because the e-shop was unreachable or refused the connection; details are available in the integration log in the client zone

Example: 0

importedShipmentsCount

integer · required

Total number of new orders downloaded and saved as draft shipments into the shipment cart

Example: 5

CreateHandoverRequest

shipments

string[] · minItems: 1 · maxItems: 500 · required

Zaslat tracking numbers of the shipments the courier will pick up together. All shipments must belong to your account, be carried by Zásilkovna and already have a Zásilkovna packet number. Between 1 and 500 items, e.g. ["IZ3F9A2C71B4", "IZ8D01E6F2A9"].

format

string · enum

Output format: PDF (default) returns a printable A4 handover sheet, JSON returns the batches as JSON.

Enum values:

PDF

JSON

Example: PDF

HandoverResponse

object[] · required

Handover batches with barcodes. Shipments that were already in a batch keep their original barcode, newly added shipments get a new batch, so the courier may need to scan more than one code.

object[] · required

Shipments Zásilkovna refused to include (already handed over or returns). Empty when everything was accepted.