CPL API
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. AccessPoint
  • Back to home
  • API Metody
  • AccessPoint
    • Seznam výdejních míst
      GET
  • 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
  • Data
    • data
  • 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. AccessPoint

Seznam výdejních míst

GET
/accessPoint
Maintainer:Not configured

Význam a použití#

Metoda accessPoint slouží k získání seznamu výdejních míst, tzv. Access Pointů a to v případě, že nechce zákazník využívat hotový mapový widget PPL
Pomocí této metody je možné získat následující typy výdejních míst, kam lze zásilky doručit, případně odkud je lze odeslat:
ParcelShopy
ParcelBoxy
AlzaBoxy
Používá se především k:
Zobrazení nabídky výdejních míst pro zákazníky, pomocí vlastních mapových podkladů
Například v e-shopu, kde si zákazník může vybrat, na kterou pobočku (Access Point) chce zásilku doručit.
Response totiž obsahuje mimo jiné GPS souřadnice, otevírací dobu a další potřebné informace ke každému výdejnímu místu.
Důležitou položkou je jedinečný identifikátor AccessPointCode, který se následně používá při vytváření štítků na vybrané výdejní místo.
Automatizované zpracování objednávek
Při tvorbě zásilky v ERP systému, nebo jiném e-commerce řešení je potřeba systémově vybrat vhodné nebo nejbližší výdejní místo na základě údajů o zákazníkovi (PSČ, adresa apod.).

Typy výdejních míst - accessPointTypes#

Typy výdejních míst jsou vraceny v odpovědi na volání metody GET accessPoint. Zadáním jejich kódu do query parametru requestu accessPoint lze vyfiltrovat požadovaná výdejní místa.
NázevKód
ParcelShopParcelShop
ParcelBoxParcelBox
AlzaBoxAlzaBox

Request

Query Params

Header Params

Request Code 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 '/accessPoint?AccessPointCode&CountryCode&ZipCode&City&AccessPointTypes&Radius&Latitude&Longitude&TribalServicePoint&ActiveCardPayment&ActiveCashPayment&PickupEnabled&Sizes&Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Responses

🟢200OK
application/json
Success
Headers

Body

Example
[
    {
        "accessPointCode": "string",
        "accessPointType": "None",
        "name": "string",
        "name2": "string",
        "street": "string",
        "city": "string",
        "country": "string",
        "zipCode": "string",
        "phone": "string",
        "email": "string",
        "tribalServicePoint": true,
        "activeCardPayment": true,
        "activeCashPayment": true,
        "pickupEnabled": true,
        "dimensionForced": true,
        "workHours": [
            {
                "weekDay": 0,
                "dayPart": 0,
                "openFrom": "string",
                "openTo": "string"
            }
        ],
        "accessPointNote": "string",
        "gps": {
            "latitude": 0,
            "longitude": 0
        },
        "capacitySettings": [
            {
                "size": "string",
                "capacity": 0,
                "length": 0,
                "height": 0,
                "width": 0
            }
        ]
    }
]
🟠400Bad Request
🟠405405
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-04-09 13:19:53
Previous
AccessPoint
Next
AddressWhisper