Dokumentace API - Zákazníci
Základní informace
Základní informace k API, autentizaci, stavovým kódům, HTTP metodám, datovým typům a další najdete na API v2 základní informace
Seznam zákazníků
- 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 metoda: GET
- hlavičky:
Authorization: Basic dGVzdDp0ZXN0
Content-Type: application/json
- parametry - slouží pro filtrování výstupu:
creation_time_from
(date) - pouze zákazníci vytvoření od datalast_update_time_from
(date) - pouze zákazníci u kterých došlo ke změně od datacode
(string) - kód zákazníkaactive_yn
(bool) - aktivní / neaktivníblocked_yn
(bool) - blokovaní / neblokovanílanguage
(language) - jazyk zákazníkapricelist
(string) - ceníkemail
(string) - emailphone
(string) - telefoncompany_name
(string) - název firmycompany_number
(string) - DIČcompany_vat_number
(string) - IČOpage
(int) - stránka, pokud není definováno, vrací vždy stranu 1
Odpověď
Seznam zákazníků je dostupný po jednotlivých stranách, výstup je omezen na 100 položek na stránku.
- tělo:
current_page
(int) - aktuální stranacurrent_page_items
(int) - počet položek na aktuální straněnumber_of_pages
(int) - celkový počet strannumber_of_items
(int) - celkový počet položekcustomers
(array) - pole objektů se zákazníkycustomer_id
(int) - ID zákazníkatype
(string) - typ zákazníka, možné hodnoty jsou:- contact - kontakt (neregistrovaný zákazník)
- customer - zákazník (registrovaný zákazník)
- company - firma (registrovaný zákazník který má navíc firemní údaje)
degree
(string) - titulfirstname
(string) - křestní jménosurname
(string) - příjmenínickname
(string) - přezdívkacode
(string) - kód zákazníkalanguage
(language) - jazyk zákazníkanewsletter_yn
(bool) - chce / nechce dostávat newsletternewsletter_accept
(string) - akceptuje zákazník newsletter (náhrada zanewsletter_yn
), možné hodnoty jsou:- notset - nenastaveno
- no - ne
- yes - ano
- excluded - vyloučen (dle nastavení zákazník neotevřel určitý počet newsletteru)
pricelist
(string) - ceník zákazníkaturnover
(string) - obrat zákazníkacompany
(object) - firemní údajename
(string) - název firmycompany_number
(string) - IČOvat_number
(string) - DIČ
communication
(object) - komunikacephone
(string) - telefonfax
(string) - FAXim
(string) - instant messaging
login
(object) - přihlašovací údajeactive_yn
(bool) - aktivní / neaktivníblocked_yn
(bool) - blokovaný / neblokovanýemail
(string) - email
groups
(array) - skupiny do kterých je zákazník zařazenaddresses
(object) - adresybilling
(object) - fakturační adresastreet
(string) - ulicecity
(string) - městostate
(string) - krajzip_code
(string) - PSČcountry_id
(country) - země
postal
(array) - pole objektů s doručovacímy adresamicompany_name
(string) - název firmyfirstname
(string) - křestní jménosurname
(string) - příjmenístreet
(string) - ulicecity
(string) - městostate
(string) - krajzip_code
(string) - PSČcountry_id
(country) - země
metas
(array) - pole objektů s vlastními poli zákazníkůkey
(string) - klíč vlastního poletype
(string) - typ vlastního pole (hodnoty mohou být: radio, checkbox, input, date, email, number, select, multiselect, textarea, formatted)value
(string) - hodnota vlastního pole, v případě kdy je hodnota vlastního pole společná pro všechny jazykyvalues
(array) - pole objektů s hodnotami, v případě kdy není hodnota vlastního pole společná pro všechny jazykylanguage
(language) - specifikace jazykové mutacevalue
(string) - hodnota
creation_time
(date) - datum a čas vytvořenílast_update_time
(date) - datum a čas poslední změnyadmin_url
(string) - URL do detailu zákazníka v administraci
Aktualizace zákazníků
- URI: /api/v2/customers
- HTTP metoda: PUT
- hlavičky:
Authorization: Basic dGVzdDp0ZXN0
Content-Type: application/json
- tělo:
- zákazníci se párují podle
email
. V odpovědi jsou všechni zákazníci kteří byli v požadavku. customers
(array) - pole objektů se zákazníkyemail
(string) - email zákazníkanewsletter_accept
(string) - akceptuje zákazník newsletter, možné hodnoty jsou:- notset - nenastaveno
- no - ne
- yes - ano
- excluded - vyloučen (dle nastavení zákazník neotevřel určitý počet newsletteru)
metas
(array) - pole objektů s vlastními polikey
(string) - klíč vlastního polevalue
(string) - hodnota vlastního pole
- zákazníci se párují podle
-
příklad požadavku
PUT /api/v2/orders HTTP/1.1 Content-Type: application/json Authorization: Basic dGVzdDp0ZXN0 { "customers": [ { "email": "support01622708061@upgates.com", "newsletter_accept": "yes", "metas": [ { "key":"custom_key_1", "value": "1" } ] } ] }
Odpověď
- tělo:
customers
(array) - pole objektů se zákazníkyemail
(string) - email zákazníkaupdated_yn
(bool) - příznak jestli se zákazník aktualizovalmessages
(array) - pole objektů chybových zpráv a upozornění při zpracování objednávkyobject
(string) - název objektu (část JSONu) kterého se zpráva týkáproperty
(string) - hodnota které se zpráva týkámessage
(string) - text zprávy
-
příklad odpovědi (HTTP 200 OK)
HTTP/1.1 200 OK Content-Type: application/json { "customers": [ { "email": "", "updated_yn": "", "messages": [ { "object": "", "property": "", "message": "" } ] } ] }
Ověření přihlášení
-
URI: /api/v2/customers/login
-
HTTP metoda: POST
-
hlavičky:
Authorization: Basic dGVzdDp0ZXN0
Content-Type: application/json
-
tělo:
email
(email) - přihlašovací emailpassword
(string) - heslo
-
příklad požadavku
POST /api/v2/orders HTTP/1.1 Content-Type: application/json Authorization: Basic dGVzdDp0ZXN0 { "email": "", "password": "" }
Odpověď
- tělo:
authenticated
(bool) - když vracítrue
je to platný přihlašovací email a heslomessages
(array) - pole objektů chybových zpráv a upozorněníobject
(string) - název objektu (část JSONu) kterého se zpráva týkáproperty
(string) - hodnota které se zpráva týkámessage
(string) - text zprávy
-
příklad odpovědi (HTTP 200 OK)
HTTP/1.1 200 OK Content-Type: application/json { "authenticated": "", "messages": [ { "object": "", "property": "", "message": "" } ] }