Dokumentacja API

Publiczne API Zakito.Venzi - połącz zamówienia, faktury, statusy i przesyłki z zewnętrznymi systemami.

Wprowadzenie

API pozwala odczytywać i zmieniać dane Twojej firmy z Zakito.Venzi w formacie JSON - zamówienia, faktury, statusy, źródła i przesyłki. Odczyt to metody GET, zapis (tworzenie/aktualizacja) to metody POST z treścią JSON. Wszystko pod jednym adresem bazowym.

Wygeneruj klucz API

Uwierzytelnianie

Każde wywołanie wymaga nagłówka Authorization: Bearer <klucz>. Klucz wygenerujesz w panelu Venzi (sekcja Klucze API). Klucz jednoznacznie identyfikuje Twoją firmę - traktuj go jak hasło i nie udostępniaj publicznie.

curl "https://staging.venzi.zakito.eu/api/v1?method=get_orders&limit=10" \
  -H "Authorization: Bearer TWOJ_KLUCZ_API"

Adres bazowy

Wszystkie metody wywołujesz pod tym adresem, przekazując nazwę metody w parametrze method.

https://staging.venzi.zakito.eu/api/v1

Format wywołania i odpowiedzi

Odczyt: GET z parametrem method w adresie. Zapis: POST z parametrem method w adresie i treścią JSON (pola w snake_case). Odpowiedź to JSON z polem status: SUCCESS przy powodzeniu lub ERROR z polem message przy błędzie.

Stronicowanie

Metody listujące przyjmują parametry limit (1-100, domyślnie 100) oraz offset (domyślnie 0). W odpowiedzi zwracane są pola count, limit i offset.

Limit zapytań

Publiczne API jest ograniczone do 120 zapytań na minutę na klucz API (okno stałe). Po przekroczeniu limitu zwracany jest kod HTTP 429 z nagłówkiem Retry-After (liczba sekund do zwolnienia limitu) i treścią { status: ERROR, message: Rate limit exceeded }.

HTTP/1.1 429 Too Many Requests
Retry-After: 30

{ "status": "ERROR", "message": "Rate limit exceeded" }

Błędy

Błędy zwracane są ze statusem HTTP i treścią { status: ERROR, message }.

{ "status": "ERROR", "message": "Unauthorized" }

401 - brak lub nieprawidłowy klucz; 400 - brak metody lub brak wymaganego parametru; 404 - nie znaleziono zasobu.

Metody

Typ zakończony znakiem „?” oznacza, że pole może być puste (null).

GET?method=get_statusesWymaga klucza

Lista statusów zamówień (etapy) z kolorami i przypisaniem do grup.

Parametry

Bez dodatkowych parametrów.

Przykładowe wywołanie

https://staging.venzi.zakito.eu/api/v1?method=get_statuses

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
statusesarray<object>Tablica statusów zamówień.
iduuidUnikalny identyfikator rekordu (UUID).
namestringNazwa statusu w bieżącym języku (z fallbackiem na inny język).
short_namestringSkrócona nazwa statusu (może być pusta).
colorstringKolor statusu w formacie HEX, np. #3b82f6.
group_iduuidIdentyfikator grupy, do której należy status.
is_initialbooleanCzy to status startowy, nadawany nowym zamówieniom.

Przykładowa odpowiedź

{
  "status": "SUCCESS",
  "statuses": [
    { "id": "3f2c…", "name": "Nowe", "short_name": "",
      "color": "#3b82f6", "group_id": "a1b2…", "is_initial": true }
  ]
}
GET?method=get_statuses_groupsWymaga klucza

Lista grup statusów (kolumny tablicy zamówień).

Parametry

Bez dodatkowych parametrów.

Przykładowe wywołanie

https://staging.venzi.zakito.eu/api/v1?method=get_statuses_groups

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
statuses_groupsarray<object>Tablica grup statusów.
iduuidUnikalny identyfikator rekordu (UUID).
namestringNazwa grupy statusów w bieżącym języku.

Przykładowa odpowiedź

{
  "status": "SUCCESS",
  "statuses_groups": [ { "id": "a1b2…", "name": "Zamówienia" } ]
}
GET?method=get_sourcesWymaga klucza

Lista źródeł zamówień - ręcznych oraz pochodzących z integracji.

Parametry

Bez dodatkowych parametrów.

Przykładowe wywołanie

https://staging.venzi.zakito.eu/api/v1?method=get_sources

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
sourcesarray<object>Tablica źródeł zamówień.
iduuidUnikalny identyfikator rekordu (UUID).
namestringNazwa źródła w bieżącym języku.
kindstringRodzaj źródła: manual (własne) lub integration (z konektora).
is_protectedbooleanCzy źródło jest systemowe (chronione, nieusuwalne).
integrationstring?Klucz integracji dla źródła z konektora (np. allegro); null dla źródeł własnych.

Przykładowa odpowiedź

{
  "status": "SUCCESS",
  "sources": [
    { "id": "…", "name": "Domyślne", "kind": "manual",
      "is_protected": true, "integration": null }
  ]
}
GET?method=get_seriesWymaga klucza

Serie numeracji dokumentów (faktury, korekty, proformy).

Parametry

ParametrTypOpis
kindopcjonalnystringFiltr typu dokumentu: invoice, correction lub proforma.

Przykładowe wywołanie

https://staging.venzi.zakito.eu/api/v1?method=get_series&kind=invoice

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
seriesarray<object>Tablica serii numeracji dokumentów.
iduuidUnikalny identyfikator rekordu (UUID).
namestringSymbol/nazwa serii, np. FV.
kindstringTyp dokumentu serii: invoice, correction lub proforma.
titlestringTytuł dokumentu drukowany na wydruku, np. Faktura VAT.

Przykładowa odpowiedź

{
  "status": "SUCCESS",
  "series": [ { "id": "…", "name": "FV", "kind": "invoice",
               "title": "Faktura VAT" } ]
}
GET?method=get_invoicesWymaga klucza

Lista faktur z filtrowaniem po typie i datach oraz stronicowaniem.

Parametry

ParametrTypOpis
kindopcjonalnystringFiltr typu dokumentu: invoice, correction lub proforma.
issue_date_fromopcjonalnydateData wystawienia od (format YYYY-MM-DD).
issue_date_toopcjonalnydateData wystawienia do (format YYYY-MM-DD).
sell_date_fromopcjonalnydateData sprzedaży od (format YYYY-MM-DD).
sell_date_toopcjonalnydateData sprzedaży do (format YYYY-MM-DD).
order_diropcjonalnystringKierunek sortowania po dacie: ASC lub DESC (domyślnie DESC).
limitopcjonalnyintegerLiczba wyników na stronę (1-100, domyślnie 100).
offsetopcjonalnyintegerPrzesunięcie wyników - do stronicowania (domyślnie 0).

Przykładowe wywołanie

https://staging.venzi.zakito.eu/api/v1?method=get_invoices&kind=invoice&issue_date_from=2026-01-01&limit=100

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
countintegerŁączna liczba pasujących rekordów, bez uwzględnienia stronicowania.
limitintegerZastosowany limit liczby wyników na stronę.
offsetintegerZastosowane przesunięcie (pominięte rekordy).
invoicesarray<object>Tablica faktur.
iduuidUnikalny identyfikator rekordu (UUID).
order_iduuid?Identyfikator powiązanego zamówienia lub null.
numberstringNumer dokumentu, np. FV/2026/01/001.
kindstringTyp dokumentu: invoice, correction lub proforma.
issue_datedateData wystawienia w formacie YYYY-MM-DD.
paid_datedate?Data zapłaty w formacie YYYY-MM-DD lub null.
sell_datedateData sprzedaży w formacie YYYY-MM-DD.
currencystringKod waluty ISO 4217, np. PLN, EUR.
use_ossbooleanCzy zastosowano procedurę OSS (sprzedaż wewnątrzunijna do konsumenta).
seller_fullnamestringPełna nazwa sprzedawcy.
seller_tax_nostringNIP sprzedawcy.
seller_addressstringAdres sprzedawcy (ulica i numer).
seller_postcodestringKod pocztowy sprzedawcy.
seller_citystringMiejscowość sprzedawcy.
seller_countrystringKraj sprzedawcy (kod, np. PL).
buyer_fullnamestringNazwa lub imię i nazwisko nabywcy.
buyer_companystringNazwa firmy nabywcy (jeśli dotyczy).
buyer_tax_nostringNIP nabywcy.
buyer_addressstringAdres nabywcy (ulica i numer).
buyer_postcodestringKod pocztowy nabywcy.
buyer_citystringMiejscowość nabywcy.
buyer_countrystringKraj nabywcy (kod, np. PL).
correction_reasonstring?Przyczyna korekty; tylko dla dokumentów typu correction.
delivery_methodstringMetoda dostawy.
delivery_pricenumberKoszt dostawy (kwota brutto).
delivery_quantitynumberLiczba jednostek dostawy.
delivery_vatstringStawka VAT dla dostawy (np. 23).
total_pricenumberWartość brutto całego dokumentu.
positionsarray<object>Pozycje dokumentu (linie faktury).
namestringNazwa pozycji.
quantitynumberIlość.
pricenumberCena brutto jednostkowa.
vatstringStawka VAT, np. 23.
net_pricenumberCena netto jednostkowa.
total_pricenumberWartość brutto pozycji.
net_total_pricenumberWartość netto pozycji.
skustringSKU / indeks produktu.
eanstringKod kreskowy EAN.
offer_idstringIdentyfikator oferty w platformie sprzedażowej.
product_idstringIdentyfikator produktu w katalogu.

Przykładowa odpowiedź

{
  "status": "SUCCESS", "count": 128, "limit": 100, "offset": 0,
  "invoices": [
    { "id": "…", "number": "FV/2026/01/001", "kind": "invoice",
      "issue_date": "2026-01-15", "currency": "PLN", "total_price": 1230.00,
      "buyer_fullname": "Jan Kowalski", "buyer_tax_no": "1234563218",
      "positions": [
        { "name": "Produkt A", "quantity": 2, "price": 615.00, "vat": "23",
          "net_price": 500.00, "total_price": 1230.00 }
      ] }
  ]
}
GET?method=get_invoiceWymaga klucza

Pojedyncza faktura wraz z pozycjami - po identyfikatorze, numerze lub zamówieniu.

Parametry

ParametrTypOpis
invoice_idopcjonalnyuuidIdentyfikator faktury (UUID).
numberopcjonalnystringNumer dokumentu, np. FV/2026/01/001.
order_idopcjonalnyuuidIdentyfikator zamówienia (UUID).

Wymagany jeden z: invoice_id, number lub order_id.

Przykładowe wywołanie

https://staging.venzi.zakito.eu/api/v1?method=get_invoice&number=FV/2026/01/001

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
invoiceobjectObiekt faktury wraz z pozycjami.
iduuidUnikalny identyfikator rekordu (UUID).
order_iduuid?Identyfikator powiązanego zamówienia lub null.
numberstringNumer dokumentu, np. FV/2026/01/001.
kindstringTyp dokumentu: invoice, correction lub proforma.
issue_datedateData wystawienia w formacie YYYY-MM-DD.
paid_datedate?Data zapłaty w formacie YYYY-MM-DD lub null.
sell_datedateData sprzedaży w formacie YYYY-MM-DD.
currencystringKod waluty ISO 4217, np. PLN, EUR.
use_ossbooleanCzy zastosowano procedurę OSS (sprzedaż wewnątrzunijna do konsumenta).
seller_fullnamestringPełna nazwa sprzedawcy.
seller_tax_nostringNIP sprzedawcy.
seller_addressstringAdres sprzedawcy (ulica i numer).
seller_postcodestringKod pocztowy sprzedawcy.
seller_citystringMiejscowość sprzedawcy.
seller_countrystringKraj sprzedawcy (kod, np. PL).
buyer_fullnamestringNazwa lub imię i nazwisko nabywcy.
buyer_companystringNazwa firmy nabywcy (jeśli dotyczy).
buyer_tax_nostringNIP nabywcy.
buyer_addressstringAdres nabywcy (ulica i numer).
buyer_postcodestringKod pocztowy nabywcy.
buyer_citystringMiejscowość nabywcy.
buyer_countrystringKraj nabywcy (kod, np. PL).
correction_reasonstring?Przyczyna korekty; tylko dla dokumentów typu correction.
delivery_methodstringMetoda dostawy.
delivery_pricenumberKoszt dostawy (kwota brutto).
delivery_quantitynumberLiczba jednostek dostawy.
delivery_vatstringStawka VAT dla dostawy (np. 23).
total_pricenumberWartość brutto całego dokumentu.
positionsarray<object>Pozycje dokumentu (linie faktury).
namestringNazwa pozycji.
quantitynumberIlość.
pricenumberCena brutto jednostkowa.
vatstringStawka VAT, np. 23.
net_pricenumberCena netto jednostkowa.
total_pricenumberWartość brutto pozycji.
net_total_pricenumberWartość netto pozycji.
skustringSKU / indeks produktu.
eanstringKod kreskowy EAN.
offer_idstringIdentyfikator oferty w platformie sprzedażowej.
product_idstringIdentyfikator produktu w katalogu.

Przykładowa odpowiedź

{
  "status": "SUCCESS",
  "invoice": {
    "id": "…", "order_id": "…", "number": "FV/2026/01/001",
    "kind": "invoice", "issue_date": "2026-01-15", "currency": "PLN",
    "total_price": 1230.00, "positions": [ … ]
  }
}
GET?method=get_ordersWymaga klucza

Lista zamówień wraz z pozycjami, ze stronicowaniem i filtrem statusu.

Parametry

ParametrTypOpis
status_idopcjonalnyuuidFiltr po identyfikatorze statusu (UUID).
limitopcjonalnyintegerLiczba wyników na stronę (1-100, domyślnie 100).
offsetopcjonalnyintegerPrzesunięcie wyników - do stronicowania (domyślnie 0).

Przykładowe wywołanie

https://staging.venzi.zakito.eu/api/v1?method=get_orders&limit=50

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
countintegerŁączna liczba pasujących rekordów, bez uwzględnienia stronicowania.
limitintegerZastosowany limit liczby wyników na stronę.
offsetintegerZastosowane przesunięcie (pominięte rekordy).
ordersarray<object>Tablica zamówień.
iduuidUnikalny identyfikator rekordu (UUID).
numberstringNumer zamówienia.
status_iduuidIdentyfikator bieżącego statusu zamówienia.
source_iduuidIdentyfikator źródła zamówienia.
total_pricenumberWartość zamówienia (brutto).
price_paidnumberKwota zapłacona przez kupującego.
currencystringKod waluty ISO 4217.
confirm_statusstringStatus potwierdzenia zamówienia.
buyer_loginstringLogin kupującego (np. z platformy sprzedażowej).
buyer_emailstringAdres e-mail kupującego.
created_atdatetimeData utworzenia w formacie ISO 8601 (UTC).
productsarray<object>Pozycje zamówienia (produkty).
namestringNazwa produktu.
quantitynumberIlość.
pricenumberCena brutto jednostkowa.
vatstringStawka VAT, np. 23.
skustringSKU / indeks produktu.
eanstringKod kreskowy EAN.

Przykładowa odpowiedź

{
  "status": "SUCCESS", "count": 42, "limit": 50, "offset": 0,
  "orders": [
    { "id": "…", "number": "1024", "status_id": "…", "source_id": "…",
      "total_price": 199.99, "price_paid": 199.99, "currency": "PLN",
      "confirm_status": "confirmed", "buyer_login": "jan_k",
      "buyer_email": "jan@example.com", "created_at": "2026-01-15T10:22:00Z",
      "products": [ { "name": "Produkt A", "quantity": 1, "price": 199.99,
                     "vat": "23", "sku": "SKU-1", "ean": "590…" } ] }
  ]
}
GET?method=get_orderWymaga klucza

Pojedyncze zamówienie wraz z pozycjami.

Parametry

ParametrTypOpis
order_idwymaganyuuidIdentyfikator zamówienia (UUID).

Przykładowe wywołanie

https://staging.venzi.zakito.eu/api/v1?method=get_order&order_id=8c1e…

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
orderobjectObiekt zamówienia wraz z pozycjami.
iduuidUnikalny identyfikator rekordu (UUID).
numberstringNumer zamówienia.
status_iduuidIdentyfikator bieżącego statusu zamówienia.
source_iduuidIdentyfikator źródła zamówienia.
total_pricenumberWartość zamówienia (brutto).
price_paidnumberKwota zapłacona przez kupującego.
currencystringKod waluty ISO 4217.
confirm_statusstringStatus potwierdzenia zamówienia.
buyer_loginstringLogin kupującego (np. z platformy sprzedażowej).
buyer_emailstringAdres e-mail kupującego.
created_atdatetimeData utworzenia w formacie ISO 8601 (UTC).
productsarray<object>Pozycje zamówienia (produkty).
namestringNazwa produktu.
quantitynumberIlość.
pricenumberCena brutto jednostkowa.
vatstringStawka VAT, np. 23.
skustringSKU / indeks produktu.
eanstringKod kreskowy EAN.

Przykładowa odpowiedź

{
  "status": "SUCCESS",
  "order": {
    "id": "8c1e…", "number": "1024", "status_id": "…", "source_id": "…",
    "total_price": 199.99, "currency": "PLN", "buyer_email": "jan@example.com",
    "created_at": "2026-01-15T10:22:00Z", "products": [ … ]
  }
}
GET?method=get_shipmentsWymaga klucza

Przesyłki (numery śledzenia, przewoźnik, status) - dla zamówienia lub wszystkie.

Parametry

ParametrTypOpis
order_idopcjonalnyuuidIdentyfikator zamówienia (UUID).
limitopcjonalnyintegerLiczba wyników na stronę (1-100, domyślnie 100).
offsetopcjonalnyintegerPrzesunięcie wyników - do stronicowania (domyślnie 0).

Przykładowe wywołanie

https://staging.venzi.zakito.eu/api/v1?method=get_shipments&order_id=8c1e…

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
countintegerŁączna liczba pasujących rekordów, bez uwzględnienia stronicowania.
limitintegerZastosowany limit liczby wyników na stronę.
offsetintegerZastosowane przesunięcie (pominięte rekordy).
shipmentsarray<object>Tablica przesyłek.
iduuidUnikalny identyfikator rekordu (UUID).
order_iduuidIdentyfikator zamówienia, którego dotyczy przesyłka.
tracking_numberstringNumer śledzenia przesyłki.
courierstring?Przewoźnik: kod z katalogu (np. inpost) lub nazwa własna.
statusstring?Kod statusu śledzenia przesyłki lub null.
typestring?Typ przesyłki (do klienta / reklamacja / zwrot) lub null.
status_change_datedatetime?Data ostatniej zmiany statusu (ISO 8601) lub null.
created_atdatetimeData utworzenia rekordu (ISO 8601, UTC).

Przykładowa odpowiedź

{
  "status": "SUCCESS", "count": 1, "limit": 100, "offset": 0,
  "shipments": [
    { "id": "…", "order_id": "8c1e…", "tracking_number": "00590…",
      "courier": "inpost", "status": "in_transit", "type": null,
      "created_at": "2026-01-16T08:00:00Z" }
  ]
}
POST?method=create_orderWymaga klucza

Tworzy nowe zamówienie (pozycje, dane kupującego, dostawa). Uruchamia automatyzacje.

Treść żądania (JSON)

PoleTypOpis
numberopcjonalnystringNumer zamówienia; pominięty przy tworzeniu = nadany automatycznie.
status_idopcjonalnyuuidIdentyfikator statusu; pominięty przy tworzeniu = status startowy.
source_idopcjonalnyuuidIdentyfikator źródła; pominięty = źródło domyślne.
buyer_loginopcjonalnystringLogin kupującego.
buyer_emailopcjonalnystringAdres e-mail kupującego.
buyer_phoneopcjonalnystringTelefon kupującego.
payment_methodopcjonalnystringMetoda płatności.
payment_currencyopcjonalnystringKod waluty ISO 4217 (np. PLN).
price_paidopcjonalnynumberKwota zapłacona; gdy ≥ wartość zamówienia, oznacza je jako opłacone.
delivery_methodopcjonalnystringMetoda dostawy.
delivery_costopcjonalnynumberKoszt dostawy (brutto).
delivery_nameopcjonalnystringOdbiorca - imię i nazwisko / nazwa.
delivery_companyopcjonalnystringOdbiorca - firma.
delivery_addressopcjonalnystringAdres dostawy (ulica i numer).
delivery_zip_codeopcjonalnystringKod pocztowy dostawy.
delivery_cityopcjonalnystringMiejscowość dostawy.
delivery_countryopcjonalnystringKraj dostawy (kod, np. PL).
productsopcjonalnyarray<object>Pozycje zamówienia. Przy update_order podane pozycje zastępują dotychczasowe.
namewymaganystringNazwa pozycji (wymagana).
quantityopcjonalnyintegerIlość (domyślnie 1).
priceopcjonalnynumberCena brutto jednostkowa.
vatopcjonalnynumberStawka VAT (np. 23).
skuopcjonalnystringSKU / indeks produktu.
eanopcjonalnystringKod EAN.

Przykładowe wywołanie

curl -X POST "https://staging.venzi.zakito.eu/api/v1?method=create_order" \
  -H "Authorization: Bearer TWOJ_KLUCZ_API" \
  -H "Content-Type: application/json" \
  -d '{ "buyer_email": "jan@example.com",
  "products": [ { "name": "Produkt A", "quantity": 1, "price": 199.99, "vat": 23 } ] }'

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
order_iduuidIdentyfikator utworzonego/zmienionego zamówienia (UUID).
numberstringNadany numer dokumentu / zamówienia.

Przykładowa odpowiedź

{ "status": "SUCCESS", "order_id": "8c1e…", "number": "100001" }
POST?method=update_orderWymaga klucza

Aktualizuje zamówienie: status, dane, pozycje (podane pozycje zastępują dotychczasowe).

Treść żądania (JSON)

PoleTypOpis
order_idwymaganyuuidIdentyfikator zamówienia - wymagany tylko dla update_order.
numberopcjonalnystringNumer zamówienia; pominięty przy tworzeniu = nadany automatycznie.
status_idopcjonalnyuuidIdentyfikator statusu; pominięty przy tworzeniu = status startowy.
source_idopcjonalnyuuidIdentyfikator źródła; pominięty = źródło domyślne.
buyer_loginopcjonalnystringLogin kupującego.
buyer_emailopcjonalnystringAdres e-mail kupującego.
buyer_phoneopcjonalnystringTelefon kupującego.
payment_methodopcjonalnystringMetoda płatności.
payment_currencyopcjonalnystringKod waluty ISO 4217 (np. PLN).
price_paidopcjonalnynumberKwota zapłacona; gdy ≥ wartość zamówienia, oznacza je jako opłacone.
delivery_methodopcjonalnystringMetoda dostawy.
delivery_costopcjonalnynumberKoszt dostawy (brutto).
delivery_nameopcjonalnystringOdbiorca - imię i nazwisko / nazwa.
delivery_companyopcjonalnystringOdbiorca - firma.
delivery_addressopcjonalnystringAdres dostawy (ulica i numer).
delivery_zip_codeopcjonalnystringKod pocztowy dostawy.
delivery_cityopcjonalnystringMiejscowość dostawy.
delivery_countryopcjonalnystringKraj dostawy (kod, np. PL).
productsopcjonalnyarray<object>Pozycje zamówienia. Przy update_order podane pozycje zastępują dotychczasowe.
namewymaganystringNazwa pozycji (wymagana).
quantityopcjonalnyintegerIlość (domyślnie 1).
priceopcjonalnynumberCena brutto jednostkowa.
vatopcjonalnynumberStawka VAT (np. 23).
skuopcjonalnystringSKU / indeks produktu.
eanopcjonalnystringKod EAN.

Przykładowe wywołanie

curl -X POST "https://staging.venzi.zakito.eu/api/v1?method=update_order" \
  -H "Authorization: Bearer TWOJ_KLUCZ_API" \
  -H "Content-Type: application/json" \
  -d '{ "order_id": "8c1e…", "status_id": "3f2c…" }'

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
order_iduuidIdentyfikator utworzonego/zmienionego zamówienia (UUID).

Przykładowa odpowiedź

{ "status": "SUCCESS", "order_id": "8c1e…" }
POST?method=create_invoiceWymaga klucza

Wystawia dokument sprzedaży dla zamówienia (faktura, korekta lub proforma).

Treść żądania (JSON)

PoleTypOpis
order_idwymaganyuuidIdentyfikator zamówienia, dla którego wystawiasz dokument (wymagany).
series_idwymaganyuuidIdentyfikator serii numeracji z get_series (wymagany).
document_typeopcjonalnystringTyp dokumentu: invoice, correction lub proforma (domyślnie invoice).
correction_idopcjonalnyuuidIdentyfikator korygowanej faktury (dla document_type=correction).
correction_reasonopcjonalnystringPrzyczyna korekty.
buyer_nameopcjonalnystringNabywca - nadpisuje dane z zamówienia.
buyer_companyopcjonalnystringFirma nabywcy.
buyer_vat_idopcjonalnystringNIP nabywcy.

Przykładowe wywołanie

curl -X POST "https://staging.venzi.zakito.eu/api/v1?method=create_invoice" \
  -H "Authorization: Bearer TWOJ_KLUCZ_API" \
  -H "Content-Type: application/json" \
  -d '{ "order_id": "8c1e…", "series_id": "a1b2…", "document_type": "invoice" }'

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
invoice_iduuidIdentyfikator wystawionego dokumentu (UUID).
numberstringNadany numer dokumentu / zamówienia.

Przykładowa odpowiedź

{ "status": "SUCCESS", "invoice_id": "…", "number": "FV/2026/01/001" }
POST?method=create_shipmentWymaga klucza

Dodaje przesyłkę do zamówienia (numer śledzenia, przewoźnik, status).

Treść żądania (JSON)

PoleTypOpis
order_idwymaganyuuidIdentyfikator zamówienia (wymagany dla create_shipment).
tracking_numberwymaganystringNumer śledzenia (wymagany przy tworzeniu).
supplier_codewymaganystringKod przewoźnika z katalogu (np. inpost, dpd, dhl, gls, other).
supplier_nameopcjonalnystringNazwa własna przewoźnika - gdy supplier_code = other.
statusopcjonalnystringKod statusu śledzenia przesyłki.
typeopcjonalnystringTyp przesyłki (do klienta / reklamacja / zwrot).

Przykładowe wywołanie

curl -X POST "https://staging.venzi.zakito.eu/api/v1?method=create_shipment" \
  -H "Authorization: Bearer TWOJ_KLUCZ_API" \
  -H "Content-Type: application/json" \
  -d '{ "order_id": "8c1e…", "tracking_number": "00590…",
  "supplier_code": "inpost", "status": "created" }'

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
shipment_iduuidIdentyfikator przesyłki (UUID).
sent_to_platformbooleanCzy numer śledzenia przekazano do platformy sprzedażowej (jeśli dotyczy).
platform_errorstring?Komunikat błędu przekazania do platformy lub null.

Przykładowa odpowiedź

{ "status": "SUCCESS", "shipment_id": "…",
  "sent_to_platform": false, "platform_error": null }
POST?method=update_shipmentWymaga klucza

Aktualizuje przesyłkę (numer śledzenia, przewoźnik, status, typ).

Treść żądania (JSON)

PoleTypOpis
shipment_idwymaganyuuidIdentyfikator przesyłki (wymagany dla update_shipment i delete_shipment).
tracking_numberopcjonalnystringNumer śledzenia (wymagany przy tworzeniu).
supplier_codeopcjonalnystringKod przewoźnika z katalogu (np. inpost, dpd, dhl, gls, other).
supplier_nameopcjonalnystringNazwa własna przewoźnika - gdy supplier_code = other.
statusopcjonalnystringKod statusu śledzenia przesyłki.
typeopcjonalnystringTyp przesyłki (do klienta / reklamacja / zwrot).

Przykładowe wywołanie

curl -X POST "https://staging.venzi.zakito.eu/api/v1?method=update_shipment" \
  -H "Authorization: Bearer TWOJ_KLUCZ_API" \
  -H "Content-Type: application/json" \
  -d '{ "shipment_id": "…", "status": "in_transit" }'

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
shipment_iduuidIdentyfikator przesyłki (UUID).

Przykładowa odpowiedź

{ "status": "SUCCESS", "shipment_id": "…" }
POST?method=delete_shipmentWymaga klucza

Usuwa przesyłkę.

Treść żądania (JSON)

PoleTypOpis
shipment_idwymaganyuuidIdentyfikator przesyłki (wymagany dla update_shipment i delete_shipment).

Przykładowe wywołanie

curl -X POST "https://staging.venzi.zakito.eu/api/v1?method=delete_shipment" \
  -H "Authorization: Bearer TWOJ_KLUCZ_API" \
  -H "Content-Type: application/json" \
  -d '{ "shipment_id": "…" }'

Pola odpowiedzi

PoleTypOpis
statusstringWynik operacji: SUCCESS przy powodzeniu, ERROR przy błędzie.
deletedbooleantrue, gdy rekord został usunięty.

Przykładowa odpowiedź

{ "status": "SUCCESS", "deleted": true }