CPL API
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. Codelist
  • 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
      GET
    • Číselník produktů
      GET
    • Číselník typů externích čísel
      GET
    • Číselník zemí + povolení COD
      GET
    • Číselník povolených měn
      GET
    • Metoda pro získání poskytovaných služeb k zásilkám.
      GET
    • Metoda pro získání minimálních a maximálních hodnot u služeb
      GET
    • Fáze zásilky
      GET
    • Statusy zásilky /shipment
      GET
    • Chybové hlášení
      GET
    • Typy osobních dokladů
      GET
  • 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
  • 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. Codelist

Statusy zásilky /shipment

GET
/codelist/status
Codelist
Maintainer:Not configured

Význam a použití#

Metoda codelist/status slouží k získání přehledu definovaných kódů a popisů, které v tomto případě označují stavy zásilek. Díky této metodě lze zjistit, jaké možné stavy se v systému PPL vyskytují (např. "Zásilka připravena k doručení", "Zásilka se dnes doručuje", "Nedoručeno - žádost odesílatele"). Tento číselník je možné využít především pro:
1. Zobrazení stavu zásilky v uživatelském rozhraní
Pokud je potřeba uživateli (nebo v administraci) ukázat stav balíku, ale zároveň chcete používat oficiální pojmenování od PPL, můžete si tato pojmenování načíst právě z codelist/status.
2. Integrace a mapování
V některých systémech (např. e-shop nebo ERP) již existují interní stavy objednávek (třeba Paid, Shipped, Delivered).
Propojení s PPL pak vyžaduje mapování PPL kódů na vaše interní kódy (pokud je chcete sjednotit).
Codelist/status pomůže, abyste znali všechny varianty stavů, se kterými se můžete setkat.

Request

Query Params
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 '/codelist/status?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:
code
string  | null 
optional
Kód
name
string  | null 
optional
Jméno
Example
[
  {
    "code": "string",
    "name": "string"
  }
]
🟠400Bad Request
🔴500Server Error
🔴503Service Unavailable
Previous
Fáze zásilky
Next
Chybové hlášení
Built with