Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP POST

POST batch/customers

Ostatnia modyfikacja 2021-06-16 11:24:35

Dodanie wielu klientów.

URL

https://api.thulium.com/api/batch/customers

Parametry

customers

wymagany

Lista klientów do dodania. Każdy klient zawiera:
          name

          opcjonalny

Imię klienta.
          surname

          wymagany

Nazwisko klienta.
          email

          opcjonalny

Adres lub adresy e-mail klienta.
          phone_number

          opcjonalny

Numer lub numery telefonu firmy.
          company_id

          opcjonalny

Identyfikator firmy, do której ma być dodany klient.
          type

          opcjonalny

Tekstowa nazwa typu klienta zdefiniowana w systemie.
          group

          opcjonalny

Tekstowa nazwa grupy klienta zdefiniowana w systemie.
          identifier

          opcjonalny

Identyfikator klienta.
          gender

          opcjonalny

Płeć klienta.
          homepage

          opcjonalny

Strona WWW klienta.
          birthdate

          opcjonalny

Data urodzenia klienta.
          nip

          opcjonalny

NIP klienta.
          note

          opcjonalny

Notatka.
          pesel

          opcjonalny

Numer PESEL.
          job

          opcjonalny

Miejsce pracy.
          job_title

          opcjonalny

Stanowisko.
          account_manager

          opcjonalny

Login opiekuna klienta
          custom_fields

          opcjonalny

Obiekt z wartościami pól specjalnych. Przykładowa wartość: "custom_fields":{"field_name_1":"value_1","field_name_2":"value_2"}
          address

          opcjonalny

Adres klienta.
             street

             opcjonalny

Nazwa ulicy.
             building

             opcjonalny

Numer budynku.
             flat

             opcjonalny

Numer mieszkania.
             postcode

             opcjonalny

Kod pocztowy.
             city

             opcjonalny

Miasto.
             country

             opcjonalny

Kraj.
          invoice_address

          opcjonalny

Adres do faktur.
             street

             opcjonalny

Nazwa ulicy.
             building

             opcjonalny

Numer budynku.
             flat

             opcjonalny

Numer mieszkania.
             postcode

             opcjonalny

Kod pocztowy.
             city

             opcjonalny

Miasto.
             country

             opcjonalny

Kraj.
          mail_drop_address

          opcjonalny

Adres korespondencyjny.
             street

             opcjonalny

Nazwa ulicy.
             building

             opcjonalny

Numer budynku.
             flat

             opcjonalny

Numer mieszkania.
             postcode

             opcjonalny

Kod pocztowy.
             city

             opcjonalny

Miasto.
             country

             opcjonalny

Kraj.

Uwagi

Pole custom_fields musi zwawierać mapę pól specjalnych gdzie kluczem jest tekstowa nazwa pola specjalnego a wartością treść którą chcemy ustawić.
W obiekcie możemy przekazać tylko te pola, których wartości chcemy ustawić. Jeśli przekazana wartość pola specjalnego będzie pusta zawartość pola zostanie usunięta.
W przypadku gdy pole specjalne nie istnieje zostanie utworzone.
Odpowiedź zawiera obiekt, którego klucze odpowiadają kolejności klientów na liście customers

Przykładowy request

POST https://api.thulium.com/api/batch/customers
Dane {"customers":[{"surname":"Kowalski"},{"phone_number":"333444555"}]}

Przykładowy response

{
    "0": {
        "http_status": 201,
        "customer_id": "13"
    },
    "1": {
        "http_status": 400,
        "message": "Phone number must be numeric."
    }
}

Przykładowe wywołanie


PHP

<?php
$data 
'{"customers":[{"surname":"Kowalski"},{"phone_number":"333444555"}]}';

$request curl_init('https://api.thulium.com/api/batch/customers');
curl_setopt($requestCURLOPT_HTTPHEADER, array(
    
'Content-Type: application/json; charset=utf-8',
    
'Content-Length: ' mb_strlen($data)
));
curl_setopt($requestCURLOPT_USERPWD'api_user:api_pass');
curl_setopt($requestCURLOPT_TIMEOUT30);
curl_setopt($requestCURLOPT_RETURNTRANSFERtrue);
curl_setopt($requestCURLOPT_CUSTOMREQUEST'POST');
curl_setopt($requestCURLOPT_POSTFIELDS$data);

$response curl_exec($request);
if (
$response) {
    
$httpCode curl_getinfo($requestCURLINFO_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.post("https://api.thulium.com/api/batch/customers", "{\"customers\":[{\"surname\":\"Kowalski\"},{\"phone_number\":\"333444555\"}]}");
        System.out.println(response);
    }
}

CURL

curl -u api_user:api_pass -k -X POST -H "Content-type: application/json" -d '{"customers":[{"surname":"Kowalski"},{"phone_number":"333444555"}]}' "https://api.thulium.com/api/batch/customers"

HTTPie

echo '{"customers":[{"surname":"Kowalski"},{"phone_number":"333444555"}]}' | http -a api_user:api_pass POST https://api.thulium.com/api/batch/customers