CPL API
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
    • Úvod
    • Obecné
    • Tvorba zásilek a objednávek
    • Historie verzí
    • Autentizace
      • Získání Bearer tokenu
    • API Metody
    • Příklady požadavků a odpovědí
      • Vícekusá zásilka
      • Více zásilek v jednom požadavku
      • Zásilka do zahraničí s dobírkou i bez - balíky v sadě
      • Odpověď – vyzvednutí etiket (PDF A4) z GET shipment/batch/{batchId}/label
      • Odpověď – vyzvednutí etiket (ZPL)
      • Odpověď – vyzvednutí etiket (JPG)
    • Často kladené otázky
    • Postman kolekce

    Tvorba zásilek a objednávek

    Zásilky#

    Základní funkcí CPL API jsou operace se zásilkami. Zásilku je nejprve nutné vytvořit pomocí POST shipment/batch. Následně je možné vytisknout etiketu, upravit štítek, popřípadě získat stav zásilky. Po získání stavu zásilky (GET shipment/batch/{batchID}), je možné získat info k zásilce, doplnit některé informace k zásilce nebo zásilku vystornovat. Je také možné vytisknout zásilce etiketu, pomocí url uloženého v response body.
    shipment.png

    Objednávky#

    Další funkcí CPL API je vytváření objednávek. Objednávku je nejprve nutné vytvořit pomocí POST order/batch. Poté je možné získat, stav objednávky, informace k objednávce, popřípadě objednávku vystornovat. Objednávku lze vytvořit buď jako Objednávka svozu nebo jako Objednávka z libovolné adresy.
    objednavka.png

    Objednávka svozu#

    Popis:
    Standardní služba, kde PPL vyzvedne zásilky na registrované adrese odesílatele. Tato adresa je obvykle propojena s účtem zákazníka (např. firemní sídlo, sklad, výchozí místo).
    Využití:
    Vhodné pro pravidelné odesílatele, kteří odesílají zásilky z jednoho konkrétního místa.
    Proces:
    Svoz se objednává na určité časové okno (např. v odpoledních hodinách).
    Řidič přijede na předem známou adresu a vyzvedne zásilky.
    Flexibilita:
    Omezeno na jednu registrovanou adresu.
    Typická situace:
    Firma denně odesílá větší množství zásilek a potřebuje svoz z kanceláře či skladu.
    Definice v JSON:
    v JSON body metody order/batch je nutné definovat "orderType": "CollectionOrder"

    Objednávka z libovolné adresy#

    Popis:
    Rozšířená služba, která umožňuje PPL vyzvednout zásilku z jakékoliv adresy, kterou zákazník zadá.
    Využití:
    Ideální pro zákazníky, kteří nemají pevné místo odeslání (např. jednotlivci, menší firmy).
    Hodí se i pro jednorázové zásilky z adres mimo sídlo firmy
    Proces:
    Zákazník při objednávce zadá konkrétní adresu, kde se zásilka nachází, a řidič ji vyzvedne.
    Flexibilita:
    Možnost zadat různé adresy při každé objednávce.
    Výhodné, pokud se odesílání zásilek neomezuje na jednu lokalitu.
    Typická situace:
    Zásilka se odesílá přímo z místa bydliště nebo z místa, kde byla připravena (např. výrobce, třetí strana).
    Definice v JSON:
    v JSON body metody order/batch je nutné definovat "orderType": "TransportOrder"

    Hlavní rozdíly#

    ParametrObjednávka svozuObjednávka z libovolné adresy
    Místo VyzvednutíRegistrovaná adresaLibovolná adresa zadaná při objednávce
    FlexibilitaFixní adresaVariabilní adresa
    Typ zákazníkaPravidelní odesílateléObčasní či nepravidelní odesílatelé
    PoužitíOpakující se zásilkyJednorázové či ad-hoc zásilky
    Definice v JSONCollectionOrderTransportOrder
    Modified at 2025-02-28 17:29:11
    Previous
    Obecné
    Next
    Historie verzí
    Built with