Automatické spracovanie objednávok
a prepojenie s iným systémom (účtovníctvo, CRM ..)

Automatický import stavov objednávok do internetového obchodu systému ClickEshop a export objednávok do účtovného alebo výrobného systému.

Automatizované prepojenia prebiehajú na pozadí plne autonómne, bez zásahu človeka kde sa posielajú alebo prijímajú údaje, a tým sú schopné nahradiť niektoré monotónne operácie, ako napríklad každodenný import / export objednávok do internetového obchodu. Neexistencia duplicitných procesov so sebou prináša ušetrené prostriedky na obsluhu internetového obchodu, ale pomáha aj vyvarovať sa zbytočným chybám v podobe nepresných informácií a následnému sklamaniu zákazníka. Automatizovaný import / export objednávok zabezpečí pravidelnú aktualizáciu objednávok v internetovom obchode alebo v externých systémoch bez ohľadu na to či ste ako administrátor do internetového obchodu vstúpili.

1 AUTOMATIZOVANÝ EXPORT OBJEDNÁVOK

Automatizovaný export je možné využiť pri automatickom spracovaní objednávok z internetového obchodu, ktoré sa exportujú do účtovných, výrobných, expedičných alebo logistických systémov.

1.1 Architektúra riešenia

Celé riešenie je založené na možnosti naplánovať vlastný automatizovaný export za predpokladu dodržania
stanovených podmienok:

vopred si vybrať správny typ formátu pre export (export _format)
pripraviť vlastný spúšťací skript s autentifikáciou, ktorý bude volať API rozhranie na strane webshopu "Automatizovaný export objednávok"
naplánovať automatizované spúšťanie vlastného scriptu, ktorý bude volať API. Plánovanie volania API je potrebné nastaviť v jednotlivých časových intervaloch, napr. volať API každú 1 hodinu pre stiahnutie objednávok.

Order export

1.2 API rozhranie

slúži na automatické spracovanie XML súboru ( export XML súboru s informáciami o objednávkach) pri prepojení ClickEshopu s inými systémami. Na API rozhranie je možné naprogramovať vlastnú užívateľskú aplikáciu.

Cesta k API rozhraniu na automatizovaný export objednávok:

https://api.clickeshop.sk/export_orders/

Metóda volania: Rest API HTTP POST

XML súbor bude exportovaný ako komprimovaný XML súbor vo formáte ZIP.

API parametre pre export objednávok (použitie metódou HTTP POST / HTTP GET)

Názov parametra	Povinný parameter	Popis
login	Áno	Postup na vytvorenie login je nasledovný: 1) Prihlásiť sa do administrácie daného eshopu 2) Zvoliť sekciu "Globálne nastavenia / Užívatelia" 3) Vyplniť “Email užívateľa:” 4) Rola “STANDARD” Oprávnenia: žiadne ! 5) Uložiť Na zaregistrovaný mail príde heslo
password	Áno	Po vložení nového užívateľa v sekcii "Globálne nastavenia / Užívatelia" príde na zaregistrovaný mail nové heslo, ktoré sa použije pri autentifikácii
id_project	Áno	Treba požiadať podporu o pridelenie ID. Požiadavka musí byť zaslaná z kontaktného formulára priamo z administrácie eshopu "Pomoc / Zákaznícka podpora"
stateId	Nie	Ktoré ID stavu objednávky sa májú exportovať. Štandardne sa exportujú iba objednávky v stave Nová (stateId = 1). V prípade viacerých stavov sa tieto oddeľujú bodkočiarkou napr. stavy 1;3;8 ID stavov objednávok je možné získať zo zoznamu dokladov a to po prihlásení do clickeshop administrácie daného internetového obchodu / Globálne nastavenia / Úprava textov / Stavy dokladov. V tejto sekcii nájdete stavy všetky objednávok, ktoré si môžete nastavovať. Po rozkliknutí nejakého stavu napr. "storno" sa zobrazí formulár na nastavovanie konkrétneho stavu dokladu a následne v URL linke internetového prehliadača hľadajte parameter id=4, čo je ID stavu dokladu ( stavu objednávky )
export _format	Áno	Nadobúda hodnoty XML-CLICKESHOP - štruktúra pre import objednávok podporovaná ClickEshopom. Odporúčaný formát pre import objednávok do vlastných systémov. príklad: https://clickeshop.com/admin_eshop/batch/eshop_orders-yyyy-mm-dd.xml XML-MONEY-ORDERS - štruktúra pre import objednávok vo formáte XML pre účtovný systém (Money) XML-MONEY-INVOICES - štruktúra pre import faktúr vo formáte XML pre účtovný systém (Money) CSV-OMEGA-ORDERS - štruktúra pre import objednávok vo formáte CSV pre účtovný systém (Omega Kros) MRP-ORDERS - štruktúra pre import objednávok vo formáte XML pre účtovný systém (MRP) MRP-INVOICES - štruktúra pre import faktúr vo formáte XML pre účtovný systém (MRP) POHODA-ORDERS - štruktúra pre import objednávok vo formáte XML pre účtovný systém (Pohoda)

1.3 Výpis spracovania dát ( log )

Výsledok log zo spracovania automatického exportu bude prístupný v sekcii: Globálne nastavenia / Hromadný import
Zaznamenaný a zobrazený je posledný log z exportu.

1.4 Obmedzenia

V reálnom čase je možné spracovávať naraz len jednu požiadavku na export.
API je možné volať maximálne 60 krát za 1 konkrétny deň pre jeden projekt
API je možné volať maximálne 1 krát za 1 minútu
API je možné volať iba cez šifrované spojenie SSL https:
Exportujú sa iba objednávky podľa stavov zasielaných ako vstupné parametre a to najviac 60 dní staré
( aktuálny deň mínus 60 dní )

1.5 Chybové stavy

Server odpoveď na output:
{"result":"ERR"} – Chyba, akcia sa nevykonala
{"result":"OK"} – Akcia sa vykonala

Server odpoveď v HTTP header ( HTTP Status Codes ):
200 – request success
400 – error, bad request

1.6 Vzor testovacieho HTML formulára

Pre produkčné účely odporúčame vytvoriť si jednoduchú .NET aplikáciu na HTTP post parametrov( kód na pár riadkov). Pre produkčnú prevádzku sa taktiež dá použiť open-source aplikácia CURL, ktorá sa zavolá cez parametre a táto vie postnúť kompresovaný XML súbor i s danými parametrami na server clickeshop. Viac informácií o použití CURL v kapitole "3 Príklad použitia volania API cez aplikáciu CURL".

1.6.1 Predpripravený ONLINE testovací formulár

Pre testovacie účely stačí pre HTTP post nasledovný HTML formulár:
https://clickeshop.sk/admin_eshop/batch/test-export_orders.html

Pre zjednodušenie implementácie odporúčame pozrieť zdrojový kód HTML testovacieho formulára.

2 AUTOMATIZOVANÝ IMPORT STAVOV OBJEDNÁVKY

Automatizovaný import je možné využiť pri zmene stavov objednávok, ktoré sa importujú do internetového obchodu (webshopu) z účtovných, výrobných, expedičných alebo logistických systémov.

Pre plnohodnotné prepojenie objednávok medzi webshopom a externým systémom odporúčame implementovať aj túto časť. Objednávky z časti "1 AUTOMATIZOVANÝ EXPORT OBJEDNÁVOK", ktoré sme úspešne spracovali do externého systému je následne potrebné označiť vo webshope stavom "prebraná". Týmto zabezpečíme, že pri ďalšom spracovaní objednávok z časti "1 AUTOMATIZOVANÝ EXPORT OBJEDNÁVOK" budeme spracovávať vždy iba prírastok s novými objednávkami.

2.1 Architektúra riešenia

Celé riešenie je založené na možnosti naplánovať vlastný automatizovaný import za predpokladu dodržania
stanovených podmienok:

export objednávok z časti "1 AUTOMATIZOVANÝ EXPORT OBJEDNÁVOK"
príprava a spracovanie XML feedu do predpísanej XML štruktúry. XML feed má obsahovať zoznam objednávok, ktoré sme úspešne spracovali do externého systému( napr. účtovného systému ) z časti "1 AUTOMATIZOVANÝ EXPORT OBJEDNÁVOK"
pripraviť vlastný spúšťací skript s autentifikáciou, ktorý bude volať API rozhranie na strane webshopu "Automatizovaný import stavov objednávok"
naplánovať automatizované spúšťanie
po úspešnom volaní API "2 AUTOMATIZOVANÝ IMPORT STAVOV OBJEDNÁVKY" systém zmení stav objednávok zo stavu "Nová" na stav "Prebraná"

import order statuses

2.2 Požiadavky na štruktúru XML feedu

Systém podporuje automatický import stavov objednávok za predpokladu dodržania štandardnej štruktúry XML
feedu.

Kódovanie = UTF-8
Vzor šablóny XML feedu pre import (upload):

<?xml version="1.0"?>
<datapack date="2016-01-14 13:27:10" project="www.myeshop.clickeshop.com">
   <order id="20105816">
      <stateId>1</stateId>
      <sendEmail>1</sendEmail>
      <sendDocument>1</sendDocument>
      <orderDescr><![CDATA[postou pod podacim cislo 70112399/895]]></orderDescr>
   </order>
   <order id="20105815">
      <stateId>4</stateId>
      <sendEmail>0</sendEmail>
      <sendDocument>0</sendDocument>
   </order>
</datapack>

XML súbor bude importovaný ako komprimovaný XML súbor vo formáte ZIP

Popis parametrov XML feedu:

Názov parametra	Popis
order id	Číslo objednávky
stateId	ID stavu objednávky ID stavov objednávok je možné získať zo zoznamu dokladov a to po prihlásení do clickeshop administrácie daného internetového obchodu / Globálne nastavenia / Úprava textov / Stavy dokladov. V tejto sekcii nájdete stavy všetky objednávok, ktoré si môžete nastavovať. Po rozkliknutí nejakého stavu napr. "storno" sa zobrazí formulár na nastavovanie konkrétneho stavu dokladu a následne v URL linke internetového prehliadača hľadajte parameter id=4, čo je ID stavu dokladu ( stavu objednávky )
sendEmail	1 / odoslať email o zmene stavu objednávky 0 / neodoslať email
sendDocument	1 / pripojiť PDF dokument do emailu 0 / odoslať email bez PDF dokumentu
orderDescr	Dodatočný popis pripojený do odosielaného emailu

2.3 API rozhranie

slúži na automatické spracovanie XML súboru ( upload XML súboru s informáciami o aktuálnom stave objednávok ) pri prepojení ClickEshopu s inými systémami. Na API rozhranie je možné naprogramovať užívateľskú aplikáciu.

Cesta k API rozhraniu na automatizovaný import stavov objednávok:

https://api.clickeshop.sk/import_orders/

Metóda volania: Rest API HTTP POST

XML súbor bude importovaný ako komprimovaný XML súbor vo formáte ZIP.

API parametre pre import stavov objednávok (použitie metódou POST)

Názov parametra	Povinný parameter	Popis
login	Áno	Postup na vytvorenie login je nasledovný: 1) Prihlásiť sa do administrácie daného eshopu 2) Zvoliť sekciu Globálne nastavenia – Užívatelia 3) Vyplniť “Email užívateľa:” 4) Rola “STANDARD” Oprávnenia: žiadne ! 5) Uložiť Na zaregistrovaný mail príde heslo
password	Áno	Po vložení nového užívateľa v sekcii "Globálne nastavenia / Užívatelia" príde na zaregistrovaný mail nové heslo, ktoré sa použije pri autentifikácii
id_project	Áno	Treba požiadať podporu o pridelenie ID. Požiadavka musí by byť zaslaná z kontaktného formulára priamo z administrácie eshopu (Pomoc – Zákaznícka podpora)
file_data	Áno	vo formáte $_FILES['file_data'] ( <form method="post" enctype="multipart/form-data"> ) ako kompresovaný XML súbor v štandardnom formáte ZIP (nazov.zip)

2.4 Výpis spracovania dát ( log )

Výsledok log zo spracovania automatického importu bude prístupný cez ClickEshop administrátor v sekcii: Globálne nastavenia / Hromadný import.
Zaznamenaný a zobrazený je vždy posledný log z importu.

2.5 Obmedzenia

Súbor, ktorý sa importuje môže mať maximálne 10 MB (zip). V prípade, že je súbor väčší, tak sa rozdelí na
viac dávok. V reálnom čase je možné spracovávať naraz len jeden import.
API je možné volať maximálne 60 krát za 1 konkrétny deň
API je možné volať maximálne 1 krát za 1 minútu
API je možné volať iba cez šifrované spojenie SSL https:

2.6 Chybové stavy