API – Produkty

POBIERANIE PRODUKTÓW

Pobieranie produktów: [GET] https://app.erpxt.pl/api2/public/products

Opis struktury JSON odpowiedzi:

Parametr Opis
$id Numer porządkowy w ramach odpowiedzi JSON
Name Nazwa produktu
Description Opis produktu
ItemCode Numer klasyfikacyjny PKWiU
ProductCode Kod produktu
UnitOfMeasurment Jednostka miary
Rate Oznaczenie odpowiedniej stawki VAT wg poniższego klucza:
9 – 23%
8 – 8%
7 – 5%
6 – 4%
2 – 0%
1 – zwolniony
0 – nie podlega
SaleNetPrice Cena netto sprzedaży w PLN
SaleGrossPrice Cena brutto sprzedaży w PLN
Id ID produktu w bazie danych

Przykładowa odpowiedź JSON:

Możliwe jest także pobranie karty określonego produktu.

[GET] https://app.erpxt.pl/api2/public/products/XXX (gdzie XXX to Id produktu w bazie danych)

Przykładowe zapytanie: [GET] https://app.erpxt.pl/api2/public/products/3

Przykładowa odpowiedź JSON:

DODAWANIE NOWEGO PRODUKTU

Dodawanie produktu: [POST] https://app.erpxt.pl/api2/public/products

Opis struktury JSON zapytania:

Parametr Opis Czy parametr obowiązkowy?
Name Nazwa produktu Tak
Description Opis produktu Nie
ItemCode Numer klasyfikacyjny PKWiU Nie
ProductCode Kod produktu Nie1
UnitOfMeasurement Jednostka miary Tak
SaleNetPrice Cena netto sprzedaży w PLN Nie2
SaleGrossPrice Cena brutto sprzedaży w PLN Nie2
Rate Oznaczenie odpowiedniej stawki VAT wg poniższego klucza:
9 – 23%
8 – 8%
7 – 5%
6 – 4%
2 – 0%
1 – zwolniony
0 – nie podlega
Tak

1) W przypadku braku kodu zostanie on nadany poprzez serwer.

2) W przypadku podania ceny brutto, cena netto zostanie wyliczona automatycznie. W przypadku podania ceny netto, cena brutto zostanie wyliczona automatycznie. W przypadku podania obu cen, system wyliczy cenę brutto od podanej ceny netto.

Przykładowe zapytanie JSON:

W odpowiedzi zostanie wysłane ID dodanego produktu.

Przykładowa odpowiedź:

EDYCJA KARTY PRODUKTU

Edycja produktu: [PUT] https://app.erpxt.pl/api2/public/products

Opis struktury JSON zapytania:

Parametr Opis Czy parametr obowiązkowy?
Name Nazwa produktu Tak
Description Opis produktu Nie
ItemCode Numer klasyfikacyjny PKWiU Nie
ProductCode Kod produktu Nie
UnitOfMeasurement Jednostka miary Tak
SaleNetPrice Cena netto sprzedaży w PLN Nie
SaleGrossPrice Cena brutto sprzedaży w PLN Nie
Rate Oznaczenie odpowiedniej stawki VAT wg poniższego klucza:
9 – 23%
8 – 8%
7 – 5%
6 – 4%
2 – 0%
1 – zwolniony
0 – nie podlega
Tak
Id ID produktu w bazie danych Tak
Uwaga
W przypadku pominięcia parametrów nieobowiązkowych, zostaną one nadpisane domyślnymi lub pustymi wartościami.

W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi:

Przykładowe zapytanie JSON (zmiana ceny dla produktu o Id=1):

Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem:

USUWANIE PRODUKTU

Usuwanie produktu: [DEL] https://app.erpxt.pl/api2/public/products/XXX (gdzie XXX to Id produktu w bazie danych)

Przykładowe zapytanie: [DEL] https://app.erpxt.pl/api2/public/products/4

Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem:

Uwaga
Nie można usuwać produktów, które posiadają aktywną funkcję kontroli stanu magazynowego.

Czy ten artykuł był pomocny?