API – Produkty - Baza Wiedzy programu Comarch Betterfly

POBIERANIE PRODUKTÓW

Pobieranie produktów: [GET] https://app.comarchbetterfly.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
Quantity	Ilość produktu na stanie magazynowym
ProductType	Rodzaj produktu: 0 – usługa 1 – towar 2 – towar z kontrolą stanu
Id	ID produktu w bazie danych

Przykładowa odpowiedź JSON:

[code_snippet id=19]

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

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

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

Przykładowa odpowiedź JSON:

[code_snippet id=20]

Dostępne jest również opcja filtrowanie listy produktów:

wg nazwy: [GET] https://app.comarchbetterfly.pl/api2/public/products/?$filter=Name eq {nazwa}
wg kodu: [GET] https://app.comarchbetterfly.pl/api2/public/products/?$filter=ProductCode eq {kod_produktu}

Wskazówka

Filtrować można z użyciem kilku kryteriów wykorzystując wspierane operatory logiczne: or, and, not oraz operatory do porównań: eq (równość), ne (nierówność), gt (większe od), ge (większe lub równe), lt (mniejsze od), le (mniejsze lub równe)

Przykład

[GET] https://app.comarchbetterfly.pl/api2/public/products/?$filter=Name eq 'Produkt' or ProductCode eq 'P/000001'
[GET] https://app.comarchbetterfly.pl/api2/public/products/?$filter=SaleGrossPrice ge 199.99 and SaleGrossPrice le 300

DODAWANIE NOWEGO PRODUKTU

Dodawanie produktu: [POST] https://app.comarchbetterfly.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¹
UnitOfMeasurment	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

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:

[code_snippet id=21]

W odpowiedzi zostanie wysłane ID dodanego produktu.

EDYCJA KARTY PRODUKTU

Edycja produktu: [PUT] https://app.comarchbetterfly.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
UnitOfMeasurment	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=12156943):

[code_snippet id=22]

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

USUWANIE PRODUKTU

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

Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.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.