Informacje

Uwierzytelnianie	wymagane
Format odpowiedzi	json
Metoda HTTP	GET

GET customers

Ostatnia modyfikacja 2024-11-20 13:20:36

Zwraca listę klientów zawężonych o podane kryteria wyszukiwania.

URL

https://your-system-name.thulium.com/api/customers

Parametry

identifier opcjonalny	Identyfikator klienta. Jeśli zostanie ustawiony pusty zwróci klientów, którzy nie mają ustawionego identyfikatora. Przykładowa wartość: `3434558`
email opcjonalny	Adres e-mail klienta. Przykładowa wartość: `jan.kowalski@foo.bar`
phone_number opcjonalny	Numer telefonu klienta lub pustą wartość (klienci którzy nie mają numeru telefonu) Przykładowa wartość: `555666777`
nip opcjonalny	Numer NIP klienta. Przykładowa wartość: `6783144527`
company_id opcjonalny	Identyfikator firmy. Przykładowa wartość: `456`
company_flag opcjonalny	Klient jest firmą. Przykładowa wartość: `true`
type opcjonalny	Tekstowa nazwa typu klienta zdefiniowana w systemie. Przykładowa wartość: `custom type name`
group opcjonalny	Tekstowa nazwa grupy klienta zdefiniowana w systemie. Przykładowa wartość: `custom group name`
custom_fields opcjonalny	Wyszukiwanie po wartościach pól specjalnych. Można wyszukiwać po wielu polach specjalnych na raz. Dla każdego pola można podać kilka alternatywnych wartości. Na przykład: ["custom_fields" => [ "Kraj" => ["POLSKA", "NORWEGIA"], "Miasto" => "Kraków" ]]; Przykładowa wartość: `custom_fields[Kraj][0]=POLSKA&custom_fields[Kraj][1]=NORWEGIA&custom_fields[Miasto]=Krak%C3%B3w`
include_custom_fields opcjonalny	Czy zwracać pola specjalne klienta. Przykładowa wartość: `true`
include_address opcjonalny	Czy zwracać adres klienta. Przykładowa wartość: `true`
include_invoice_address opcjonalny	Czy zwracać adres do faktur. Przykładowa wartość: `true`
include_mail_drop_address opcjonalny	Czy zwracać adres korespondencyjny. Przykładowa wartość: `true`
limit opcjonalny	Liczba rekordów, które mają być zwrócone. Domyślnie: 100. Maksymalna wartość: 1000. Przykładowa wartość: `100`
offset opcjonalny	Od którego rekordu należy zwrócić rezultat (używane, gdy rekordów jest więcej, niż limit). Domyślna wartość: 0. Przykładowa wartość: `10`
order opcjonalny	Lista pól, po których będą posortowane rezultaty. Prefiks '-' oznacza sortowanie malejące, brak prefiksu rosnące. Możliwe jest sortowanie po polach: surname, name, nip, company_id, customer_id, identifier. Przykładowa wartość: `name,-customer_id,nip`

Przykładowy request

GET	`https://your-system-name.thulium.com/api/customers?email=jan.kowalski@foo.bar&include_custom_fields=true&include_address=true`

Przykładowy response

[
    {
        "customer_id": 273,
        "name": "Jan",
        "surname": "Kowalski",
        "phone_number": "222333444",
        "phone_numbers": ["222333444", "213443523"],
        "email": "jan.kowalski@foo.bar",
        "emails": ["jan.kowalski@foo.bar", "j.kowalski@foo.bar],
        "company_id": "",
        "identifier": "",
        "type": "",
        "group": "",
        "company_flag": false,
        "birthdate": "",
        "gender": "",
        "homepage": "",
        "nip": "",
        "account_manager":"",
        "updated_at":"",
        "address":
        {
            "street": "Zlotej Jesieni",
            "building": "7",
            "flat": null,
            "postcode": "31-827",
            "city": "Krakow",
            "post_office": "Krakow",
            "borough": null,
            "county": null,
            "voivodship": null,
            "country": "Poland"
        },
        "custom_fields":
        {
           "ID": null,
           "Dodatkowe informacje": "Numer dowodu - AXX 121212"
        }
    }
]

Przykładowe wywołanie

PHP


<?php
$request = curl_init('https://your-system-name.thulium.com/api/customers?email=jan.kowalski@foo.bar&include_custom_fields=true&include_address=true');
curl_setopt($request, CURLOPT_HTTPHEADER, array('Content-Type: application/json; charset=utf-8'));
curl_setopt($request, CURLOPT_USERPWD, "api_user:api_pass");
curl_setopt($request, CURLOPT_TIMEOUT, 30);
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($request);
if ($response) {
    $httpCode = curl_getinfo($request, CURLINFO_HTTP_CODE);
    if ($httpCode == 200){
        print_r(json_decode($response));
    } else {
        echo $response;
    }
} else {
    trigger_error(curl_error($request), E_USER_WARNING);
}

curl_close($request);

JAVA


public class Example {
    public static void main(String[] args) throws Exception {
        ThuliumRestClient restClient = new ThuliumRestClient("api_user", "api_pass", true);

        ThuliumRestClient.ThuliumRestResponse response = restClient.get("https://your-system-name.thulium.com/api/customers?email=jan.kowalski@foo.bar&include_custom_fields=true&include_address=true");
        System.out.println(response);
    }
}

ThuliumRestClient.java (Wymaga biblioteki httpclient w wersji 4.3.5, httpcore w wersji 4.3.2, commons-codec w wersji 1.9, commons-logging w wersji 1.2)

CURL


curl -u api_user:api_pass -k -X GET -H "Accept: application/json" "https://your-system-name.thulium.com/api/customers?email=jan.kowalski@foo.bar&include_custom_fields=true&include_address=true"

HTTPie


http -a api_user:api_pass GET https://your-system-name.thulium.com/api/customers email==jan.kowalski@foo.bar include_custom_fields==true include_address==true Accept:application/json