Zákazníci

Základní informace

Základní informace k API, autentizaci, stavové kódy, HTTP metody, datové typy 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 data
    • last_update_time_from (date) - pouze zákazníci u terých došlo ke změně od data
    • code (string) - kód zákazníka
    • active_yn (bool) - aktivní / neaktivní
    • blocked_yn (bool) - blokovaní / neblokovaní
    • language (language) - jazyk zákazníka
    • pricelist (string) - ceník
    • email (string) - email
    • phone (string) - telefon
    • company_name (string) - název firmy
    • company_number (string) - DIČ
    • company_vat_number (string) - IČ
    • page (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í strana
    • current_page_items (int) - počet položek na aktuální straně
    • number_of_pages (int) - celkový počet stran
    • number_of_items (int) - celkový počet položek
    • customers (array) - pole objektů se zákazníky
      • customer_id (int) - ID zákazníka
      • type (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) - titul
      • firstname (string) - křestní jméno
      • surname (string) - příjmení
      • nickname (string) - přezdívka
      • code (string) - kód zákazníka
      • language (language) - jazyk zákazníka
      • newsletter_yn (bool) - chce / nechce dostávat newsletter
      • pricelist (string) - ceník zákazníka
      • turnover (string) - obrat zákazníka
      • company (object) - firemní údaje
        • name (string) - název firmy
        • company_number (string) - IČ
        • vat_number (string) - DIČ
      • communication (object) - komunikace
        • phone (string) - telefon
        • fax (string) - FAX
        • im (string) - instant messaging
      • login (object) - přihlašovací údaje
        • active_yn (bool) - aktivní / neaktivní
        • blocked_yn (bool) - blokovaný / neblokovaný
        • email (string) - email
      • addresses (object) - adresy
        • billing (object) - fakturační adresa
          • street (string) - ulice
          • city (string) - město
          • state (string) - kraj
          • zip_code (string) - PSČ
          • country_id (country) - země
        • postal (array) - pole objektů s doručovacímy adresami
          • company_name (string) - název firmy
          • firstname (string) - křestní jméno
          • surname (string) - příjmení
          • street (string) - ulice
          • city (string) - město
          • state (string) - kraj
          • zip_code (string) - PSČ
          • country_id (country) - země
      • creation_time (date) - datum a čas vytvoření
      • last_update_time (date) - datum a čas poslední změny
      • admin_url (string) - URL do detailu zákazníka v administraci

  • příklad odpovědi (HTTP 200 OK)

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "customers": [
        {
            "email": "",
            "messages": [
                {
                    "object": "",
                    "property": "",
                    "message": ""
                }
            ]
        }
    ]
}