Dokumentácia API - Zákazníci

Základné informácie

Základné informácie k API, autentizácii, stavovým kódom, HTTP metódam, dátovým typom a ďalšie nájdete na API v2 základné informácie

Zoznam zákazníkov

URI: /api/v2/customers/?creation_time_from={creation_time_from} &last_update_time_from={last_update_time_from} &active_yn={active_yn} &blocked_yn={blocked_yn} &language={language} &pricelist={pricelist} &page={page} HTTP metóda: GET hlavičky:
• Authorization: Basic dGVzdDp0ZXN0
• Content-Type: application/json
parametre - slúžia pre filtrovanie výstupu:
• creation_time_from (date) - len zákazníci vytvorení od dátumu
• last_update_time_from (date) - len zákazníci, u ktorých došlo k zmene od dátumu
• code (string) - kód zákazníka
• active_yn (bool) - aktívne / neaktívne
• blocked_yn (bool) - blokovanie / neblokovanie
• language (language) - jazyk zákazníka
• pricelist (string) - cenník
• email (string) - e-mail
• phone (string) - telefón
• company_name (string) - názov firmy
• company_number (string) - DIČ
• company_vat_number (string) - IČ
• page (int) - stránka, pokiaľ nie je definované, vracia vždy stranu 1

Odpoveď

Zoznam zákazníkov je dostupný po jednotlivých stranách, výstup je obmedzený na 100 položiek na stránku.

telo:
• current_page (int) - aktuálna strana
• current_page_items (int) - počet položiek na aktuálnej strane
• number_of_pages (int) - celkový počet strán
• number_of_items (int) - celkový počet položiek
• customers (array) - pole objektov so zákazníkmi
• customer_id (int) - ID zákazníka
• type (string) - typ zákazníka, možné hodnoty sú:
• contact - kontakt (neregistrovaný zákazník)
• customer - zákazník (registrovaný zákazník)
• company - firma (registrovaný zákazník, ktorý má navyše firemné údaje)
• degree (string) - titul
• firstname (string) - krstné meno
• surname (string) - priezvisko
• nickname (string) - prezývka
• code (string) - kód zákazníka
• language (language) - jazyk zákazníka
• newsletter_yn (bool) - chce / nechce dostávať newsletter
• newsletter_accept (string) - akceptuje zákazník newsletter (náhrada za newsletter_yn), možné hodnoty sú:
• notset - nenastavené
• no - nie
• yes - áno
• excluded - vylúčený (podľa nastavení zákazník neotvoril určitý počet newsletterov)
• pricelist (string) - cenník zákazníka
• turnover (string) - obrat zákazníka
• company (object) - firemné údaje
• name (string) - názov firmy
• company_number (string) - IČ
• vat_number (string) - DIČ
• communication (object) - komunikácia
• phone (string) - telefón
• fax (string) - FAX
• im (string) - instant messaging
• login (object) - prihlasovacie údaje
• active_yn (bool) - aktívne / neaktívne
• blocked_yn (bool) - blokovaný / neblokovaný
• email (string) - e-mail
• groups (array) - skupiny, do ktorých je zákazník zaradený
• addresses (object) - adresy
• billing (object) - fakturačná adresa
• street (string) - ulica
• city (string) - mesto
• state (string) - kraj
• zip_code (string) - PSČ
• country_id (country) - krajina
• postal (array) - pole objektov s doručovacími adresami
• company_name (string) - názov firmy
• firstname (string) - krstné meno
• surname (string) - priezvisko
• street (string) - ulica
• city (string) - mesto
• state (string) - kraj
• zip_code (string) - PSČ
• country_id (country) - krajina
• metas (array) - pole objektov s vlastnými poľami zákazníkov
• key (string) - kľúč vlastného poľa
• type (string) - typ vlastného poľa (hodnoty môžu byť: radio, checkbox, input, date, e-mail, number, select, multiselect, textarea, formatted)
• value (string) - hodnota vlastného poľa, v prípade kedy je hodnota vlastného poľa spoločná pre všetky jazyky
• values (array) - pole objektov s hodnotami, v prípade kedy nie je hodnota vlastného poľa spoločná pre všetky jazyky
• language (language) - špecifikácie jazykovej mutácie
• value (string) - hodnota
• creation_time (date) - dátum a čas vytvorenia
• last_update_time (date) - dátum a čas poslednej zmeny
• admin_url (string) - URL do detailu zákazníka v administrácii

Aktualizácia zákazníkov

URI: /api/v2/customers HTTP metóda: PUT hlavičky:
• Authorization: Basic dGVzdDp0ZXN0
• Content-Type: application/json
telo:
• zákazníci sa párujú podľa e-mailu. V odpovedi sú všetci zákazníci, ktorí boli v požiadavke.
• customers (array) - pole objektov so zákazníkmi
• email (string) - e-mail zákazníka
• newsletter_accept (string) - akceptuje zákazník newsletter, možné hodnoty sú:
• notset - nenastavené
• no - nie
• yes - áno
• excluded - vylúčený (podľa nastavení zákazník neotvoril určitý počet newsletterov)
• metas (array) - pole objektov s vlastnými poľami
• key (string) - kľúč vlastného poľa
• value (string) - hodnota vlastného poľa

príklad požiadavky

PUT /api/v2/orders HTTP/1.1

Odpoveď

telo:
• customers (array) - pole objektov so zákazníkmi
• email (string) - e-mail zákazníka
• updated_yn (bool) - príznak, či sa zákazník aktualizoval
• messages (array) - pole objektov chybových správ a upozornení pri spracovaní objednávky
• object (string) - názov objektu (časť JSON), ktorého sa správa týka
• property (string) - hodnota, ktorej sa správa týka
• message (string) - text správy

príklad odpovede (HTTP 200 OK)

HTTP/1.1 200 OK

Overenie prihlásenia

URI: /api/v2/customers/login

HTTP metóda: POST

hlavičky:


• Authorization: Basic dGVzdDp0ZXN0
• Content-Type: application/json
telo:


• e-mail (email) - prihlasovací e-mail
• password (string) - heslo

príklad požiadavky

Odpoveď

telo:
• authenticated (bool) - keď vracia true je to platný prihlasovací e-mail a heslo
• messages (array) - pole objektov chybových správ a upozornení
• object (string) - názov objektu (časť JSON), ktorého sa správa týka
• property (string) - hodnota, ktorej sa správa týka
• message (string) - text správy

príklad odpovede (HTTP 200 OK)