Systim API - Zarządzanie zamówieniami

Strona główna API

addOrder

Dodanie nowego zamówienia

Wymagane parametry

token, nazwa, kod, miejscowosc, ulica, nazwa_dostawy, kod_dostawy, miejscowosc_dostawy, ulica_dostawy,
id_dostawy - id metody dostawy,
produkty[] (tablica z produktami zawierająca id produktu oraz zamawianą ilość)
id_zamawiajacego (jeśli nie podano imienia i nazwiska) imie, nazwisko (jeśli nie podano "id_zamawiajacego")

Opcjonalne parametry

produkty[]['cena'] - można podać cenę produktu używanego w zamówieniu, jeżeli ten parametr nie zostanie podany, system pobierze cenę przypisaną do produktu,
produkty[]['id_stawki_vat'] - jeśli podaliśmy cenę należy podać również id_stawki_vat aby było możliwe obliczenie stawki VAT,
naliczanie_brutto - można podać 1, jeśli netto i vat mają być przeliczane z cen brutto produktów
id_kontrahenta - mozna podać, aby zamawiający został powiązany z wybranym kontrahentem (tylko w przypadku nowego zamawiającego)
id_wojewodztwa, id_wojewodztwa_dostawy,
numer - w przypadku braku nadawany jest automatycznie kolejny numer,
id_waluty - domyślnie 0 oznaczające PLN,
id_statusu - id statusu zamówienia,
id_obslugujacego - id pracownika który będzie obsługiwał zamówienie,
nip,
panstwo,
panstwo_dostawy,
uwagi,
email,
telefon
id_szablonu - id szablonu można znaleźć w "Administracja" -> "Szablony dokumentów"
id_formy_platnosci - id formy płatnosci można znaleźć w "Administracja" -> "Rodzaje płatności"

Wartości zwracane

Zwracane wartości w przypadku powodzenia:
$dane['result'] - zawiera zmienną id dodanego zamówienia
W przypadku niepowodzenia:
$dane['error']['code']>0

Przykład wywołania w PHP

					 //tablica zawierająca 2 produkty wraz z id produktu i ilością 
					 $produktyARR = array();
					 $produktyARR['produkty'][0] = array('id'=>2,'ilosc'=>1, 'price'=>10.00);
					 $produktyARR['produkty'][1] = array('id'=>3,'ilosc'=>2, 'price'=>20.00);
					 $produkty = http_build_query($produktyARR);
					 $c = curl_init();
					 curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
					 curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
					 curl_setopt($c, CURLOPT_POSTFIELDS, 'act=addOrder'.
								'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
								'&nazwa=Enadis Sp. z o.o.'.
								'&id_zamawiajacego=1'.
								'&kod=81-451'.
								'&miejscowosc=Gdynia'.
								'&nazwa_dostawy=Firma Testowa'.
								'&miejscowosc_dostawy=Warszawa'.
								'&kod_dostawy=01-222'.
								'&ulica_dostawy=Mickiewicza 44/2'.
								'&ulica=al. Zwycięstwa 96/98'.
								'&id_dostawy=1'.
								'&' . $produkty);  //id_dostawy=1 - przesyłka kurierska
					 curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
					 $wynik = curl_exec($c);
					 curl_close($c);
					 $dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
					 
					 if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd, 
																				//jeśli tak, wyświetlamy go
					 echo 'Id nowego zamówienia: ' . $dane['result'];
					



delOrder

Usunięcie istniejącego zamówienia

Wymagane parametry

token,
id - id zamówienia

Opcjonalne parametry

brak

Wartości zwracane

Zwracane wartości w przypadku powodzenia:
$dane['result'] - zawiera zmienną id usuniętego zamówienia
W przypadku niepowodzenia:
$dane['error']['code']>0

Przykład wywołania w PHP


					 $c = curl_init();
					 curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
					 curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
					 curl_setopt($c, CURLOPT_POSTFIELDS, 'act=delOrder'.
								'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
								'&id=4'); 
					 curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
					 $wynik = curl_exec($c);
					 curl_close($c);
					 $dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
					 
					 if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd, 
																				//jeśli tak, wyświetlamy go
					 echo 'Id usunietego zamówienia: ' . $dane['result'];
					



updOrder

Edycja istniejącego zamówienia

Wymagane parametry

token, id, nazwa, kod, miejscowosc, ulica,nazwa_dostawy, kod_dostawy, miejscowosc_dostawy, ulica_dostawy,
id_dostawy - id metody dostawy,
produkty - tablica asocjacyjna zawierająca elementy:
produkty['ilosc'] - ilość danego produktu
produkty['stawka_vat'] - id stawki VAT dla danego produktu
produkty['cena_netto'] - cena netto danego produktu
produkty['cena_brutto'] - cena brutto danego produktu

imie, nazwisko - tylko jeśli nie jest podane id_zamawiajacego

Opcjonalne parametry

naliczanie_brutto - można podać 1, jeśli netto i vat mają być przeliczane z cen brutto produktów
id_zamawiajacego(jesli podamy id_zamawiajacego imie i nazwisko nie jest już potrzebne), id_wojewodztwa,id_wojewodztwa_dostawy,id_statusu,id_obslugujacego,
numer - w przypadku braku pozostaje poprzedni numer,
id_waluty - domyślnie 0 oznaczające PLN,
nip, panstwo, panstwo_dostawy, id_kontrahenta, uwagi, naliczanie_brutto

Wartości zwracane

Zwracane wartości w przypadku powodzenia:
$dane['result'] - zawiera zmienną id edytowanego zamówienia
W przypadku niepowodzenia:
$dane['error']['code']>0

Przykład wywołania w PHP

					 //tablica zawierająca 2 produkty wraz z id produktu i ilością 
					 $produktyARR = array();
					 $produktyARR['produkty'][0] = array('id'=>2,'ilosc'=>1,'cena_netto'=>10,'cena_brutto'=>12.30,'stawka_vat'=>1);
					 $produktyARR['produkty'][1] = array('id'=>3,'ilosc'=>2,'cena_netto'=>5,'cena_brutto'=>6,'stawka_vat'=>1);
					 $produkty = http_build_query($produktyARR);
					 $c = curl_init();
					 curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
					 curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
					 curl_setopt($c, CURLOPT_POSTFIELDS, 'act=updOrder'.
								'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
								'&id=23'.
								'&nazwa=Enadis Sp. z o.o.'.
								'&id_zamawiajacego=1'.
								'&kod=81-451'.
								'&miejscowosc=Gdynia'.
								'&nazwa_dostawy=Firma Testowa'.
								'&miejscowosc_dostawy=Warszawa'.
								'&kod_dostawy=01-222'.
								'&ulica_dostawy=Mickiewicza 44/2'.
								'&ulica=al. Zwycięstwa 96/98'.
								'&id_dostawy=1'.
								'&' . $produkty);  //id_dostawy=1 - przesyłka kurierska
					 curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
					 $wynik = curl_exec($c);
					 curl_close($c);
					 $dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
					 
					 if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd, 
																				//jeśli tak, wyświetlamy go
					 echo 'Id edytowanego zamówienia: ' . $dane['result'];
					



getOrder

Pobranie informacji o istniejącym zamówieniu

Wymagane parametry

token, id

Opcjonalne parametry

brak

Wartości zwracane

Zwracane wartości w przypadku powodzenia:
$dane['result'] - jest tablicą asocjacyjną o wartościach:
suma_brutto, nazwa, kod, nip, miejscowosc, ulica, nazwa_dostawy, kod_dostawy, miejscowosc_dostawy, ulica_dostawy, id_dostawy (id metody dostawy), imie, nazwisko, id_statusu, data_zlozenia, data_zamkniecia, id_obslugujacego,
id_waluty - domyślnie 0 oznaczające PLN,
id_kontrahenta, nip_dostawy, id_skladajacego,
panstwo, panstwo_dostawy, numer, numer_faktury, numer_ciagly
oraz:
$dane['result']['produkty'] - jest tablicą asocjacyjną zwracającą informacje o produktach dla zamówienia:
id_produktu, ilosc, cena_netto, kwota_netto, stawka_vat, kwota_vat, kwota_brutto, nazwa, ilosc_zrealizowana
W przypadku niepowodzenia:
$dane['error']['code']>0

Przykład wywołania w PHP


					 $c = curl_init();
					 curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
					 curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
					 curl_setopt($c, CURLOPT_POSTFIELDS, 'act=getOrder'.
								'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
								'&id=4'); 
					 curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
					 $wynik = curl_exec($c);
					 curl_close($c);
					 $dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
					 
					 if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd, 
																				//jeśli tak, wyświetlamy go
																				
					 echo 'Data złożenia: ' . $dane['result']['data_zlozenia'] . ' Nazwa klienta: ' . $dane['result']['nazwa'] . 
						' Suma brutto: ' . $dane['result']['suma_brutto'] . '
'; // informacje o produktach dla tego zamówienia foreach($dane['result']['produkty'] as $produkty) { echo 'Id produktu: ' . $produkty['id_produktu'] . ' Nazwa: ' . $produkty['nazwa'] . ' Ilość: ' . $produkty['ilosc'] . ' Cena netto: ' . $produkty['cena_netto'] . ' Kwota brutto: ' . $produkty['kwota_brutto'] . '
'; }



getOrderPDF

Pobieranie PDF dla istniejącego zamówienia

Wymagane parametry

token, id

Opcjonalne parametry

brak

Wartości zwracane

Zwracane wartości w przypadku powodzenia:
$dane['result'] - zawiera zmienną file oraz name pobieranego PDF zamówienia
W przypadku niepowodzenia:
$dane['error']['code']>0

Przykład wywołania w PHP


					 $c = curl_init();
					 curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
					 curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
					 curl_setopt($c, CURLOPT_POSTFIELDS, 'act=getOrderPDF'.
								'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
								'&id=4'); 
					 curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
					 $wynik = curl_exec($c);
					 curl_close($c);
					 $dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
					 
					 if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd, 
																				//jeśli tak, wyświetlamy go

					 // dekodujemy i wstawiamy zawartość pliku pdf do zmiennej by potem ją zapisać, lub umożliwić pobranie użytkownikowi
					 $zamowieniePDF = base64_decode($dane['result']['file']);	
					 // nazwa pliku pdf
					 $nazwaPDF = $dane['result']['name'];

					 
					



listOrders

Pobranie listy zamówień

Wymagane parametry

token

Opcjonalne parametry

ids - zmienna zawierająca ID do wyświetlenia w postaci stringu, gdzie separatorem jest "," np. 1,2,4,12,23,45
data_zlozenia_od - zmienna typu "string" zawierająca dolną granicę daty złożenia zamówienia. Zamówienia zostaną pobrane włącznie z tą datą.
data_zlozenia_do - zmienna typu "string" zawierająca górną granicę daty złożenia zamówienia. Zamówienia zostaną pobrane włącznie z tą datą.
id_statusu - zmienna zawierająca ID statusu zamówień, które mają zostać pobrane.

Wartości zwracane

Zwracane wartości w przypadku powodzenia:
$dane['result'] - jest tablicą asocjacyjną o wartościach:
id, suma_brutto, nazwa, kod, nip, miejscowosc, ulica, nazwa_dostawy, kod_dostawy, miejscowosc_dostawy, ulica_dostawy ,id_dostawy (id metody dostawy), imie, nazwisko, id_statusu, data_zlozenia, data_zamkniecia, id_obslugujacego,
id_waluty - domyślnie 0 oznaczające PLN,
id_kontrahenta, nip_dostawy, id_skladajacego,
panstwo, panstwo_dostawy, numer, numer_faktury, numer_ciagly
oraz:
W przypadku niepowodzenia:
$dane['error']['code']>0

Przykład wywołania w PHP


					 $c = curl_init();
					 curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
					 curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
					 curl_setopt($c, CURLOPT_POSTFIELDS, 'act=listOrders'.
								'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
								'&ids=3,4,5,6,7'); 
					 curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
					 $wynik = curl_exec($c);
					 curl_close($c);
					 $dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
					 
					 if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd, 
																				//jeśli tak, wyświetlamy go
																				
					 echo 'Data złożenia: ' . $dane['result']['data_zlozenia'] . ' Nazwa klienta: ' . $dane['result']['nazwa'] . 
						' Suma brutto: ' . $dane['result']['suma_brutto'] . '
'; // informacje o produktach dla tego zamówienia foreach($dane['result'] as $id=>$dane) { echo 'Id zamówienia: ' . $id . ' Nazwa: ' . $dane['nazwa'] . ' Data złożenia: ' . $dane['data_zlozenia'] . ' Suma brutto: ' . $dane['suma_brutto'] . ' Id kontrahenta: ' . $dane['id_kontrahenta'] . '
'; }



changeOrderStatus

Zmiana statusu istniejącego zamówienia

Wymagane parametry

token, id, id_statusu

Opcjonalne parametry

brak

Wartości zwracane

Zwracane wartości w przypadku powodzenia:
$dane['result'] - zawiera zmienną id zamiana statusu dla istniejącego zamówienia
W przypadku niepowodzenia:
$dane['error']['code']>0

Przykład wywołania w PHP


					 $c = curl_init();
					 curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
					 curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
					 curl_setopt($c, CURLOPT_POSTFIELDS, 'act=changeOrderStatus'.
								'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
								'&id=4'.
								'&id_statusu=2'); 
					 curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
					 $wynik = curl_exec($c);
					 curl_close($c);
					 $dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
					 
					 if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd, 
																				//jeśli tak, wyświetlamy go
					 echo 'Id zamówienia dla którego zmieniono status : ' . $dane['result'];
					 
					



listOrderStatus

Pobranie listy możliwych statusów zamówienia

Wymagane parametry

token

Opcjonalne parametry

brak

Wartości zwracane

Zwracane wartości w przypadku powodzenia:
$dane['result'] - jest tablicą asocjacyjną o wartościach:
id, nazwa oraz:
W przypadku niepowodzenia:
$dane['error']['code']>0

Przykład wywołania w PHP


					 $c = curl_init();
					 curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
					 curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
					 curl_setopt($c, CURLOPT_POSTFIELDS, 'act=listOrders'.
								'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f'); 
					 curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
					 $wynik = curl_exec($c);
					 curl_close($c);
					 $dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
					 
					 if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd, 
																				//jeśli tak, wyświetlamy go
																			
					 
					 // informacje o produktach dla tego zamówienia
					 
					 foreach($dane['result'] as $i=>$dane)
					 {
						echo 'Id: ' . $dane['id'] . ' Nazwa: ' . $dane['nazwa'] . '
'; }
Wersja DEMO - przetestuj za darmo! Załóż konto Systim w 15 sekund!