CPL API
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
    • 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
    • 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

    ShipmentBatch

    Skupina metod ShipmentBatch slouží k vytváření, tisku a kontrole zásilek. Patří sem následující metody:
    POST shipment/batch
    GET /shipment/batch/{batchId}
    GET/shipment/batch/{batchId}/label
    PUT /shipment/batch/{batchId}
    V následujících tabulkách jsou uvedeny enumy které se používají v požadavcích nebo zobrazují odpovědích metod ShipmentBatch.

    Stavy importů#

    Stavy importů jsou zobrazovány v odpovědi na volání metody GET shipment/batch/{batchId} a vyjadřují stav vytvořené zásilky.
    NázevPopis
    AcceptedPožadavek přijat
    InProcessZpracovává se
    CompleteHotovo
    ErrorChyba

    ReturnChannelModel - Type#

    Tento enum se zadává do body metody POST shipment/batch kde se kódy zadávají do returnChannel.type.
    NázevKódPopis
    NoneVýstupem je URL
    EmailEmailVýstupem je email

    LabelSettingModel – Label format#

    Kódy z labelSettingsModel se zadávají do body metody POST shipment/batch v klíči labelSettings.format.
    NázevKódPopis
    PdfPdfPDF dokument
    ZplZplZPL instrukce
    JpegJpegJPEG obrázek
    SvgSvgGrafický soubor
    PngPngGrafický soubor

    Formát etiket#

    Formáty etiket se používají v metodě POST shipment/batch v klíči labelSettings.completeLabelSettings.pageSize kde určují formát etikety při tisku.
    NázevKódPopis
    None-Defaultním typem je 150x100
    DefaultDefaultDefaultním typem je 150x100
    Stránka A4A4Stránka A4 – možnost volit pozice 1-4 (position) Bez názvu.png

    Typy Adres#

    PopisKódPlatné pro produktPodmínka
    Adresa pro vrácení nedoručených zásilekBPBUSS, BUSD, DOPD, DOPD, COPL, BUED, PRIV,PRID, CONN, COND
    Adresa/služba pro vrácení return zásilekRETDPRIV, PRID, RETD, SMAR, SMADPouze s produkty PPL Parcel CZ Private + dob
    Adresa/služba pro vrácení Return connect zásilekRETCCONN, COND, SMEU, SMED, RECI, RECEPouze s produkty Parcel Connect
    Modified at 2025-02-03 13:50:32
    Previous
    Slouží k získání informací (trackingu) k zásilce
    Next
    Vytvoření zásilky
    Built with