Dokumentacja API
Te same 84 tras, z których korzysta panel — bez osobnego, „publicznego" API o innym zachowaniu. Spis czytamy wprost z kodu aplikacji, więc nie rozjeżdża się z rzeczywistością.
Logowanie
Sesja z panelu (ciasteczko) albo token API wystawiony użytkownikowi. Login ma postać prefiks/użytkownik — prefiks wskazuje organizację, a więc i bazę danych.
Format odpowiedzi
JSON. Błąd zawsze wygląda tak samo: { error: { code, message } }. Kwoty są tekstem z dwoma miejscami po przecinku, daty w UTC.
Uprawnienia
Każdy endpoint sprawdza uprawnienie użytkownika — te same, które ustawiacie w panelu. Brak uprawnienia to odpowiedź 403, nie pusta lista.
Towary
/api/itemsGETPOSTPUTDELETETowary.
/api/items/barcodesPOSTCzytnik kodów kreskowych dla towarów.
/api/items/copyPOSTKopiowanie towaru pod nowym kodem — razem ze zdjęciami, opisami i parametrami.
/api/items/exportsGETPOSTPUTDELETEZapisane definicje plików produktowych.
/api/items/exports/downloadPOSTJednorazowy eksport towarów — pobranie pliku na dysk.
/api/items/exports/previewPOSTPodgląd pierwszych pozycji pliku.
/api/items/exports/runPOSTOdświeżenie pliku cyklicznego na żądanie.
/api/items/generate_manyPOSTGenerowanie serii towarów o kolejnych kodach — używane przy zakładaniu nowego asortymentu, zanim uzupełni się dane pojedynczych towarów.
/api/items/mass_deletePOSTMasowe usuwanie towarów — z rozbiciem wyniku na udane, błędne i nieznalezione.
/api/items/mass_editPOSTMasowa edycja towarów.
/api/items/summary_homepageGETPodsumowanie towarów na pulpicie: ile towarów, zdjęć, sztuk i miejsca na dysku.
Zamówienia
/api/ordersGETPOSTPUTDELETEZamówienia.
/api/orders/barcodesPOSTCzytnik kodów kreskowych dla zamówień — ścieżka pakowania.
/api/orders/copyPOSTKopia zamówienia — bez numeru listu przewozowego i bez numeru faktury.
/api/orders/dividePOSTPodział zamówienia na dwa.
/api/orders/export_csvPOSTZestawienie zamówień z zakresu dat jako CSV.
/api/orders/mass_deletePOSTMasowe usuwanie zamówień.
/api/orders/mass_editPOSTMasowa edycja zamówień: koszt i VAT dostawy, status, źródło przychodu.
/api/orders/packing_viewPOSTPodgląd zamówienia — jeden dla listy i dla stanowiska pakowania.
/api/orders/print_bolPOSTDruk listu przewozowego.
/api/orders/print_bol_manyPOSTNadanie i listy przewozowe dla partii zamówień.
/api/orders/print_invoicePOSTWystawienie i druk faktury do zamówienia.
/api/orders/print_invoice_manyPOSTFaktury do wielu zamówień naraz, sklejone w jeden plik.
/api/orders/print_labelPOSTEtykieta tymczasowa zamówienia — kartka na czas kompletowania paczki.
/api/orders/print_label_manyPOSTEtykiety tymczasowe dla partii zamówień.
/api/orders/print_receiptPOSTWystawienie i druk paragonu do zamówienia.
/api/orders/send_parcelPOSTNadanie przesyłki bez druku etykiety — odpowiednik kodu „nadaj przesyłkę".
/api/orders/sizesPUTWaga i wymiary paczki wpisane ręcznie.
/api/orders/summary_mainGETKafelki sprzedażowe na pulpicie: dziś, wczoraj, 7 i 30 dni, dwa miesiące.
Magazyn
/api/warehouse_changesGETPUTDELETEZmiany stanów magazynowych.
/api/warehouse_changes/export_csvGETEksport zmian stanów do CSV.
Pluginy
/api/plugin/[plugin]/[...path]GETPOSTPUTDELETEDispatcher pluginów: `/api/plugin/<pluginId>/<ścieżka>`.
Wydruki i stanowiska
/api/print/agentsGETPOSTPUTDELETEStanowiska z agentem drukowania.
/api/print/agents/tokenPOSTWymiana tokenu stanowiska — po zmianie komputera albo gdy token wyciekł.
/api/print/barcode/categoryPOST/api/print/barcode/delivery_price_listPOST/api/print/barcode/delivery_timePOST/api/print/barcode/income_sourcePOST/api/print/barcode/itemPOSTArkusz kodów towarów.
/api/print/barcode/item_add_subPOSTArkusz kodów zmiany ilości.
/api/print/barcode/item_groupPOST/api/print/barcode/item_statusPOST/api/print/barcode/orderPOSTArkusz kodów zamówień — naklejany na wydruki i listy kompletacyjne.
/api/print/barcode/order_statusPOST/api/print/barcode/otherPOSTArkusz kodów sterujących wysyłką — ten, który wisi przy stanowisku pakowania.
/api/print/barcode/placePOST/api/print/barcode/sizePOSTArkusz kodów wymiarów paczki.
/api/print/barcode/user_sizePOSTArkusz kodów rozmiarów zdefiniowanych — jeden skan ustawia wszystkie trzy boki paczki naraz.
/api/print/barcode/weightPOSTArkusz kodów wagi paczki.
/api/print/sendPOSTWydruk na stanowisku — bez okna dialogowego.
Agent drukowania
/api/agent/ackPOSTKwitowanie zadania przez agenta.
/api/agent/pollPOSTOdpytanie agenta o zadania.
Słowniki
/api/carriersGETPrzewoźnicy z metodami dostawy.
/api/categoriesGETPOSTPUTDELETEKategorie towarów — drzewo.
/api/data/countriesGETKraje w formularzach adresowych.
/api/data/languagesGETJęzyki interfejsu — panel mówi po polsku, strona także po angielsku.
/api/data/permissions_infoGETOpis uprawnień dla ekranu użytkowników: klucz, sekcja i nazwa po polsku.
/api/optionsGETPUTOpcje organizacji.
/api/parametersGETPOSTPUTDELETEParametry towarów.
/api/placesGETPOSTPUTDELETEMiejsca w magazynie — drzewo, jak kategorie.
Pozostałe
/apiGETStrona testowa API.
/api/barcodeGETObraz pojedynczego kodu kreskowego (PNG).
/api/billingGETStan abonamentu organizacji i historia płatności.
/api/billing/notifyPOSTPowiadomienie z PayU o zmianie stanu płatności.
/api/billing/payPOSTRozpoczęcie płatności za abonament.
/api/captchaGETKod CAPTCHA do rejestracji.
/api/check_pickup_pointGETSprawdzenie, czy punkt odbioru istnieje u przewoźnika.
/api/healthGETStan aplikacji dla monitoringu i deploya.
/api/image/[prefix]/[name]GETZdjęcie towaru.
/api/jobs/[name]/[id]GETStan zleconego zadania.
/api/kontaktPOSTFormularz kontaktowy ze strony.
/api/order_buyer_infoGETInformacja o zamówieniu dla kupującego.
/api/orders_summaryGETMiesięczne zestawienie sprzedaży: przychody w podziale na grupy towarów, statusy zamówień i przedrostki kodów, plus statystyki.
/api/organizationGETPUTDane organizacji drukowane na dokumentach.
/api/parameters/dictionaryPUTSame wartości słownika parametru.
/api/plik/[prefix]/[token]GETPlik produktowy pod stałym adresem.
/api/plugin_infoGETInformacje o pluginach: co jest dostępne i co włączone dla organizacji.
/api/plugin_installPOSTDELETEWłączanie i wyłączanie pluginów dla organizacji.
/api/registerGETPOSTRejestracja organizacji.
/api/upload_imagePOSTWgranie zdjęcia towaru.
/api/usersGETPOSTPUTDELETEUżytkownicy organizacji.
/api/warehousesGETPOSTPUTDELETEMagazyny organizacji.
/api/warehouses/stockPUTStan i miejsce towaru w jednym magazynie.
/api/warehouses/transferPOSTPrzesunięcie towaru między magazynami.
Potrzebujecie czegoś, czego tu nie ma? Napiszcie na hello@sellbasis.com.