eOrdering API 1.3 Dokumentácia

Obsah

• Zmeny
• Známe chyby

Táto dokumentácia popisuje funkcionalitu aplikačného rozhrania k službe eOrdering (trasferové objednávky). Jej obsah sa môže meniť podľa požiadaviek klientov a partnerov.

Ak máte akékoľvek otázky týkajúce sa technickej realizácie, napíšte nám.

Zmeny

1.3

2018-05-15:

• Do detailu objednávky bolo pridané supplierUniqueName dodávateľa (viď Zoznam objednávok a Detail objednávky)

2018-05-04:

• Opravený bug kedy požiadavka na neexistujúcu objednávku nevracala http 404
• Pridaná metóda na zmenu objednávky (viď Zmena objednávky)
• Pridané metódy na odosielanie, zrušenie a zrušenie sledovania objednávky aj podľa key a customId (viď Odoslanie objednávky)

2016-05-25:

• V detaile produktu opravený názov "StockUniqueName" na "stockUniqueName" a "Amount" na "amount" (viď Štruktúra)
• Do detailu spoločnosti pridaná vlastnosť inSupplierStatus (stav spoločnosti u jednotlivých dodávateľov) (viď Detail spoločnosti). Vlastnosť sa vyplní pro použití parametra includeInSupplierStatus pri načítaní:
  • zoznamu spoločností (viď Zoznam spoločností)
  • detailu spoločnosti (viď Detail spoločnosti)
• V detaile spoločnosti bol premenovaný paramer withPharmacies na includePharmacies (viď Detail spoločnosti)
• Doplnené stavy objednávky, v ktorých sa dá zmazať (viď Zmazanie objednávky)
• Doplnené dva nové chybové kódy do objednávky: 605 a 606 (viď Štruktúra)
• Doplnená tabuľka príznakov pre položky v objednávke flags (viď Štruktúra)

Poznámky:

• Aj do objednávky odosielanej emailom je možné zaraďovať tzv. rabatové položky, pokiaľ to dodávateľ umožňuje (viď Štruktúra).
  • Nejde o zmenu dokumentácie, avšak doteraz sme u žiadneho distribútora túto funkcionalitu neposkytovali.

1.2

2015-02-20:

• Zoznam skladov dodávateľa (viď Štruktúra)
• Priradenie lekárne skladu dodávateľa (vlastnosť stockUniqueName, viď Štruktúra)
• Pridaný katalógový kód a Gtin kódy produktu (vlastnosti catalogueNumber a gtins, viď Štruktúra)
• Príznak vyradenia profilu spoločnosti a lekárne zo zoznamov a tomu zodpovedajúca úprava vyhľadávania (viď Štruktúra Štruktúra)

2014-02-28:

• V novej objednávke premenovaný parameter sender na owner (viď Nová objednávka)
• Do detailu objednávky pridaná vlastnosť owner (autor) (viď Štruktúra)
• V zozname objednávok je možné hľadať podľa ownera (viď Zoznam objednávok)
• Možnosť jednoznačne sa odkazovať na lekáreň nielen pomocou identifikátora id, ale aj
  • pomocou kódu PZS - key, (viď Detail lekárne)
  • pri vytváraní novej objednávky cez pharmacyKey (viď Nová objednávka)
• Možnosť jednoznačne sa odkazovať na dodávateľa nielen pomocou identifikátora id, ale aj
  • pomocou unikátneho názvu dodávateľa - uniqueName (viď Detail dodávateľa)
  • pri vytváraní novej objednávky cez supplierUniqueName (viď Nová objednávka)
• Pridaný príznak o tom, či je lekáreň nahradená novou a ak áno, tak ktorou (viď Lekáreň)
• Možnosť jednoznačne sa odkazovať na objednávku pomocou:
  • unikátneho čísla objednávky GET /api.svc/json/orders/key/{key}
  • vlastného identifikátora objednávky GET /api.svc/json/orders/customId/{customId}
• Paramater customId bol odstránený z vyhľadávania objednávok (viď Zoznam objednávok)
• Parameter targetEmails môže byť uvedený len v prípade emailovej objednávky, ináč dôjde k exception (viď Nová objednávka)
• Opravený bug vo vyhľadávaní v poli PSČ, odporúčame vyhľadávať PSČ bez medzier, tj. "821 01" > "82101"
• Opravených niekoľko bugov spôsobujúcich nesprávne sortovanie.
• Opravený bug spôsobujúci nesprávne vyhľadávanie (case sensitive search) v niektorých poliach
• Parametre supplier a pharmarcy boli premenované na supplierId a pharmacyId v nasledujúcich metódach
  • pri vyhľadávaní objednávok (viď Zoznam objednávok)
  • pri vytváraní novej objednávky (viď Nová objednávka)
  • dočasne sa dajú používať oba varianty

1.1

2013-12-04:

• Pridaný stav posledného pokusu o vybavenie sledovanej objednávky watchLastTryStatus (viď Objednávka)
• Možnosť filtrovať objednávky podľa stavu v rozsahu napr. 600-699 zadaním status=6* (viď Objednávka)

2013-11-29:

• Pridaná možnosť označiť si objednávku vlastným identifikátorom customId (viď Objednávka)
• Opravený bug znemožňujúci filtrovanie podľa číselných hodnôt

2013-11-26:

• Redefinovaný status objednávky a položky objednávky, viac v sekcii Objednávka

1.0

2013-11-15:

• Autentifikačný proces akceptuje alternatívnu hlavičku X-Date, viac v sekcii Podpis požiadavky
• V dokumentácii pribudol popis vyhľadávania pomocou parametra filter.
• API nevracia pri UTF-8 kódovaní na začiatku tela odpovede BOM (byte order mark).

0.9

2013-10-01:

• Publikovaná prvá verzia dokumentácie

Známe chyby

Url končiaca s '?'' bez žiadnych query parametrov

Ak je požiadavka podpísaná voči url, ktorá končí so znakom ? a neobsahuje žiadne parametre, API neautentifikuje takúto požiadavku.

Napríklad

GET /api.svc/json/orders? HTTP/1.1

skončí s nasledovnou chybou

{
  "code": 300,
  "description": "Autentifikácia zlyhala.",
  "detail": {
    "message": "Neznáma chyba."
  }
}