CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. AccessPoint
  • Back to home
  • API Methods
  • AccessPoint
    • List of access points
      GET
  • AddressWhisper
    • Address Whisperer
  • Codelist
    • Codelist for the beneficiary's age verification service
    • Codelist product
    • Codelist externalNumbers
    • Codelist country + COD authorization
    • Codelist currency
    • Method for obtaining the services provided for shipments.
    • A method for obtaining minimum and maximum values ​​for services
    • Codelist shipment phase
    • Codelist status
    • Codelist of validation messages
    • Types of personal documents
  • Customer
    • Customer information - permitted currencies
    • Customer addresess
  • Data
    • Single label print
  • Info
    • /info
  • Order
    • Order tracking
  • OrderBatch
    • Create an order
    • Get order status
  • OrderEvent
    • Order cancel
  • Shipment
    • Shipment tracking
  • ShipmentBatch
    • Shipment creation
    • Used to modify the output format of the label.
    • Getting import state
    • Pick up label
  • ShipmentEvent
    • Shipment cancel
    • Adding informations to shipment
  • VersionInformation
    • News
  1. AccessPoint

List of access points

GET
/accessPoint
Maintainer:Not configured

Purpose and Usage#

The accessPoint method is used to obtain a list of pickup locations, also known as Access Points. Within the PPL context, these are referred to as ParcelShops and ParcelBoxes, where shipments can be delivered or dispatched.
It is primarily used for:
Displaying Pickup Location Options for Customers:
For example, in an e-shop where a customer can choose which branch (Access Point) they would like to have their shipment delivered to.
Automated Order Processing:
When creating a shipment in an ERP system or another e-commerce solution, it is necessary to programmatically select an appropriate or nearest pickup location based on customer data (postal code, address, etc.).

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:20:04
Previous
AccessPoint
Next
Address Whisperer