Balíkobot
Balíkobot
Rozšíření, které zajišťuje napojení na Balikobot, více zde.
Konfigurační soubor se standardně nachází v adresáři config/module-edeeshop/features/third-party/balikobot.xml.
Zkopírovat odkaz na sekciPříklad konfigurace
1 <balikobot>2 <instances>3 <instance>4 <userName>balikobot_test2cztest</userName>5 <apiKey>someApiKey</apiKey>6 <code/>7 <eidPrefix/>8 </instance>9 </instances>10 <allowedShippings>11 <shipping>12 <type>PPL</type>13 <serviceTypes>14 <serviceType>15 <serviceType/>16 <shippingCode/>17 <shippingType/>18 </serviceType>19 </serviceTypes>20 </shipping>21 </allowedShippings>22 <baseApiUrl>https://api.balikobot.cz/</baseApiUrl>23 <catalogSpecific>24 <catalogCode/>25 <instances>26 <instance>27 <userName>balikobot_test2cztest</userName>28 <apiKey>someApiKey</apiKey>29 <code/>30 <eidPrefix/>31 </instance>32 </instances>33 <allowedShippings>34 <shipping>35 <type>PPL</type>36 <serviceTypes>37 <serviceType>38 <serviceType/>39 <shippingCode/>40 <shippingType/>41 </serviceType>42 </serviceTypes>43 </shipping>44 </allowedShippings>45 </catalogSpecific>46</balikobot>
Zkopírovat odkaz na sekciPopis
Zkopírovat odkaz na sekcibalikobot
Konfigurace integrace se systémem Balíkobot.
Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| instances/instance | Seznam konfigurací pro jednotlivá napojení na Balíkobot. Standardně postačí pouze jedna instance. Pokud ale existuje více expedičních míst, je potřeba definovat v rámci Balikobotu pro každé expediční místo vlastní instanci (účet). Z tohoto důvodu je možné definovat více instancí, které lze použít pro komunikaci s Balikobotem. Každá instance je pak identifikována svým kódem. Projektově je pak možné určit, kterou instanci použít. Ve výchozím stavu se použije instance bez kódu. | List: instances/instance | - | - |
| allowedShippings/shipping | Seznam podporovaných doprav. | - | - | |
| baseApiUrl | Url, kde leží API Balíkobotu. Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde. | String | ✔ | https://api.balikobot.cz/ |
| catalogSpecific | Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde. | - | - |
Zkopírovat odkaz na sekciinstances/instance
Seznam konfigurací pro jednotlivá napojení na Balíkobot.
Standardně postačí pouze jedna instance. Pokud ale existuje více expedičních míst, je potřeba definovat v rámci Balikobotu pro každé expediční místo vlastní instanci (účet). Z tohoto důvodu je možné definovat více instancí, které lze použít pro komunikaci s Balikobotem. Každá instance je pak identifikována svým kódem.
Projektově je pak možné určit, kterou instanci použít. Ve výchozím stavu se použije instance bez kódu.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| userName | Přihlašovací jméno do Balíkobot API. Přihlašovací údaje se získají v klientské zóně – https://client.balikobot.cz) | String | ✔ | - |
| apiKey | Přihlašovací klíč do Balíkobot API. Přihlašovací údaje se získají v klientské zóně – https://client.balikobot.cz) | String | ✔ | - |
| code | Kód instance v případě, že je v rámci katalogu více instancí. Pokud je v rámci katalogu pouze jedna instance, je možné tento parametr vynechat. | String | - | - |
| eidPrefix | Prefix, který se odesílá jako součást eid. | String | - | - |
Zkopírovat odkaz na sekciallowedShippings/shipping
Seznam podporovaných doprav.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| type | Typ dopravce v Balikobotu. |
Typ ShippingType.GLS_PICKUP_POINT vyžaduje nastavené této služby na v Balíkobotu na .
| ✔ | - |
| serviceTypes/serviceType | Seznam typů služeb daného dopravce, které se odesílají do Balikobotu v atributu service_type. Seznam je pro každého dopravce jiný, případně může být prázdný. Službu lze případně konkretizovat pro konkrétní dopravu (kód) nebo dle typu dopravy. | List: serviceTypes/serviceType | - | - |
Zkopírovat odkaz na sekciserviceTypes/serviceType
Seznam typů služeb daného dopravce, které se odesílají do Balikobotu v atributu service_type.
Seznam je pro každého dopravce jiný, případně může být prázdný. Službu lze případně konkretizovat pro konkrétní dopravu (kód) nebo dle typu dopravy.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| serviceType | Kód služby dopravce. Povinná hodnota. Seznam povolených hodnot pro jednotlivé dopravy je možné získat zde: | ✔ | - | |
| shippingCode | Kód dopravy, pro který je služba určena. Pokud je null, pak je služba určena pro všechny dopravy. | String | - | - |
| shippingType | Typ dopravy, pro který je služba určena. Pokud je null, pak je služba určena pro všechny typy doprav (dává smysl pokud je pouze jeden typ dopravy). |
| - | - |
Zkopírovat odkaz na sekciserviceType
Kód služby dopravce.
Povinná hodnota.
Seznam povolených hodnot pro jednotlivé dopravy je možné získat zde: