Dopravy

Dopravy

Tato kapitola popisuje konfiguraci doprav, kterými lze objednávky doručit.

Upozornění: Při přidání nového způsobu doručení je třeba zajistit i správné mapování v XML feedech. Více informací naleznete v sekci Feedů a Konvertorů.

Zkopírovat odkaz na sekciPříklad konfigurace

xml
1 <order>2    <shipping>3        <availableShippings>4            <cPostPickupPoint>5                <sourceUrl>http://napostu.ceskaposta.cz/vystupy/napostu_1.xml</sourceUrl>6            </cPostPickupPoint>7            <cPostBalikovna>8                <sourceUrl>http://napostu.ceskaposta.cz/vystupy/balikovny.xml</sourceUrl>9            </cPostBalikovna>10            <cPost/>11            <sPostPickupPoint>12                <sourceUrl>https://www.posta.sk/public/forms/zoznam_post_bnp.xml</sourceUrl>13            </sPostPickupPoint>14            <sPostBalikobox>15                <sourceUrl>https://www.posta.sk/public/forms/zoznam_bboxov.xml</sourceUrl>16            </sPostBalikobox>17            <sPost/>18            <personalPickup/>19            <personalPickupAtPoint>20                <countries>21                    <country>22                        <code>CZ</code>23                    </country>24                </countries>25            </personalPickupAtPoint>26            <dpd/>27            <dpdPickupPoint>28                <countries>29                    <country>30                        <code>CZ</code>31                        <pickupNetworkTypes>32                            <pickupNetworkType/>33                        </pickupNetworkTypes>34                        <sourceUrl>https://pickup.dpd.cz/export/csv?country=203&amp;charset=utf-8</sourceUrl>35                    </country>36                </countries>37                <delimiter>,</delimiter>38                <sourceEncoding>utf-8</sourceEncoding>39            </dpdPickupPoint>40            <ppl/>41            <pplParcelShop>42                <accessPointTypes>43                    <accessPointType>ParcelShop</accessPointType>44                </accessPointTypes>45                <accessTokenUrl>https://api.dhl.com/ecs/ppl/myapi2/login/getAccessToken</accessTokenUrl>46                <clientId/>47                <clientSecret/>48                <countries>49                    <country>50                        <code>CZ</code>51                    </country>52                </countries>53                <importSourceUrl>https://api.dhl.com/ecs/ppl/myapi2/accessPoint</importSourceUrl>54            </pplParcelShop>55            <zasilkovna>56                <apiKey>123456789abcdef</apiKey>57                <boxSourceUrl>https://pickup-point.api.packeta.com/v5/{0}/box/json</boxSourceUrl>58                <branchSourceUrl>https://pickup-point.api.packeta.com/v5/{0}/branch/json</branchSourceUrl>59                <countries>60                    <country>61                        <code>CZ</code>62                    </country>63                </countries>64            </zasilkovna>65            <zasilkovnaToAddress/>66            <geis/>67            <gls/>68            <glsPickupPoint>69                <countries>70                    <country>71                        <code>CZ</code>72                        <sourceUrl>https://maps.gls-czech.cz/getDropoffPoints.php?ctrcode=CZ</sourceUrl>73                    </country>74                </countries>75            </glsPickupPoint>76            <oneDelivery/>77            <oneDeliveryPickupPoint>78                <clientId/>79                <clientSecret/>80                <sourceUrl>https://api.onedelivery.tech/parcels/points?country=CZ</sourceUrl>81            </oneDeliveryPickupPoint>82            <dbSchenker/>83            <dhl/>84            <email/>85            <other/>86        </availableShippings>87        <pricePolicies>88            <policyType/>89        </pricePolicies>90        <shippingPricePolicyPriority/>91        <catalogSpecific>92            <catalogCode/>93            <availableShippings>94                <cPostPickupPoint>95                    <sourceUrl>http://napostu.ceskaposta.cz/vystupy/napostu_1.xml</sourceUrl>96                </cPostPickupPoint>97                <cPostBalikovna>98                    <sourceUrl>http://napostu.ceskaposta.cz/vystupy/balikovny.xml</sourceUrl>99                </cPostBalikovna>100                <cPost/>101                <sPostPickupPoint>102                    <sourceUrl>https://www.posta.sk/public/forms/zoznam_post_bnp.xml</sourceUrl>103                </sPostPickupPoint>104                <sPostBalikobox>105                    <sourceUrl>https://www.posta.sk/public/forms/zoznam_bboxov.xml</sourceUrl>106                </sPostBalikobox>107                <sPost/>108                <personalPickup/>109                <personalPickupAtPoint>110                    <countries>111                        <country>112                            <code>CZ</code>113                        </country>114                    </countries>115                </personalPickupAtPoint>116                <dpd/>117                <dpdPickupPoint>118                    <countries>119                        <country>120                            <code>CZ</code>121                            <pickupNetworkTypes>122                                <pickupNetworkType/>123                            </pickupNetworkTypes>124                            <sourceUrl>https://pickup.dpd.cz/export/csv?country=203&amp;charset=utf-8</sourceUrl>125                        </country>126                    </countries>127                    <delimiter>,</delimiter>128                    <sourceEncoding>utf-8</sourceEncoding>129                </dpdPickupPoint>130                <ppl/>131                <pplParcelShop>132                    <accessPointTypes>133                        <accessPointType>ParcelShop</accessPointType>134                    </accessPointTypes>135                    <accessTokenUrl>https://api.dhl.com/ecs/ppl/myapi2/login/getAccessToken</accessTokenUrl>136                    <clientId/>137                    <clientSecret/>138                    <countries>139                        <country>140                            <code>CZ</code>141                        </country>142                    </countries>143                    <importSourceUrl>https://api.dhl.com/ecs/ppl/myapi2/accessPoint</importSourceUrl>144                </pplParcelShop>145                <zasilkovna>146                    <apiKey>123456789abcdef</apiKey>147                    <boxSourceUrl>https://pickup-point.api.packeta.com/v5/{0}/box/json</boxSourceUrl>148                    <branchSourceUrl>https://pickup-point.api.packeta.com/v5/{0}/branch/json</branchSourceUrl>149                    <countries>150                        <country>151                            <code>CZ</code>152                        </country>153                    </countries>154                </zasilkovna>155                <zasilkovnaToAddress/>156                <geis/>157                <gls/>158                <glsPickupPoint>159                    <countries>160                        <country>161                            <code>CZ</code>162                            <sourceUrl>https://maps.gls-czech.cz/getDropoffPoints.php?ctrcode=CZ</sourceUrl>163                        </country>164                    </countries>165                </glsPickupPoint>166                <oneDelivery/>167                <oneDeliveryPickupPoint>168                    <clientId/>169                    <clientSecret/>170                    <sourceUrl>https://api.onedelivery.tech/parcels/points?country=CZ</sourceUrl>171                </oneDeliveryPickupPoint>172                <dbSchenker/>173                <dhl/>174                <email/>175                <other/>176            </availableShippings>177            <pricePolicies>178                <policyType/>179            </pricePolicies>180            <shippingPricePolicyPriority/>181        </catalogSpecific>182    </shipping>183</order>

Zkopírovat odkaz na sekciPopis

Zkopírovat odkaz na sekciorder/shipping

Konfigurace způsobů doručení (doprav).

Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
availableShippings

Seznam povolených typy doprav.

Povolením dopravy je možné následně v AR vytvořit dopravu daného typu.

List: availableShippings

-

-

pricePolicies/policyType

Konfigurace cenových politik pro dopravy.

Pomocí cenové politiky lze definovat speciální cenu za dopravu pro daný košík, například doprava zdarma pro objednávky nad 10tis Kč.

Nastavením této hodnoty se určuje, které politiky budou povoleny a tedy, které politiky bude možné nastavit v AR u doprav.

V základu jsou implementovány tyto cenové politiky:

  • tagRuleShippingPricePolicy - Cena dopravy podle produktů v košíku (více zde).
  • totalOrderShippingPricePolicy - Cena dopravy podle výše objednávky (více zde).

Pro nový typ politiky je nutné:

  1. Definovat parametry nové cenové politiky (viz )
  2. Implementovat , pro zpracované nového typu.
  3. Implementovat , který dokáže parametry vypsat a načíst z AR formuláře.
  4. Definovat admin rozhraní pro nový typ politiky (viz 'shippingDictionaryAdmin.xml')

List: String

-

-

shippingPricePolicyPriority

Priorita pro cenové politiky doprav.

Tato priorita určuje pořadí v jakém se cenové politiky pro dopravy aplikují vůči ostatním skupinám cenových politik (např. kredity, slevové akce apod.).

Priorita mezi jednotlivými politikami této skupiny se pak určuje přímo na entitě dané politiky.

long

-

0

catalogSpecific

Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.

-

-

Zkopírovat odkaz na sekciavailableShippings

Seznam povolených typy doprav.

Povolením dopravy je možné následně v AR vytvořit dopravu daného typu.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
cPostPickupPoint

Česká pošta - Balík Na poštu. Vyžaduje výběr odběrného místa.

cPostPickupPoint

-

-

cPostBalikovna

Česká pošta - Balík do balíkovny. Vyžaduje výběr odběrného místa.

cPostBalikovna

-

-

cPost

Česká pošta - Balík Do ruky.

String

-

-

sPostPickupPoint

Slovenska pošta - Balík na poštu. Vyžaduje výběr odběrného místa.

sPostPickupPoint

-

-

sPostBalikobox

Slovenska pošta - Balík do BalíkoBOXu. Vyžaduje výběr odběrného místa.

sPostBalikobox

-

-

sPost

Slovenska pošta - Balík na adresu

String

-

-

personalPickup

Osobní odběr bez výběru odběrného místa. Vhodné např. pro případy, kdy existuje pouze jedno odběrné místo.

String

-

-

personalPickupAtPoint

Osobní odběr s výběrem odběrného místa. Odběrná místa se definují v AR.

personalPickupAtPoint

-

-

dpd

DPD.

String

-

-

dpdPickupPoint

DPD Pickup Point. Vyžaduje výběr odběrného místa.

dpdPickupPoint

-

-

ppl

PPL.

String

-

-

pplParcelShop

PPL ParcelShop. Vyžaduje výběr odběrného místa.

pplParcelShop

-

-

zasilkovna

Zásilkovna. Vyžaduje výběr odběrného místa.

zasilkovna

-

-

zasilkovnaToAddress

Zásilkovna - doručení na adresu https://www.zasilkovna.cz/domu.

String

-

-

geis

GEIS.

String

-

-

gls

GLS

String

-

-

glsPickupPoint

GLS ShopDeliveryService (doručení do výdejního místa)

https://docs.gls-czech.cz/index.php/api-shop-delivery-service

glsPickupPoint

-

-

oneDelivery

One by Allegro - doručení na adresu (OneDelivery)

String

-

-

oneDeliveryPickupPoint

One by Allegro - výdejní místa (OneDelivery). Vyžaduje výběr odběrného místa.

oneDeliveryPickupPoint

-

-

dbSchenker

DB Schenker

String

-

-

dhl

DHL

String

-

-

email

Typ dopravy, kdy není nutné dopravit zboží fyzicky, ale posílá se emailem.

Například zakoupené dárkové poukazy.

String

-

-

other

Jiný dopravce (např. doprava do zahraničí)

String

-

-

Zkopírovat odkaz na sekcicPostPickupPoint

VlastnostPopisHodnotaPovinnáVýchozí hodnota
sourceUrl

Url zdroje s odběrnými místy České Pošty, kam lze zaslat "Balík Na poštu".

Default hodnota: http://napostu.ceskaposta.cz/vystupy/napostu_1.xml.

String

-

http://napostu.ceskaposta.cz/vystupy/napostu_1.xml

Zkopírovat odkaz na sekcicPostBalikovna

VlastnostPopisHodnotaPovinnáVýchozí hodnota
sourceUrl

Url zdroje s odběrnými místy České Pošty, kam lze zaslat "Balík da balíkovny".

Default hodnota: http://napostu.ceskaposta.cz/vystupy/balikovny.xml.

String

-

http://napostu.ceskaposta.cz/vystupy/balikovny.xml

Zkopírovat odkaz na sekcisPostPickupPoint

VlastnostPopisHodnotaPovinnáVýchozí hodnota
sourceUrl

Url zdroje s odběrnými místy.

Default hodnota https://www.posta.sk/public/forms/zoznam_post_bnp.xml.

String

-

https://www.posta.sk/public/forms/zoznam_post_bnp.xml

Zkopírovat odkaz na sekcisPostBalikobox

VlastnostPopisHodnotaPovinnáVýchozí hodnota
sourceUrl

Url zdroje s odběrnými místy.

Default hodnota https://www.posta.sk/public/forms/zoznam_bboxov.xml.

String

-

https://www.posta.sk/public/forms/zoznam_bboxov.xml

Zkopírovat odkaz na sekcipersonalPickupAtPoint

VlastnostPopisHodnotaPovinnáVýchozí hodnota
countries/country

Seznam zemí, které lze použít v adrese pobočky k osobnímu odběru.

Pokud není zadáno, tak výchozí hodnota je CZ.

List: countries/country

-

-

Zkopírovat odkaz na sekcicountries/country

Seznam zemí, které lze použít v adrese pobočky k osobnímu odběru.

Pokud není zadáno, tak výchozí hodnota je CZ.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
code

Kód země. (ISO 3166 - 2 znaky)

String

-

-

Zkopírovat odkaz na sekcidpdPickupPoint

VlastnostPopisHodnotaPovinnáVýchozí hodnota
countries/country

Seznam zemí, pro které chceme importovat odběrná místa, včetně další konfigurace platnou pro danou zemi.

List: countries/country

-

-

delimiter

Oddělovač jednotlivých hodnot ve zdrojovém souboru.

Default hodnota je , (čárka).

char

-

,

sourceEncoding

Kódování zdrojového souboru.

Default hodnota je utf-8.

String

-

utf-8

Zkopírovat odkaz na sekcicountries/country

Seznam zemí, pro které chceme importovat odběrná místa, včetně další konfigurace platnou pro danou zemi.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
code

Kód země. (ISO 3166 - 2 znaky)

String

-

-

pickupNetworkTypes/pickupNetworkType

Určuje jaký typ odběrných míst se má importovat.

Default hodnota je null a znamená, že odběrná místa se nefiltrují.

Povolené hodnoty jsou pickup_point nebo dpd_box.

String

-

-

sourceUrl

Url zdroje s odběrnými místy.

Pokud není uvedeno, tak se pro jednotlivé země použijí tyto URL:

Pro ostatní země nejsou defaultní hodnoty uvedeny. Pro ostatní země se bude hodnota lišit parametrem country. Je to kód země numerická varianta (dle normy ISO 3166-1). Více viz https://pickup.dpd.cz/integrace/.

String

-

-

Zkopírovat odkaz na sekcipplParcelShop

VlastnostPopisHodnotaPovinnáVýchozí hodnota
accessPointTypes/accessPointType

Povolené typy odběrných míst, které se budou importovat.

Možné hodnoty:

  • ParcelShop,
  • Parcelbox,
  • Alzabox.

Pokud není uvedeno, tak se importují všechny typu.

String

-

-

accessTokenUrl

Url pro získání OAuth 2.0 access tokenu.

String

-

https://api.dhl.com/ecs/ppl/myapi2/login/getAccessToken

clientId

Přístupové údaje PPL API pro získání access tokenu.

Údaje dodá zákazník a získa je od PPL.

String

-

-

clientSecret

Přístupové údaje PPL API pro získání access tokenu.

Údaje dodá zákazník a získa je od PPL.

String

-

-

countries/country

Seznam zemí (přesněji kód, ISO 3166 - 2 znaky), pro které se mají importovat dané pobočky, včetně další konfigurace platnou pro danou zemi.

Pokud není uvedeno, tak se importují "CZ pobočky (výchozí chování externího api).

List: countries/country

-

-

importSourceUrl

Adresa, na které PPL poskytuje údaje o odběrných místech. Pro změnu v případě, že ppl adresu časem změní.

String

-

https://api.dhl.com/ecs/ppl/myapi2/accessPoint

Zkopírovat odkaz na sekcicountries/country

Seznam zemí (přesněji kód, ISO 3166 - 2 znaky), pro které se mají importovat dané pobočky, včetně další konfigurace platnou pro danou zemi.

Pokud není uvedeno, tak se importují "CZ pobočky (výchozí chování externího api).

VlastnostPopisHodnotaPovinnáVýchozí hodnota
code

Kód země. (ISO 3166 - 2 znaky)

String

✔

-

Zkopírovat odkaz na sekcizasilkovna

VlastnostPopisHodnotaPovinnáVýchozí hodnota
apiKey

Api klíč pro přístup k API Zásilkovny.

Hodnotu apiKey získá klient při registraci k Zásilkovně.

String

-

-

boxSourceUrl

Url zdroje s odběrnými místy.

Očekávaný formát zdroje je json a standardně hodnota je ve tvaru https://pickup-point.api.packeta.com/v5/{0}/box/json.

Kde za {0} se dosadí hodnota apiKey.

String

-

https://pickup-point.api.packeta.com/v5/{0}/box/json

branchSourceUrl

Url zdroje s odběrnými místy.

Očekávaný formát zdroje je json a standardně hodnota je ve tvaru https://pickup-point.api.packeta.com/v5/{0}/branch/json.

Kde za {0} se dosadí hodnota apiKey.

String

-

https://pickup-point.api.packeta.com/v5/{0}/branch/json

countries/country

Seznam zemí, pro které se mají importovat odběrná místa dané(ných) země (zemí). Pokud není uvedeno, importují se všechny pobočky všech zemí.

List: countries/country

-

-

Zkopírovat odkaz na sekcicountries/country

Seznam zemí, pro které se mají importovat odběrná místa dané(ných) země (zemí). Pokud není uvedeno, importují se všechny pobočky všech zemí.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
code

Kód země. (ISO 3166 - 2 znaky)

String

✔

-

Zkopírovat odkaz na sekciglsPickupPoint

VlastnostPopisHodnotaPovinnáVýchozí hodnota
countries/country

Seznam zemí, pro které se mají importovat dané pobočky, včetně další konfigurace platnou pro danou zemi.

List: countries/country

-

-

Zkopírovat odkaz na sekcicountries/country

Seznam zemí, pro které se mají importovat dané pobočky, včetně další konfigurace platnou pro danou zemi.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
code

Kód země. (ISO 3166 - 2 znaky)

String

-

-

sourceUrl

Url zdroje s odběrnými místy.

Pokud není hodnota uvedena použije se default hodnota, která je vyhodnocena z šablony https://maps.gls-czech.cz/getDropoffPoints.php?ctrcode={country}.

String

-

-

Zkopírovat odkaz na sekcioneDeliveryPickupPoint

VlastnostPopisHodnotaPovinnáVýchozí hodnota
clientId

ID klienta pro přístup k API OneDelivery.

Standardně dodí klient po dohodě s OneDelivery (One by Allegro).

String

-

-

clientSecret

Tajný klíč (heslo) klienta pro přístup k API OneDelivery.

Standardně dodí klient po dohodě s OneDelivery (One by Allegro).

String

-

-

sourceUrl

URL zdroje pro import odběrných míst.

Výchozí hodnota je nastavena na veřejné API OneDelivery (One by Allegro) pro Českou republiku.

Dokumentace k EP je dostupná na: https://api.onedelivery.tech/parcels/swagger.html#/points-endpoint/getPoints

String

-

https://api.onedelivery.tech/parcels/points?country=CZ

Zkopírovat odkaz na sekciPřidání nového typu dopravy

Projektové lze přidávat i další typy doprav. Jak na to je popsáno zde.