Seznam výdejních míst

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ázev	Kód
ParcelShop	ParcelShop
ParcelBox	ParcelBox
AlzaBox	AlzaBox

Request

Query Params

AccessPointCode

string

optional

Kód Výdejního místa

CountryCode

string

required

Kód země viz. /codelist/country
Pokud chcete zobrazit access pointy pro jinou zemi než je ČR je nutné zadat countryCode, jinak se vám zobrazí access pointy pro ČR.

ZipCode

string

optional

PSČ

City

string

optional

Město

AccessPointTypes

array[string]

optional

Typ výdejního místa

Allowed values:

NoneParcelShopParcelBoxAlzaBox

Radius

integer <int32>

optional

Rádius (km)

Latitude

number <double>

optional

GPS souřanice

Longitude

number <double>

optional

GPS souřanice

TribalServicePoint

boolean

optional

Kmenové výdejní místo

ActiveCardPayment

boolean

optional

Možnost platby kartou

ActiveCashPayment

boolean

optional

Možnost platby v hotovosti

PickupEnabled

boolean

optional

Možnost podání zásilky

Sizes

array[string]

optional

Maximální hodnoty velikosti balíku: 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

Kód Výdejního místa

accessPointType

enum<string>

optional

Access point type

Allowed values:

NoneParcelShopParcelBoxAlzaBox

name

string | null

optional

Jméno

name2

string | null

optional

Name2

street

string | null

optional

Ulice

city

string | null

optional

Město

country

string | null

optional

Země

zipCode

string | null

optional

PSČ

phone

string | null

optional

Telefon

string | null

optional

tribalServicePoint

boolean

optional

Tribal service point

activeCardPayment

boolean

optional

Možnost platby kartou

activeCashPayment

boolean

optional

Možnost platby v hotovosti

pickupEnabled

boolean

optional

Možnost podání zásilky

dimensionForced

boolean

optional

Omezení rozměrů

workHours

array [object {4}] | null

optional

Otevírací doba

weekDay

integer <int32>

optional

pracovní dny (1 - Neděle, 7 - Sobota)

dayPart

integer <int32>

optional

Části pracovního dně (0 - ráno, 1 - odpoledne)

openFrom

string <date-span>

optional

Otevřeno od

openTo

string <date-span>

optional

Otevřeno do

accessPointNote

string | null

optional

AccessPointNote

gps

optional

One of

object

EmptyNullableObject

latitude

number <double> | null

optional

Zeměpisná šířka

longitude

number <double> | null

optional

Zeměpisná délka

capacitySettings

array [object {5}] | null

optional

Nastavení kapacity obchodu. Popisuje jaké rozměry zásilek dané výdejní místo přijímá

size

string | null

optional

velikost: S,M,XL...

capacity

integer <int32> | null

optional

Maximální kapacita

length

integer <int32>

optional

Délka

height

integer <int32>

optional

Výška

width

integer <int32>

optional

Šířka

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

Seznam výdejních míst

Význam a použití#

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

Request

Request samples

Responses

Význam a použití

Typy výdejních míst - accessPointTypes