Přeskočit na hlavní obsah

Upgates

Pomocí tohoto modulu je možné propojit scénáře s daty Upgates

Instalace

Pro napojení budete potřebovat API údaje. Stačí když po přihlášení do administrace Upgates kliknete na Doplňky v levém menu a rozkliknete položku API. Zde naleznete API url, API login a API klíč.

Budete potřebovat
  • API url
  • API login
  • API klíč

Funkce aplikace

Ověřit číslo objednávky

Ověření, zda zákazník zadává správné číslo objednávky je jednou ze základních funkcí. Díky tomu budete vždy vědět, jakou objednávku zákazník řeší a eliminujete všechny problémy spojené s překlepy či záměnou s jinými doklady (VS, číslo faktury apod.).

Parametry aplikace

Číslo objednávky: Tady vyplňte proměnnou (ve složených závorkách), do které jste si uložili zadané číslo objednávky od uživatele, např.: {{obj}}. Příklad: {{obj}}.

Výsledek volání aplikace

Ne: Pokud objednávka neexistuje, obsahuje {{promenna}} hodnotu false (nepravda). Aplikace vám vrátí hodnotu Ne.

Ano: Aplikace vrací další proměnné, které můžete dále ve scénáři používat:

  • {{[box].status}} Stav objednávky. Textový popis stavu objednávky, např.: Nevyřízeno
  • {{[box].billing}} Platební metoda. Textový název platební metody, např.: Hotově
  • {{[box].shipping}} Přepravce. Textový název zvoleného přepravce, např.: PPL
  • {{[box].paid}} Zaplaceno. Logická hodnota true nebo false, která říká, jestli je objednávka zaplacená
  • {{[box].topay}} K úhradě. Částka k úhradě (celková cena objednávky), např.: 1230.50
  • {{[box].currency}} Měna. Měna, např.: EUR nebo CZK
  • {{[box].tracking}} Tracking číslo. Text (nebo číslo), které slouží pro sledování zásilky
Info

Co je {{[box]...}} ? Jedná se o zápis názvu proměnné. Protože každá proměnná má volitelný název, zobrazujeme univerzální [box]. V hranatých závorkách proto, abyste věděli že je nutné tuto část nahradit za reálný název proměnné. Pokud tedy je název vaší proměnné "app" a aplikace vrací {{[box].id}} pak je nutné ve scénáři použít {{app.id}}

Načíst detail objednávky

Pro zobrazení stavu objednávky, nebo rozhodnutí, co může zákazník se svou objednávkou provést za akce, potřebujete znát detaily jeho objednávky. K tomu vám stačí pouze zjistit od zákazníka číslo objednávky. Všechny detaily si pak načtete přímo z Upgates.

Parametry aplikace

Číslo objednávky: Tady vyplňte proměnnou (ve složených závorkách), do které jste si uložili zadané číslo objednávky od uživatele, např.: {{obj}}. Příklad: {{obj}}.

E-mail zákazníka: E-mail vyplňte stejně jako číslo objednávky jako proměnnou (ve složených závorkách), do které jste si uložili zadaný e-mail od uživatele, např.: {{email}}. Pro zabezpečení dat vždy vyžadujeme od zákazníka, aby správně zadal kombinaci čísla objednávky a e-mailu. Jen pokud se tyto dva údaje shodují, můžeme zákazníkovi zobrazit obsah objednávky a nechat ho provádět změny.

Výsledek volání aplikace

Ne: Pokud objednávka neexistuje, obsahuje {{promenna}} hodnotu false (nepravda). Aplikace vám vrátí hodnotu Ne.

Ano: Aplikace vrací další proměnné, které můžete dále ve scénáři používat:

  • {{[box].url}} URL administrace. Adresa do administrace objednávky
  • {{[box].phone}} Telefonní číslo. Telefonní číslo zákazníka, např.: +420601223344
  • {{[box].status}} Stav objednávky. Textový popis stavu objednávky, např.: Nevyřízeno
  • {{[box].billing}}
  • {{[box].shipping}} Přepravce. Textový název zvoleného přepravce, např.: PPL
  • {{[box].paid}} Zaplaceno. Logická hodnota true nebo false, která říká, jestli je objednávka zaplacená
  • {{[box].topay}} K úhrafě. Částka k úhradě (celková cena objednávky), např.: 1230.50
  • {{[box].currency}} Měna. Měna, např.: EUR nebo CZK
  • {{[box].tracking}} Tracking číslo. Text (nebo číslo), které slouží pro sledování zásilky
  • {{[box].items}} Položky objednávky. Seznam položek (zboží) objednávky (každá položka dále obsahuje "name", "brand" a "code")
Info

Co je {{[box]...}} ? Jedná se o zápis názvu proměnné. Protože každá proměnná má volitelný název, zobrazujeme univerzální [box]. V hranatých závorkách proto, abyste věděli že je nutné tuto část nahradit za reálný název proměnné. Pokud tedy je název vaší proměnné "app" a aplikace vrací {{[box].id}} pak je nutné ve scénáři použít {{app.id}}

Načíst e-mail zákazníka dle ID objednávky

Načte e-mail, ze kterého byla vytvořena objednávka dle zadaného čísla objednávky. Pozor, při uložení výsledku aplikace do proměnné, můžete vyzradit tyto informace jiným návštěvníkům internetu. Doporučujeme proto proměnnou pojmenovat tak, aby začínala znakem $, takové proměnné nejsou přenášeny do prohlížeče.

Parametry aplikace

Číslo objednávky: Tady vyplňte proměnnou (ve složených závorkách), do které jste si uložili zadané číslo objednávky od uživatele, např.: {{obj}}. Příklad: {{obj}}.

Výsledek volání aplikace

Ne: Pokud se nepodaří načíst e-mail zákazníka, obsahuje {{promenna}} hodnotu false (nepravda). Aplikace vám vrátí hodnotu Ne.

Změnit stav objednávky

Pro lepší přehlednost a práci s objednávkami, můžete měnit jejich stavy. Například když zakázník v samoobsluze zažádá o storno objednávky, rovnou ji stornujete atd. Díky napojení na Upgates navíc můžete pracovat i se stavy, které jste si sami vytvořili.

Parametry aplikace

Stav objednávky: Ve výchozím nastavení má UPgates tyto stavy:PřijatáPlatba probíháPlatba úspěšnáPlatba selhalaPlatba zrušenaNedořešenáStornovanáJak zjistit vaše stavy se dozvíte v naší nápovědě https://www.messageok.com/upgates/stavy.

Odeslat e-mail zákazníkovi: Vyberte, jestli chcete, aby se odeslal související e-mail se změnou stavu.

Výsledek volání aplikace

Ne: Pokud se nepodaří změnit stav objednávky, obsahuje {{promenna}} hodnotu false (nepravda). Aplikace vám vrátí hodnotu Ne.

Ano: Pokud se podaří změnit stav objednávky, obsahuje {{promenna}} hodnotu true (pravda) = používat tyto proměnné.

Ověřit zákazníka podle e-mailu

Pro zabezpečení dat vždy vyžadujeme od zákazníka, aby správně zadal kombinaci čísla objednávky a e-mailu. Jen pokud se tyto dva údaje shodují, můžeme zákazníkovi zobrazit obsah objednávky a nechat ho provádět změny.

Parametry aplikace

Číslo objednávky: Tady vyplňte proměnnou (ve složených závorkách), do které jste si uložili zadané číslo objednávky od uživatele, např.: {{obj}}. Příklad: {{obj}}.

E-mail zákazníka: E-mail vyplňte stejně jako číslo objednávky jako proměnnou (ve složených závorkách), do které jste si uložili zadaný e-mail od uživatele, např.: {{email}}. Pro zabezpečení dat vždy vyžadujeme od zákazníka, aby správně zadal kombinaci čísla objednávky a e-mailu. Jen pokud se tyto dva údaje shodují, můžeme zákazníkovi zobrazit obsah objednávky.

Výsledek volání aplikace

Ne: Pokud se nepodaří ověřit zákazníka podle e-mailu, obsahuje {{promenna}} hodnotu false (nepravda). Aplikace vám vrátí hodnotu Ne.

Ano: Pokud se podaří ověřit zákazníka podle e-mailu, obsahuje {{promenna}} hodnotu true (pravda). Aplikace vám vrátí hodnotu Ano.

Načíst seznam objednávek zákazníka dle telefonního čísla

Pokud zadáte telefonní číslo zákazníka, lze načíst seznam jeho vytvořených objednávek, ze kterých si vybere tu, která ho právě zajímá.

Parametry aplikace

Za časové období

Telefonní číslo zákazníka

Výsledek volání aplikace

Ano: Aplikace vrací další proměnné, které můžete dále ve scénáři používat:

  • {{[box].count}} Počet objednávek. Obsahuje číslo, které odpovídá počtu objednávek
  • {{[box].orders}} Objednávky. Obsahuje seznam objednávek s klíči "orderid", "date" a "price"

Ne: Pokud se nepodaří načíst seznam objednávek, obsahuje {{promenna}} hodnotu false (nepravda). Aplikace vám vrátí hodnotu Ne.

Info

Co je {{[box]...}} ? Jedná se o zápis názvu proměnné. Protože každá proměnná má volitelný název, zobrazujeme univerzální [box]. V hranatých závorkách proto, abyste věděli že je nutné tuto část nahradit za reálný název proměnné. Pokud tedy je název vaší proměnné "app" a aplikace vrací {{[box].id}} pak je nutné ve scénáři použít {{app.id}}

Přidat text k interní poznámce

Pokud nechcete smazat původní poznámku u objednávky, můžete k ní jen jednoduše přidat další doplňující text.

Parametry aplikace

Číslo objednávky: Tady vyplňte proměnnou (ve složených závorkách), do které jste si uložili zadané číslo objednávky od uživatele, např.: {{obj}}. Příklad: {{obj}}.

Text poznámky: Text, který vyplníte, se doplní na konec poznámky (původní obsah poznámky zůstane zachován).

Výsledek volání aplikace

Ne: Pokud se nepodaří přidat text k interní poznámce, obsahuje {{promenna}} hodnotu false (nepravda). Aplikace vám vrátí hodnotu Ne.

Ano: Pokud se podaří přidat text k interní poznámce, obsahuje {{promenna}} hodnotu true (pravda). Aplikace vám vrátí hodnotu Ano.

Přepsat poznámku v objednávce

Když potřebujete přidat k objednávce nějakou poznámku a zároveň nechcete, aby původní poznámka u objednávky, která už neplatí (například proto, že zákazník chce něco změnit atd.) někoho zmátla, můžete celou poznámku rovnou přepsat.

Parametry aplikace

Výsledek volání aplikace

Ne: Pokud se nepodaří přepsat poznámku v objednávce, obsahuje {{promenna}} hodnotu false (nepravda). Aplikace vám vrátí hodnotu Ne.

Ano: Pokud se podaří přepsat poznámku v objednávce, obsahuje {{promenna}} hodnotu true (pravda). Aplikace vám vrátí hodnotu Ano.

Načíst doklady k objednávce

Pokud zákazník potřebuje fakturu poslat znovu, stačí když zadá e-mail a číslo objednávky. V samoobsluze se mu vygeneruje URL odkaz, kde si ji jednoduše stáhne.

Parametry aplikace

Číslo objednávky: Tady vyplňte proměnnou (ve složených závorkách), do které jste si uložili zadané číslo objednávky od uživatele, např.: {{obj}}. Příklad: {{obj}}.

E-mail zákazníka: E-mail vyplňte stejně jako číslo objednávky jako proměnnou (ve složených závorkách), do které jste si uložili zadaný e-mail od uživatele, např.: {{email}}. Pro zabezpečení dat vždy vyžadujeme od zákazníka, aby správně zadal kombinaci čísla objednávky a e-mailu. Jen pokud se tyto dva údaje shodují, můžeme zákazníka nechat stáhnout fakturu.

Výsledek volání aplikace

Ne: Pokud se nepodaří ověřit zákazníka dle e-mailu pro stáhnutí faktury, obsahuje {{promenna}} hodnotu false (nepravda). Aplikace vám vrátí hodnotu Ne.

Ano: Aplikace vrací další proměnné, které můžete dále ve scénáři používat:

  • {{[box].invoice}} Stav faktury. Obsahuje "notfound", pokud faktura nebyla nalezena (např.: nebyla ještě vystavena), "error", pokud se fakturu nepodařilo načíst a nebo "found", pokud byla faktura načtena
  • {{[box].invoiceurl}} URL faktury. Obsahuje adresu ke stažení PDF faktury
Info

Co je {{[box]...}} ? Jedná se o zápis názvu proměnné. Protože každá proměnná má volitelný název, zobrazujeme univerzální [box]. V hranatých závorkách proto, abyste věděli že je nutné tuto část nahradit za reálný název proměnné. Pokud tedy je název vaší proměnné "app" a aplikace vrací {{[box].id}} pak je nutné ve scénáři použít {{app.id}}