API rezervare stoc

Gestionarea rezervărilor de stoc — obținere, creare, modificare, închidere și descărcare document

URL de bază

https://{tenant}.logzi.com/api/reserve/

Fiecare cerere returnează un răspuns JSON. În cazul unui răspuns cu succes, result.code == 1, iar în caz de eroare, result.code == 0.

GET /api/reserve/get

Obținerea unei singure rezervări de stoc pe baza identificatorului, cu detalii complete (articole, date de stoc, proiect).

Parametri de interogare

Parametru Tip Obligatoriu Descriere
id int Identificatorul unic al rezervării de stoc

Exemplu de cerere

GET /api/reserve/get?id=23
X-API-KEY: {cheia_dvs_api}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 23,
    "identify": "RES-2024-0023",
    "date_create": "2024-05-05 09:15:00",
    "date_perform": "2024-05-20",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_brutto": 95000,
    "price_netto": 74803,
    "price_tax": 20197,
    "currency_name": "HUF",
    "item": [
      {
        "product_id": 8,
        "quantity": 5,
        "price": 14961,
        "price_brutto": 19000
      }
    ]
  }
}
GET /api/reserve/list

Obținerea paginată a listei de rezervări de stoc, cu opțiuni de filtrare.

Parametri de interogare

Parametru Tip Obligatoriu Descriere
list_offset int Decalajul paginării (implicit: 0)
list_condition[identify] string Filtrare după identificator (LIKE)
list_condition[company_name] string Filtrare după numele partenerului (LIKE)
list_condition[status_id] int Filtrare după status (1=deschis, 2=închis)
list_condition[status_ids] array Filtrare după mai multe statusuri simultan
list_condition[date_create_from] date Data creării — de la (YYYY-MM-DD)
list_condition[date_create_to] date Data creării — până la (YYYY-MM-DD)
list_condition[date_perform_from] date Data îndeplinirii — de la (YYYY-MM-DD)
list_condition[date_perform_to] date Data îndeplinirii — până la (YYYY-MM-DD)
list_condition[partner_id] int Filtrare după ID-ul partenerului
list_condition[company_user_id] int Filtrare după ID-ul angajatului responsabil
list_condition[partnumber] string Filtrare după cod de articol sau cod de bare (LIKE)
list_condition[comment_top] string Filtrare după comentariul vizibil pentru client (LIKE)
list_condition[comment_bottom] string Filtrare după comentariul intern (LIKE)

Exemplu de cerere

GET /api/reserve/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {cheia_dvs_api}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 23,
      "identify": "RES-2024-0023",
      "date_create": "2024-05-05",
      "status_name": "Nyitott",
      "partner_company_name": "Minta Kft.",
      "price_brutto": 95000
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 12
  }
}
POST /api/reserve/save

Crearea sau modificarea unei rezervări de stoc. Pentru o rezervare nouă, data[id] = 0, iar pentru modificare specificați ID-ul existent.

Câmpuri POST — obiectul data

Câmp Tip Obligatoriu Descriere
id int 0 = rezervare de stoc nouă, >0 = modificare
company_id int Identificatorul companiei
company_user_id int ID-ul angajatului responsabil
company_address_id int ID-ul sediului companiei
date_perform datetime Data îndeplinirii (YYYY-MM-DD HH:MM:SS)
currency_id int Identificatorul monedei
partner_id int Identificatorul partenerului/clientului
partner_user_id int ID-ul persoanei de contact a partenerului
partner_shipping_id int ID-ul adresei de livrare a partenerului
currency_exchange decimal Cursul valutar (implicit: 1)
comment_top string Comentariu vizibil pentru client
comment_bottom string Comentariu intern
jobnumber_id int Identificatorul numărului de lucrare
departmentnumber_id int Identificatorul numărului de departament
project_id int Identificatorul proiectului
source_receipt_id int Identificatorul documentului sursă
source_receipt_type_id int Identificatorul tipului documentului sursă
item array Array de articole — minim un articol este obligatoriu (vezi mai jos)

Câmpuri articol — data[item][]

Câmp Tip Obligatoriu Descriere
id int 0 = articol nou, >0 = modificarea unui articol existent
product_id int Identificatorul produsului
store_id int Identificatorul depozitului
store_locality_id int Identificatorul locației de depozitare
pallet_id int Identificatorul paletului
quantity decimal Cantitate
tax_id int Identificatorul cotei de TVA
price decimal Preț unitar net
price_discount decimal Procentul de reducere/adaos
stock_change int Indicator de mișcare de stoc
comment_top string Comentariu aferent articolului
remove int 1 = ștergerea articolului la modificare

Câmpuri POST — obiectul params (opțional)

Câmp Tip Obligatoriu Descriere
close int 1 = închidere automată după salvare
download int 1 = generare PDF după salvare

Exemplu de cerere

POST /api/reserve/save
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "company_address_id": 1,
    "date_perform": "2024-06-20 00:00:00",
    "partner_id": 12,
    "currency_id": 1,
    "item": [
      {
        "id": 0,
        "product_id": 8,
        "store_id": 1,
        "quantity": 5,
        "tax_id": 2,
        "price": 14961
      }
    ]
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 24,
    "identify": "RES-2024-0024"
  }
}
POST /api/reserve/delete

Ștergerea unei rezervări de stoc. Poate fi șters doar un document cu status_id = 1 (deschis) sau status_id = 2 (închis).

Câmpuri POST — obiectul data

Câmp Tip Obligatoriu Descriere
receipt_id int Identificatorul rezervării de stoc care urmează să fie ștearsă

Exemplu de cerere

POST /api/reserve/delete
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{
  "data": {
    "receipt_id": 23
  }
}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/reserve/close

Închiderea unei rezervări de stoc deschise. Poate fi închis doar un document cu status_id = 1 (deschis).

Câmpuri POST — obiectul data

Câmp Tip Obligatoriu Descriere
receipt_id int Identificatorul rezervării de stoc care urmează să fie închisă

Exemplu de cerere

POST /api/reserve/close
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{
  "data": {
    "receipt_id": 23
  }
}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
GET /api/reserve/download

Generarea documentului rezervării de stoc în diverse formate (PDF, string base64, stream).

Parametri de interogare

Parametru Tip Obligatoriu Descriere
receipt_id int Identificatorul rezervării de stoc
file_type string Formatul de ieșire (vezi mai jos)
language string Numele folderului de limbă al șablonului (ex. hungarian)
language_id int Identificatorul limbii (implicit: 1)
template_id int ID șablon de tipărire personalizat

file_type valori posibile

Valoare Descriere
pdf Returnarea unui PDF codificat base64 împreună cu metadate
pdf-string Identic cu pdf — string base64 + metadate
pdf-string-sample Generare PDF de previzualizare
stream Stream direct al fișierului (descărcare din browser)

Exemplu de cerere

GET /api/reserve/download?receipt_id=23&file_type=pdf
X-API-KEY: {cheia_dvs_api}

Exemplu de răspuns (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "RES-2024-0023.pdf",
    "content": "JVBERi0xLjQK...",
    "receipt": { ... }
  }
}

Ia legătura cu noi

Ești interesat de software-ul nostru? Scrie-ne cu încredere!

Ai nevoie de ajutor?

Dacă nu găsești răspunsul și ai nevoie de asistență

Creează-ți contul acum,
plătește mai târziu!

Încearcă gratuit timp de 3 zile, fără riscuri și fără obligații!