CPL API
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. Shipment
  • Back to home
  • API Metody
  • AccessPoint
    • Seznam výdejních míst
  • AddressWhisper
    • Našeptávač adres
  • Codelist
    • Číselník pro službu kontroly věku příjemce
    • Číselník produktů
    • Číselník typů externích čísel
    • Číselník zemí + povolení COD
    • Číselník povolených měn
    • Metoda pro získání poskytovaných služeb k zásilkám.
    • Metoda pro získání minimálních a maximálních hodnot u služeb
    • Fáze zásilky
    • Statusy zásilky /shipment
    • Chybové hlášení
    • Typy osobních dokladů
  • Customer
    • Informace k zákazníkovi – povolené měny
    • Zákazníkovy adresy
  • Info
    • info
  • Order
    • Získání informace o objednávce přepravy
  • OrderBatch
    • Slouží k vytvoření objednávky. Odpověď je v header (Location)
    • Získaní stavu objednávky
  • OrderEvent
    • Zrušení objednání svozu nebo balíku z libovolné adresy
  • Shipment
    • Slouží k získání informací (trackingu) k zásilce
      GET
  • ShipmentBatch
    • Vytvoření zásilky
    • Slouží k úpravě výstupního formátu štítku
    • Získání stavu importu zásilky
    • Získání etikety
  • ShipmentEvent
    • storno zásilky
    • úprava kontaktu
  • VersionInformation
    • informace o novinkách
  1. Shipment

Slouží k získání informací (trackingu) k zásilce

GET
/shipment
Shipment
Maintainer:Not configured

Request

Query Params
ShipmentNumbers
array[string]
optional
Čísla zásilek
<= 50 items
InvoiceNumbers
array[string]
optional
Čísla zakázek
<= 50 items
CustomerReferences
array[string]
optional
Zákaznická reference
<= 50 items
VariableSymbols
array[string]
optional
Variabilní symbol
<= 50 items
DateFrom
string <date-time>
optional
Datum od
DateTo
string <date-time>
optional
Datum do
ShipmentStates
enum<string> 
optional
Stavy zásilek
Allowed values:
NoneUndeliveredDeliveredPickedUpFromSenderDeliveredToPickupPointOutForDeliveryNotDeliveredCodPaidDateBackToSenderRejectedDataShipmentActiveCanceledDormant
Limit
integer <int32>
required
>= 1<= 1000
Offset
integer <int32>
required
>= 0
Header Params
Accept-Language
string 
optional
Language specification, default language: cs-CZ
X-Correlation-ID
string 
optional
Correlation Id of request
X-LogLevel
enum<string> 
optional
The forced log level
Allowed values:
TraceDebugInformationWarningErrorCritical

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/shipment?ShipmentNumbers&InvoiceNumbers&CustomerReferences&VariableSymbols&DateFrom&DateTo&ShipmentStates&Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Responses

🟢200OK
application/json
Success
Headers
X-Correlation-ID
string 
optional
Correlation Id of request otherwise id of response
X-Paging-Total-Items-Count
string 
optional
Total items in result
X-Paging-Offset
string 
optional
Paging offset
X-Paging-Limit
string 
optional
Page size
Body
array of:
shipmentNumber
string  | null 
optional
Číslo zásilky
productType
string  | null 
optional
Typ produktu viz /codelist/product
note
string  | null 
optional
Poznámka
depot
string  | null 
optional
Sklad
integratorId
integer <int32> | null 
optional
IntegratorId
lastUpdateDate
string <date-time> | null 
optional
Datum poslední aktualizace
shipmentState
enum<string> 
optional
Stav zásilky
Allowed values:
NoneUndeliveredDeliveredPickedUpFromSenderDeliveredToPickupPointOutForDeliveryNotDeliveredCodPaidDateBackToSenderRejectedDataShipmentActiveCanceledDormant
shipmentSet
optional
One of
masterShipmentNumber
string  | null 
optional
Číslo nosné zásilky
shipmentsInSet
integer <int32>
optional
Počet zásilek v sadě
shipmentInSetNumber
integer <int32>
optional
Pozice zásilky v sadě
sender
optional
Odesílatel
One of
name
string  | null 
optional
Jméno
name2
string  | null 
optional
street
string  | null 
optional
Ulice
city
string  | null 
optional
Město
zipCode
string  | null 
optional
PSČ
country
string  | null 
optional
Země
contact
string  | null 
optional
Kontakt
phone
string  | null 
optional
Telefon
email
string  | null 
optional
Email
recipient
optional
Příjemce
One of
AddressBaseModel
name
string  | null 
optional
Name
name2
string  | null 
optional
Name2
street
string  | null 
optional
Street
city
string  | null 
optional
City
zipCode
string  | null 
optional
ZipCode
country
string  | null 
optional
Country
contact
string  | null 
optional
Contact
phone
string  | null 
optional
Phone
email
string  | null 
optional
Email
specificDelivery
optional
Specifické požadavky na doručení
One of
specificDeliveryDate
string <date-time> | null 
optional
Specifické datum doručení
specificDeliveryTimeFrom
string <date-span> | null 
optional
Specifický čas doručení -Od
specificDeliveryTimeTo
string <date-span> | null 
optional
Specifický čas doručení -Do
specificTakeDate
string <date-time> | null 
optional
Specifické datum převzetí
specificTakeTimeFrom
string <date-span> | null 
optional
Specifické datum převzetí -Od
specificTakeTimeTo
string <date-span> | null 
optional
Specifické datum převzetí -Do
accessPointCode
string  | null 
optional
1.
ProductType pouze PRIV, PRID, CONN, COND, SMAR, SMAD !!
2.
Validace proti seznamu, který vrací metoda AccessPoint
externalNumbers
array [object {2}]  | null 
optional
Externí čísla
externalNumber
string  | null 
optional
Externí číslo
code
string  | null 
optional
Kód externího čísla
services
array [object {4}]  | null 
optional
Služby
additionalParameters
array [object]  | null 
optional
Další parametry
code
string  | null 
optional
Kód
price
number <double> | null 
optional
Cena
priceCurrency
string  | null 
optional
Měna
trackAndTrace
optional
Trackování zásilky
One of
externalShipmentId
string  | null 
optional
Externí číslo zásilky -platí pro zahraniční zásilky
partnerUrl
string  | null 
optional
Trackovací URL
lastEventCode
string  | null 
optional
Kód poslední události
lastEventDate
string <date-time> | null 
optional
Datum poslední události
lastEventName
string  | null 
optional
Jméno poslední události
events
array [object]  | null 
optional
události při trackování zásilky
shipmentWeightInfo
optional
Informace o hmotnosti
One of
weight
number <double> | null 
optional
hmotnost
weighedDate
string <date-time> | null 
optional
datum vážení
paymentInfo
optional
Informace o platbě
One of
paidByCard
boolean 
optional
true/false určení zda je platba kartou
codPaidDate
string <date-time> | null 
optional
datum zaplacení dobírky
invoiceNumber
string  | null 
optional
číslo faktury
bankAccount
string  | null 
optional
bankovní účet
bankCode
string  | null 
optional
bankovní kód
codBankStatementDate
string <date-time> | null 
optional
codCurrency
string  | null 
optional
měna dobírky
codPaymentAccDate
string <date-time> | null 
optional
codPrice
number <double> | null 
optional
cena
codVariableSymbol
string  | null 
optional
variabilní symbol dobírky
specificSymbol
string  | null 
optional
specifický symbol
deliveryFeature
optional
One of
loadDate
string <date-time> | null 
optional
Datum naložení zásilky pro doručení
delivDate
string <date-time> | null 
optional
Datum doručení
delivPerson
string  | null 
optional
Příjemce
notDelivDate
string <date-time> | null 
optional
Datum nedoručení
outDepDate
string <date-time> | null 
optional
Přijetí na doručovací depo
hubDate
string <date-time> | null 
optional
Příjem na centrálu
deliveryToAccessPoint
boolean 
optional
True/false určení zda bude zásilka doručena na výdejní místo
backShipmentFeature
optional
One of
backDate
string <date-time> | null 
optional
Datum odeslání zpět
dormantShipmentFeature
optional
One of
dormantShipmentNumber
string  | null 
optional
Číslo zpětné zásilky
dormantShipmentNumberActive
boolean  | null 
optional
true/false informuje zda je zpětná zásilka aktivní
accessPointFeature
optional
One of
accessPointDaysInStorage
integer <int32> | null 
optional
Počet dnů na výdejním místě
accessPointDaysInStorageRemain
integer <int32> | null 
optional
Počet zbyvajících dnů uložení zásilky na výdejním místě
accessPointHoursInStorageRemain
integer <int32> | null 
optional
Počet zbyvajících hodin uložení zásilky na výdejním místě
routingFeature
optional
One of
routingNumber
string  | null 
optional
Číslo trasy
Example
[
  {
    "shipmentNumber": "string",
    "productType": "string",
    "note": "string",
    "depot": "string",
    "integratorId": 0,
    "lastUpdateDate": "2019-08-24T14:15:22Z",
    "shipmentState": "None",
    "shipmentSet": {
      "masterShipmentNumber": "string",
      "shipmentsInSet": 0,
      "shipmentInSetNumber": 0
    },
    "sender": {
      "name": "string",
      "name2": "string",
      "street": "string",
      "city": "string",
      "zipCode": "string",
      "country": "string",
      "contact": "string",
      "phone": "string",
      "email": "string"
    },
    "recipient": {
      "name": "string",
      "name2": "string",
      "street": "string",
      "city": "string",
      "zipCode": "string",
      "country": "string",
      "contact": "string",
      "phone": "string",
      "email": "string"
    },
    "specificDelivery": {
      "specificDeliveryDate": "2019-08-24T14:15:22Z",
      "specificDeliveryTimeFrom": "string",
      "specificDeliveryTimeTo": "string",
      "specificTakeDate": "2019-08-24T14:15:22Z",
      "specificTakeTimeFrom": "string",
      "specificTakeTimeTo": "string",
      "accessPointCode": "string"
    },
    "externalNumbers": [
      {
        "externalNumber": "string",
        "code": "string"
      }
    ],
    "services": [
      {
        "additionalParameters": [
          {}
        ],
        "code": "string",
        "price": 0,
        "priceCurrency": "string"
      }
    ],
    "trackAndTrace": {
      "externalShipmentId": "string",
      "partnerUrl": "string",
      "lastEventCode": "string",
      "lastEventDate": "2019-08-24T14:15:22Z",
      "lastEventName": "string",
      "events": [
        {}
      ]
    },
    "shipmentWeightInfo": {
      "weight": 0,
      "weighedDate": "2019-08-24T14:15:22Z"
    },
    "paymentInfo": {
      "paidByCard": true,
      "codPaidDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "bankAccount": "string",
      "bankCode": "string",
      "codBankStatementDate": "2019-08-24T14:15:22Z",
      "codCurrency": "string",
      "codPaymentAccDate": "2019-08-24T14:15:22Z",
      "codPrice": 0,
      "codVariableSymbol": "string",
      "specificSymbol": "string"
    },
    "deliveryFeature": {
      "loadDate": "2019-08-24T14:15:22Z",
      "delivDate": "2019-08-24T14:15:22Z",
      "delivPerson": "string",
      "notDelivDate": "2019-08-24T14:15:22Z",
      "outDepDate": "2019-08-24T14:15:22Z",
      "hubDate": "2019-08-24T14:15:22Z",
      "deliveryToAccessPoint": true
    },
    "backShipmentFeature": {
      "backDate": "2019-08-24T14:15:22Z"
    },
    "dormantShipmentFeature": {
      "dormantShipmentNumber": "string",
      "dormantShipmentNumberActive": true
    },
    "accessPointFeature": {
      "accessPointDaysInStorage": 0,
      "accessPointDaysInStorageRemain": 0,
      "accessPointHoursInStorageRemain": 0
    },
    "routingFeature": {
      "routingNumber": "string"
    }
  }
]
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
🔴503Service Unavailable
Previous
Zrušení objednání svozu nebo balíku z libovolné adresy
Next
ShipmentBatch
Built with