Dokumentacja Comarch Optima API: encje przez REST API
Każda encja to osobna strona z listą endpointów, przykładami JSON, scenariuszami integracyjnymi i pułapkami wdrożeniowymi znanymi z realnych wdrożeń.
REST API Comarch Optima działa jako lokalna usługa sieciowa obok programu Comarch ERP Optima, dzięki czemu integracja może wykonywać operacje bez ręcznego klikania w oknach systemu.
To nie jest pełna dokumentacja API
Ta sekcja opisuje wybrane encje w szczegółach — scenariusze i pułapki wdrożeniowe. Strony są uzupełniane sukcesywnie. Kompletna dokumentacja wszystkich 976 endpointów (Swagger / OpenAPI) dostępna jest po uruchomieniu Optima API u Ciebie.
Którą encję Optima API wybrać do integracji
Comarch Optima API dokumentacja powinna zaczynać się od encji biznesowej, a nie od samej metody HTTP. Jeśli integrujesz sklep internetowy, CRM, WMS albo aplikację B2B, najpierw wybierz zasób: kontrahenci, towary, faktury sprzedaży, dokumenty magazynowe, płatności lub atrybuty.
Każda strona encji pokazuje, które endpointy Optima API są potrzebne w typowym procesie, jakie pola DTO mają znaczenie i gdzie pojawiają się pułapki Comarch ERP Optima: walidacja NIP, partial update, batch, bufor dokumentu, magazyn, rozrachunki i atrybuty zależne od kontrahenta.
| Cel integracji | Pierwsza encja | Typowe endpointy |
|---|---|---|
| Sklep internetowy lub marketplace | Towary, kontrahenci, faktury sprzedaży | GET, POST, batch/read |
| CRM, B2B albo panel klienta | Kontrahenci, płatności, atrybuty | GET, PUT, batch/update |
| Magazyn, WMS lub automatyzacja stanów | Towary, dokumenty magazynowe, cenniki | sync, batch/read, POST |
API do Comarch ERP Optima
API do Comarch ERP Optima pozwala pobierać informacje z programu Comarch ERP Optima i przenosić je do innych aplikacji bez bezpośredniego zapisu do bazy danych. Web API obsługuje m.in. kontrahentów, towary, faktury sprzedaży i dokumenty magazynowe.
Dokumenty handlowe i księgowe
Dokumentacja pokazuje dodawanie dokumentów handlowych, tworzenie dokumentów powiązanych, obsługę rejestru VAT, płatności i rozrachunków. Każdy endpoint opisuje format komunikatu JSON oraz walidację po stronie Comarch ERP.
Integracja w czasie rzeczywistym
Optima API oferuje automatyzację integracji z e-commerce, CRM, WMS i systemem zewnętrznym. Dzięki temu własne rozwiązania mogą działać w czasie rzeczywistym: pobierać dane, zapisywać zmiany i synchronizować stany magazynowe.
Jak wygląda API do Comarch ERP w praktyce
Wdrożenie łączy program Comarch ERP Optima, lokalny serwer WebAPI i dokumentację OpenAPI. Taki układ pozwala odczytywać dane z Optimy, testować format tworzenia komunikatów JSON i integrować aplikacją zewnętrzną bez ręcznego zapisu do tabel SQL.
Comarch ERP Optima WebAPI w tym wariancie dotyczy Optimy, a nie Comarch ERP XL. Jeśli porównujesz oba systemy, traktuj tę dokumentację jako opis endpointów dla Optimy i granic, w których własne rozwiązania mogą pracować z jej modułami handlowymi.
Architektura pokazuje, gdzie działa oprogramowanie sieciowe i jak oddziela systemem zewnętrznym od logiki Comarch ERP.
Swagger opisuje endpoint, parametry i komunikat JSON, zanim dodawanie dokumentów albo pobieranie informacji trafi na produkcję.
Program Comarch ERP Optima pozostaje źródłem danych, a API do Comarch ERP porządkuje odczyt, zapis i automatyzację.
Logistyka (Handel / Magazyn)
Cały moduł →Comarch Optima faktury API — zdalne wystawianie FS
Zdalne wystawienie faktury z Comarch Optima przez REST API. 14 endpointów, dane nabywcy i odbiorcy, VAT, KSeF, płatności, bufor i WZ.
Towary w Comarch Optima przez REST API
Kartoteka towarów i usług Comarch Optima przez REST. 25 endpointów, TowarDto, stany magazynowe, cenniki, atrybuty zależne od kontrahenta, jednostki miary, incremental sync z kursorem.
Comarch ERP Optima — co znajdziesz w dokumentacji encji
Optima API to gotowy serwer Web API, który nadbudowuje warstwę HTTP/JSON nad Comarch ERP Optima. Zamiast pisać własną integrację po obiektach COM lub łączyć się bezpośrednio do bazy SQL, korzystasz z gotowych endpointów: pobranie kontrahenta po id lub kodzie, dodawanie towarów do kartoteki, dodawanie dokumentów handlowych i magazynowych, aktualizacja faktury sprzedaży, wystawienie korekty. Każda operacja przechodzi przez oficjalną warstwę biznesową Optimy — walidacja działa identycznie jak przy ręcznej pracy w oknie programu.
Dokumentacja encji opisuje, jak każdy zasób biznesowy Comarch ERP wygląda przez Web API: lista endpointów, pola DTO, scenariusze integracji i znane pułapki wdrożeniowe.
Każda encja to osobny moduł — kontrahenci z modułu Ogólne, towary i kartoteka produktów z modułu Handel, faktury sprzedaży i pozostałe dokumenty handlowe (paragony, faktury zakupu, zamówienie do dostawcy) z modułu Handel, dokumenty magazynowe (WZ, PZ, MM) z modułu Magazyn, płatności i rozrachunki z modułu Kasa/Bank, dane księgowe z Księgi Handlowej.
Strony encji są aktualne dla najnowszej wersji Comarch ERP Optima. Każda kolejna wersja Optimy jest weryfikowana — nowa wersja oprogramowania pojawia się równolegle z aktualizacją Comarcha. Twoja integracja nie ląduje w ślepej uliczce przy update wersji.
Comarch Optima REST API — trzy operacje na start
Każda strona encji jest poukładana tak samo: lista endpointów (GET, POST, PUT, DELETE), kontrakt JSON pól DTO, przykłady curl, scenariusze biznesowe i pułapki.
Trzy podstawowe operacje, które wykonasz w pierwszej godzinie wdrożenia:
Pobranie i pobieranie danych z Optimy
GET na konkretną encję zwraca pełny obiekt JSON. Pobranie kontrahenta po unikalnym kodzie — GET /api/kontrahenci/{kod}. Pobranie po id wewnętrznym — GET /api/kontrahenci/id/{id}. Pobieranie listy towarów po identyfikatorach (do 500 naraz) — POST /api/towary/batch/read. Wyszukiwanie po fragmencie nazwy lub kodu działa jak autocomplete w panelu B2B i jest szybkie (typowo poniżej 100 ms), bo idzie przez SQL-ową ścieżkę odczytową.
Dodawanie i aktualizacja kontrahentów, towarów, dokumentów handlowych
POST tworzy nowy rekord. Dodawanie kontrahenta — POST /api/kontrahenci/. Dodawanie towaru z pełnym cennikiem — POST /api/towary/. Dodawanie dokumentów handlowych (faktury sprzedaży, faktury zakupu, paragony, wydania zewnętrzne, przyjęcia zewnętrzne, rezerwacje, zamówienie do dostawcy) realizuje się przez POST /api/dokumenty/faktury-sprzedazy/ i odpowiednie endpointy dla pozostałych typów. Korekta wystawia się jako osobny dokument typu FSK powiązany z dokumentem źródłowym. Batch do 100 elementów na żądanie. Aktualizacja przez PUT z partial update — pole pominięte oznacza brak zmiany, pusty string czyści wartość.
Synchronizacja w czasie rzeczywistym i automatyzacja procesów
Endpoint GET /api/sync/towary zwraca tylko towary zmodyfikowane od podanego timestampu, z kursorem dla kolejnych stron. To pozwala na pobieranie tylko zmienionych pozycji w dużych katalogach produktów (50 000+ pozycji) bez transferu wszystkiego za każdym razem. Pełna automatyzacja procesów wymiany danych ze sklepem działa przez VerSync — silnik kolejkowania, retry, dead-letter queue i monitoring out-of-the-box. Rozwiązanie pokrywa zarówno scenariusz „sklep → Optima" (zamówienie, klient), jak i „Optima → sklep" (stany, ceny, opisy).
Comarch Optima REST API — najczęstsze pytania
Comarch ERP Optima w wersji standardowej nie posiada wbudowanego, publicznego Web API. Optima udostępnia integratorom obiekty COM oraz dostęp do bazy SQL. Optima API od WebArm to dodatkowa warstwa: lokalny serwer HTTP, który eksponuje wszystkie kluczowe encje Comarcha przez gotowy interfejs JSON. Stanowi praktyczne rozwiązanie dla integracji ze sklepem internetowym, CRM-em, narzędziami AI lub innymi aplikacjami biznesowymi — zarówno przy nowym wdrożeniu, jak i wymianę istniejącej integracji COM na nowoczesną architekturę Web API.
Najszybsza ścieżka integracji sklepu z Comarch ERP Optima: instalacja Optima API obok programu (jeden serwer z licencją Comarcha), konfiguracja klucza, mapowanie zamówień ze sklepu na POST /api/dokumenty/faktury-sprzedazy/ oraz synchronizacja stanów przez POST /api/towary/stany/batch/read. Pełny przewodnik krok po kroku — integracja sklepu internetowego z Comarch Optima. Wdrożenie podstawowe zajmuje od kilku dni do dwóch tygodni i nie generuje dodatkowych kosztów licencyjnych po stronie Comarcha.
Zdalne wystawienie faktury sprzedaży to pojedynczy POST /api/dokumenty/faktury-sprzedazy/ z payloadem zawierającym kod kontrahenta, datę dokumentu, datę sprzedaży, magazyn i co najmniej jedną pozycję (kod towaru, ilość, cena netto, stawka VAT). Comarch sam nadaje numer pełny, przelicza wartości, generuje powiązany dokument WZ i tworzy rozrachunek w module Kasa/Bank. Faktura może wyjść z bufora od razu (bufor=0) albo czekać na zatwierdzenie. Pełny opis pól i pułapek — faktury sprzedaży. Korekta wystawia się jako osobny dokument typu FSK powiązany z fakturą źródłową.
WebArm to producent Optima API i firma wdrożeniowa specjalizująca się w integracjach Comarch ERP Optima z e-commerce, B2B, marketplace i innymi aplikacjami zewnętrznymi. Realizujemy pełen zakres: analiza, instalacja oprogramowania, mapowanie procesów, integracja po stronie sklepu, monitoring produkcyjny, utrzymanie. Skontaktuj się przez formularz kontaktowy — odpowiemy w ciągu dnia roboczego z konkretną wyceną i harmonogramem wdrożenia dla Twojego biznesu.
Synchronizacja stanów magazynowych Comarch ERP Optima ze sklepem internetowym działa przez VerSync — narzędzie WebArm konfigurowane w pliku YAML. Domyślny harmonogram pobiera stany co 30 sekund przez POST /api/towary/stany/batch/read i wypycha różnice do platformy e-commerce. Wspierane są wszystkie popularne sklepy (WooCommerce, PrestaShop, Shopify, custom). Szczegółowy opis konfiguracji — automatyczna synchronizacja stanów magazynowych. Dla wielokanałowej sprzedaży (sklep + marketplace) ten sam silnik obsługuje wymianę z kilkoma platformami z jednego źródła w Optimie.
Synchronizację kontrahentów między Comarch ERP a CRM-em (HubSpot, Pipedrive, Salesforce) lub sklepem realizujemy w WebArm na bazie endpointów encji kontrahenci. VerSync orkiestruje cykl: webhook ze źródła, deduplikacja po NIP lub e-mail, POST /api/kontrahenci/ dla nowych, PUT /api/kontrahenci/{kod} dla aktualizacji, retry przy błędach. Pojedyncze wdrożenie pokrywa zwykle synchronizację kontrahentów, towarów i dokumentów handlowych — niezależnie od liczby platform docelowych.
Co dalej — wdrożenie Web API w Twoim biznesie
Optima API i VerSync dają komplet potrzebny do produkcyjnej integracji Comarch ERP z innymi aplikacjami: Web API z pełnym pokryciem encji Comarcha, silnik synchronizacji, monitoring i wsparcie wdrożeniowe. Bez ukrytych opłat licencyjnych po stronie Comarcha — używasz licencji, którą już posiadasz. Bez dodatkowych kosztów infrastruktury — oprogramowanie instaluje się obok Comarch ERP Optima na tym samym serwerze.
Powiązane materiały: dlaczego Comarch nie oferuje publicznego REST, REST kontra obiekty COM — porównanie metod integracji, automatyczne zamówienia ze sklepu do Optimy, pełne pokrycie modułów Comarcha, case study: synchronizacja produktów Kapelanczyk. Listing wszystkich modułów Optimy — Optima API — przegląd.
Nie widzisz encji, której potrzebujesz?
Strony encji to przykład rozszerzonej dokumentacji — scenariusze wdrożeniowe, pułapki, przykłady JSON. Pełna lista wszystkich endpointów dostępna jest w Swagger/OpenAPI po uruchomieniu Optima API.