Systémový dotaz na stav objednávky

AyMINE podporuje možnost získat automaticky stav objednávek klienty

• Terminologie
• Dotaz na objednávky
• Struktura API dotazu:
• Četnost dotazů
• Funkce stav objednávek (Order STatus) (oper=ost)

Terminologie

• Uživatelem se v rámci této kapitoly rozumí organizace/firma, která využívá AyMINE pro automatizaci procesů
• Klientem se rozumí klient uživatele - firma, které byly zpřístupněny služby API nebo klientského portálu

Dotaz na objednávky

Přesnou adresu pro získání stavu objednávek dostávají zákazníci na základě dohody s uživateli AyMINE.

Struktura API dotazu:

• Adresa AyMINE nebo jedinečná adresa (pokud je systém veden po doménou uživatele)
• Jedinečná adresa služby
• Parametry dotazu
  • ID služby (ID je možné kdykoli změnit v nastavení systému a tak službu zablokovat)
  • ID klienta (Klientovi je ID přidělování jedno pro všechny poskytované služby v nastavení klienta. Změnou nebo zrušením přiděleného ID je možné službu zablokovat/povolit konkrétnímu klientovi)
  • oper - jedna z operací rozhraní
  • enc - kódování odpovědi: plain - prostý text, b64 - kódováno v base64
  • format - formát vrácené odpovědi: xml, js

Četnost dotazů

API nehlídá, jak často je zaslán dotaz, ale hlídá

• Maximální povolený počet dotazů za hodinu - po překročení bude vracet chybový kód
• Maximální povolený počet dotazů za den - po překročení bude vracet chybový kód
• Počet neúspěšných přihlášení z IP adresy - po překročení přestane rozhraní zcela odpovídat a adresa bude blokována

Limity jsou nastavovány individuálně. Obecně platí doporučení, nevolat rozehraní častěji než 1 x 2 minuty.

Funkce stav objednávek (Order STatus) (oper=ost)

Vracené stavy objednávek:

• CE - (Customer / Error) - Objednávka vyžaduje dokončení / opravu prostřednictvím zákaznického portálu. Do doby, než bude zákazníkem na portále opravena a potvrzena, není interně zpracovávána
• PR - (Prepare) - Objednávka je interně připravována nebo z nějakého důvodu (např. chybějící zboží) nemůže být zařazena do expedice
• DL - (Delivery) - Objednávka už je doručována
• CO - (Completed) - Objednávka byla zpracována a zboží doručeno, Objednávka je do tohoto stavu přeřazena po potvrzení, že byla předána koncovému příjemci. V případě převzetí zboží na prodeje je stav změněn po převzetí
• DE - (Deleted) - Vyřazena ze zpracování

Dle dohody může rozhraní vracet další informace:

• Zvolený typ dopravy
• Naplánovaný termín doručení (datum + čas)
• Stav úhrady