List of access points
GET
/accessPoint
AccessPoint
Purpose and Usage
For example, in an e-shop where a customer can choose which branch (Access Point) they would like to have their shipment delivered to.
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 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;'Response Response Example
200 - Example 1
[
{
"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
}
]
}
]Request
Query Params
AccessPointCode
string
optional
CountryCode
string
required
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
City
string
optional
AccessPointTypes
array[string]
optional
Allowed values:
NoneParcelShopParcelBoxAlzaBox
Radius
integer <int32>
optional
Latitude
number <double>
optional
Longitude
number <double>
optional
TribalServicePoint
boolean
optional
ActiveCardPayment
boolean
optional
ActiveCashPayment
boolean
optional
PickupEnabled
boolean
optional
Sizes
array[string]
optional
Limit
integer <int32>
required
>= 1<= 1000
Offset
integer <int32>
required
>= 0
Header Params
Accept-Language
string
optional
X-Correlation-ID
string
optional
X-LogLevel
enum<string>
optional
Allowed values:
TraceDebugInformationWarningErrorCritical