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/itemsGETPOSTPUTDELETE

Towary.

/api/items/barcodesPOST

Czytnik kodów kreskowych dla towarów.

/api/items/copyPOST

Kopiowanie towaru pod nowym kodem — razem ze zdjęciami, opisami i parametrami.

/api/items/exportsGETPOSTPUTDELETE

Zapisane definicje plików produktowych.

/api/items/exports/downloadPOST

Jednorazowy eksport towarów — pobranie pliku na dysk.

/api/items/exports/previewPOST

Podgląd pierwszych pozycji pliku.

/api/items/exports/runPOST

Odświeżenie pliku cyklicznego na żądanie.

/api/items/generate_manyPOST

Generowanie serii towarów o kolejnych kodach — używane przy zakładaniu nowego asortymentu, zanim uzupełni się dane pojedynczych towarów.

/api/items/mass_deletePOST

Masowe usuwanie towarów — z rozbiciem wyniku na udane, błędne i nieznalezione.

/api/items/mass_editPOST

Masowa edycja towarów.

/api/items/summary_homepageGET

Podsumowanie towarów na pulpicie: ile towarów, zdjęć, sztuk i miejsca na dysku.

Zamówienia

/api/ordersGETPOSTPUTDELETE

Zamówienia.

/api/orders/barcodesPOST

Czytnik kodów kreskowych dla zamówień — ścieżka pakowania.

/api/orders/copyPOST

Kopia zamówienia — bez numeru listu przewozowego i bez numeru faktury.

/api/orders/dividePOST

Podział zamówienia na dwa.

/api/orders/export_csvPOST

Zestawienie zamówień z zakresu dat jako CSV.

/api/orders/mass_deletePOST

Masowe usuwanie zamówień.

/api/orders/mass_editPOST

Masowa edycja zamówień: koszt i VAT dostawy, status, źródło przychodu.

/api/orders/packing_viewPOST

Podgląd zamówienia — jeden dla listy i dla stanowiska pakowania.

/api/orders/print_bolPOST

Druk listu przewozowego.

/api/orders/print_bol_manyPOST

Nadanie i listy przewozowe dla partii zamówień.

/api/orders/print_invoicePOST

Wystawienie i druk faktury do zamówienia.

/api/orders/print_invoice_manyPOST

Faktury do wielu zamówień naraz, sklejone w jeden plik.

/api/orders/print_labelPOST

Etykieta tymczasowa zamówienia — kartka na czas kompletowania paczki.

/api/orders/print_label_manyPOST

Etykiety tymczasowe dla partii zamówień.

/api/orders/print_receiptPOST

Wystawienie i druk paragonu do zamówienia.

/api/orders/send_parcelPOST

Nadanie przesyłki bez druku etykiety — odpowiednik kodu „nadaj przesyłkę".

/api/orders/sizesPUT

Waga i wymiary paczki wpisane ręcznie.

/api/orders/summary_mainGET

Kafelki sprzedażowe na pulpicie: dziś, wczoraj, 7 i 30 dni, dwa miesiące.

Magazyn

/api/warehouse_changesGETPUTDELETE

Zmiany stanów magazynowych.

/api/warehouse_changes/export_csvGET

Eksport zmian stanów do CSV.

Pluginy

/api/plugin/[plugin]/[...path]GETPOSTPUTDELETE

Dispatcher pluginów: `/api/plugin/<pluginId>/<ścieżka>`.

Wydruki i stanowiska

/api/print/agentsGETPOSTPUTDELETE

Stanowiska z agentem drukowania.

/api/print/agents/tokenPOST

Wymiana 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/itemPOST

Arkusz kodów towarów.

/api/print/barcode/item_add_subPOST

Arkusz kodów zmiany ilości.

/api/print/barcode/item_groupPOST

/api/print/barcode/item_statusPOST

/api/print/barcode/orderPOST

Arkusz kodów zamówień — naklejany na wydruki i listy kompletacyjne.

/api/print/barcode/order_statusPOST

/api/print/barcode/otherPOST

Arkusz kodów sterujących wysyłką — ten, który wisi przy stanowisku pakowania.

/api/print/barcode/placePOST

/api/print/barcode/sizePOST

Arkusz kodów wymiarów paczki.

/api/print/barcode/user_sizePOST

Arkusz kodów rozmiarów zdefiniowanych — jeden skan ustawia wszystkie trzy boki paczki naraz.

/api/print/barcode/weightPOST

Arkusz kodów wagi paczki.

/api/print/sendPOST

Wydruk na stanowisku — bez okna dialogowego.

Agent drukowania

/api/agent/ackPOST

Kwitowanie zadania przez agenta.

/api/agent/pollPOST

Odpytanie agenta o zadania.

Słowniki

/api/carriersGET

Przewoźnicy z metodami dostawy.

/api/categoriesGETPOSTPUTDELETE

Kategorie towarów — drzewo.

/api/data/countriesGET

Kraje w formularzach adresowych.

/api/data/languagesGET

Języki interfejsu — panel mówi po polsku, strona także po angielsku.

/api/data/permissions_infoGET

Opis uprawnień dla ekranu użytkowników: klucz, sekcja i nazwa po polsku.

/api/optionsGETPUT

Opcje organizacji.

/api/parametersGETPOSTPUTDELETE

Parametry towarów.

/api/placesGETPOSTPUTDELETE

Miejsca w magazynie — drzewo, jak kategorie.

Pozostałe

/apiGET

Strona testowa API.

/api/barcodeGET

Obraz pojedynczego kodu kreskowego (PNG).

/api/billingGET

Stan abonamentu organizacji i historia płatności.

/api/billing/notifyPOST

Powiadomienie z PayU o zmianie stanu płatności.

/api/billing/payPOST

Rozpoczęcie płatności za abonament.

/api/captchaGET

Kod CAPTCHA do rejestracji.

/api/check_pickup_pointGET

Sprawdzenie, czy punkt odbioru istnieje u przewoźnika.

/api/healthGET

Stan aplikacji dla monitoringu i deploya.

/api/image/[prefix]/[name]GET

Zdjęcie towaru.

/api/jobs/[name]/[id]GET

Stan zleconego zadania.

/api/kontaktPOST

Formularz kontaktowy ze strony.

/api/order_buyer_infoGET

Informacja o zamówieniu dla kupującego.

/api/orders_summaryGET

Miesięczne zestawienie sprzedaży: przychody w podziale na grupy towarów, statusy zamówień i przedrostki kodów, plus statystyki.

/api/organizationGETPUT

Dane organizacji drukowane na dokumentach.

/api/parameters/dictionaryPUT

Same wartości słownika parametru.

/api/plik/[prefix]/[token]GET

Plik produktowy pod stałym adresem.

/api/plugin_infoGET

Informacje o pluginach: co jest dostępne i co włączone dla organizacji.

/api/plugin_installPOSTDELETE

Włączanie i wyłączanie pluginów dla organizacji.

/api/registerGETPOST

Rejestracja organizacji.

/api/upload_imagePOST

Wgranie zdjęcia towaru.

/api/usersGETPOSTPUTDELETE

Użytkownicy organizacji.

/api/warehousesGETPOSTPUTDELETE

Magazyny organizacji.

/api/warehouses/stockPUT

Stan i miejsce towaru w jednym magazynie.

/api/warehouses/transferPOST

Przesunięcie towaru między magazynami.

Potrzebujecie czegoś, czego tu nie ma? Napiszcie na hello@sellbasis.com.