Înregistrare Autentificare

API vânzări la casă

Gestionarea documentelor de vânzare la casa de marcat / vânzare cu amănuntul — preluare, salvare, închidere și descărcare document

Endpoint-uri

Autentificare

Fiecare cerere API necesită trimiterea header-ului X-API-KEY.

X-API-KEY: {cheia_dvs_api}

Mai ai întrebări?

Trimite-ne un tichet, sau caută în motorul nostru de căutare.

Dacă ți-a plăcut, distribuie-l și altora

URL de bază

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

Toate cererile returnează un răspuns JSON. În caz de succes result.code == 1, în caz de eroare result.code == 0.

GET /api/cash_register/get

Preluarea unui singur document de vânzare la casă pe baza identificatorului, cu lista completă de articole.

Parametri de interogare

ParametruTipObligatoriuDescriere
idintIdentificatorul unic al documentului

Exemplu de cerere

GET /api/cash_register/get?id=101
X-API-KEY: {cheia_dvs_api}
GET /api/cash_register/list

Preluarea paginată a listei documentelor de vânzare la casă, cu opțiuni de filtrare.

Parametri de interogare

ParametruTipObligatoriuDescriere
list_offsetintDecalajul paginării (implicit: 0)
list_countintNumărul de înregistrări afișate pe pagină
list_condition[identify]stringFiltrare după numărul documentului (LIKE)
list_condition[company_name]stringFiltrare după numele clientului (LIKE)
list_condition[status_id]intFiltrare după status
list_condition[date_create_from]dateData creării — de la (YYYY-MM-DD)
list_condition[date_create_to]dateData creării — până la (YYYY-MM-DD)

Exemplu de cerere

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

Crearea sau modificarea unui document de vânzare la casă. Pentru un document nou, data[id] = 0.

Câmpuri POST — data obiectul

CâmpTipObligatoriuDescriere
idint0 = document nou, >0 = modificare
company_idintIdentificatorul companiei
company_user_idintID-ul angajatului responsabil
company_address_idintIdentificatorul punctului de lucru
currency_idintIdentificatorul monedei
paymod_idintIdentificatorul modalității de plată
partner_idintIdentificatorul partenerului client
date_performdateData prestației (YYYY-MM-DD)
comment_topstringObservație
itemarrayArray de articole (vezi mai jos)

Câmpuri articol — data[item][]

CâmpTipObligatoriuDescriere
product_idintIdentificatorul produsului
quantityfloatCantitate
pricefloatPreț unitar brut
tax_idintIdentificatorul cotei de TVA
store_idintIdentificatorul depozitului
removeint1 = ștergerea articolului la modificare

Exemplu de cerere

POST /api/cash_register/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,
    "currency_id": 1,
    "paymod_id": 1,
    "item": [
      { "product_id": 5, "quantity": 2, "price": 3990, "tax_id": 2 }
    ]
  }
}
POST /api/cash_register/delete

Ștergerea unui document de vânzare la casă. Se poate șterge doar un document cu status deschis.

Câmpuri POST — data obiectul

CâmpTipObligatoriuDescriere
receipt_idintIdentificatorul documentului de șters

Exemplu de cerere

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

{ "data": { "receipt_id": 101 } }
POST /api/cash_register/close

Închiderea unui document de vânzare la casă. La închidere se efectuează mișcarea de stoc și înregistrarea financiară. Se poate închide doar un document deschis (status_id=1).

Câmpuri POST — data obiectul

CâmpTipObligatoriuDescriere
receipt_idintIdentificatorul documentului de închis

Exemplu de cerere

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

{ "data": { "receipt_id": 101 } }
GET /api/cash_register/download

Descărcarea documentului de vânzare la casă în diverse formate (PDF, bon imprimabil).

Parametri de interogare

ParametruTipObligatoriuDescriere
receipt_idintIdentificatorul documentului
file_typestringpdf, pdf-string, pdf-thermal, pos-thermal, stream
languagestringNumele folderului de limbă al șablonului
template_idintID-ul șablonului de tipărire personalizat

Exemplu de cerere

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

Ia legătura cu noi

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

Trimite o solicitare

Ai nevoie de ajutor?

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

Răsfoiește centrul de ajutor

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

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