List of access points

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

AccessPointCode

string

optional

AccessPointCode

CountryCode

string

required

country code viz. /codelist/country
If you want to display access points for a country other than the Czech Republic, you must enter the countryCode; otherwise, access points for the Czech Republic will be displayed.

ZipCode

string

optional

ZipCode

City

string

optional

City

AccessPointTypes

array[string]

optional

AccessPointTypes

Allowed values:

NoneParcelShopParcelBoxAlzaBox

Radius

integer <int32>

optional

Radius (km)

Latitude

number <double>

optional

GPS latitude

Longitude

number <double>

optional

GPS longitude

TribalServicePoint

boolean

optional

TribalServicePoint

ActiveCardPayment

boolean

optional

ActiveCardPayment

ActiveCashPayment

boolean

optional

ActiveCashPayment

PickupEnabled

boolean

optional

PickupEnabled

Sizes

array[string]

optional

sizes: S,M,L,XL

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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:

accessPointCode

string | null

optional

AccessPointCode

accessPointType

enum<string>

optional

Access point type

Allowed values:

NoneParcelShopParcelBoxAlzaBox

name

string | null

optional

Name

name2

string | null

optional

Name2

street

string | null

optional

Street

city

string | null

optional

City

country

string | null

optional

Country

zipCode

string | null

optional

ZipCode

phone

string | null

optional

Phone

string | null

optional

tribalServicePoint

boolean

optional

Tribal service point

activeCardPayment

boolean

optional

ActiveCardPayment

activeCashPayment

boolean

optional

Active cash payment

pickupEnabled

boolean

optional

Pickup enabled

dimensionForced

boolean

optional

Dimension forced

workHours

array[object (Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointWorkHourModel) {4}] | null

optional

WorkHours

weekDay

integer <int32>

optional

Access point work hour week day (1 - Sunday, 7 - Saturday)

dayPart

integer <int32>

optional

Access point work hour day part (0 - morning, 1 - afternoon)

openFrom

string <date-span>

optional

Access point work hour open from

openTo

string <date-span>

optional

Access point work hour open to

accessPointNote

string | null

optional

AccessPointNote

gps

optional

One of

Eps.Api.MyApi2.Web.Models.AccessPoint.CoordinatesModel

EmptyNullableObject

A model for displaying / forwarding GPS coordinates

latitude

number <double> | null

optional

Latitude

longitude

number <double> | null

optional

Longitude

capacitySettings

array[object (Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointCapacitySettingModel) {5}] | null

optional

CapacitySettings

size

string | null

optional

Size

capacity

integer <int32> | null

optional

Capacity

length

integer <int32>

optional

Length

height

integer <int32>

optional

Height

width

integer <int32>

optional

Width

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

List of access points

Purpose and Usage#

Request

Request samples

Responses

Purpose and Usage