Înregistrare Autentificare

API Comenzi

Gestionarea comenzilor de la clienți — preluare, creare, modificare, închidere, marcare ca finalizată și descărcare document

Endpoint-uri

GET Preluare înregistrare
GET Preluare listă
POST Salvare / creare
POST Ștergere
POST Închidere
POST Marcare ca finalizată
GET Descărcare
POST Modificare status client
POST Schimbare mod de livrare

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.

URL de bază

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

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

GET /api/order_in/get

Preluarea unei singure comenzi de la client pe baza identificatorului, cu toate detaliile.

Parametri de interogare

Parametru	Tip	Obligatoriu	Descriere
`id`	int		Identificatorul unic al comenzii

Exemplu de cerere

GET /api/order_in/get?id=45
X-API-KEY: {cheia_dvs_api}

GET /api/order_in/list

Preluarea paginată a listei de comenzi de la clienți, cu opțiuni de filtrare și sortare.

Parametri de interogare

Parametru	Tip	Descriere
`list_offset`	int	Decalajul paginării (implicit: 0)
`list_count`	int	Numărul de înregistrări afișate per pagină
`list_sort[field]`	string	Numele câmpului de sortare
`list_sort[sort]`	string	Direcția sortării: `ASC` sau `DESC`
`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
`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[partner_id]`	int	Filtrare după identificatorul partenerului

Exemplu de cerere

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

POST /api/order_in/save

Crearea sau modificarea unei comenzi de la client. Pentru o înregistrare nouă, data[id] = 0.

Câmpuri POST — data obiect

Câmp	Tip	Descriere
`id`	int	0 = comandă nouă, >0 = modificare
`company_id`	int	Identificatorul companiei
`company_user_id`	int	ID-ul angajatului responsabil
`company_address_id`	int	ID-ul punctului de lucru al companiei
`currency_id`	int	Identificatorul valutei
`partner_id`	int	Identificatorul partenerului/clientului
`partner_shipping_id`	int	ID-ul adresei de livrare a partenerului
`date_perform`	date	Data îndeplinirii (YYYY-MM-DD)
`comment_top`	string	Observație vizibilă pentru client
`comment_bottom`	string	Observație internă
`jobnumber_id`	int	Identificatorul numărului de lucru
`project_id`	int	Identificatorul proiectului
`item`	array	Tabloul de articole (vezi mai jos)

Câmpuri articol — data[item][]

Câmp	Tip	Descriere
`product_id`	int	Identificatorul produsului
`quantity`	float	Cantitate
`price`	float	Preț unitar net
`tax_id`	int	Identificatorul cotei de TVA
`price_discount`	float	Procentul de reducere
`remove`	int	1 = ștergerea articolului la modificare

Câmpuri POST — params obiect (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/order_in/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,
    "partner_id": 12,
    "date_perform": "2024-07-15",
    "comment_top": "Kérjük sürgős kezelést.",
    "item": [
      { "product_id": 5, "quantity": 10, "price": 8000, "tax_id": 2 }
    ]
  },
  "params": { "close": 0, "download": 0 }
}

POST /api/order_in/delete

Ștergerea unei comenzi de la client. Se poate șterge doar o comandă cu status deschis.

Câmpuri POST — data obiect

Câmp	Tip	Obligatoriu	Descriere
`receipt_id`	int		Identificatorul comenzii care urmează a fi ștearsă

Exemplu de cerere

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

{ "data": { "receipt_id": 45 } }

POST /api/order_in/close

Închiderea unei comenzi de la client. Se poate închide doar o comandă deschisă (status_id = 1).

Câmpuri POST — data obiect

Câmp	Tip	Obligatoriu	Descriere
`receipt_id`	int		Identificatorul comenzii care urmează a fi închisă

Exemplu de cerere

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

{ "data": { "receipt_id": 45 } }

POST /api/order_in/success

Marcarea ca finalizată a unei comenzi de la client închise. Poate fi apelat doar pentru o comandă cu status închis.

Câmpuri POST — data obiect

Câmp	Tip	Obligatoriu	Descriere
`receipt_id`	int		Identificatorul comenzii care urmează a fi finalizată (doar în stare închisă)

Exemplu de cerere

POST /api/order_in/success
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{ "data": { "receipt_id": 45 } }

GET /api/order_in/download

Descărcarea documentului comenzii de la client în diverse formate.

Parametri de interogare

Parametru	Tip	Descriere
`receipt_id`	int	Identificatorul comenzii
`file_type`	string	`pdf`, `pdf-string`, `pdf-string-sample`, `stream`
`language`	string	Numele folderului de limbă al șablonului
`template_id`	int	ID șablon de tipărire personalizat

Exemplu de cerere

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

POST /api/order_in/change_customer_status

Modificarea statusului de client al unei comenzi de la client. Se generează automat un webhook de integrare, cu excepția cazului în care este dezactivat.

Câmpuri POST — data obiect

Câmp	Tip	Descriere
`receipt_id`	int	Identificatorul comenzii
`customer_status_id`	int	Identificatorul noului status de client
`no_integration_event`	int	1 = să nu declanșeze evenimentul webhook de integrare

Exemplu de cerere

POST /api/order_in/change_customer_status
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{ "data": { "receipt_id": 45, "customer_status_id": 3 } }

POST /api/order_in/save_shipping

Schimbarea modului de livrare și a modului de plată al comenzii. Actualizează opțional și datele adresei de livrare, dacă este specificat partner_address_id.

Câmpuri POST — data obiect

Câmp	Tip	Descriere
`receipt_id`	int	Identificatorul comenzii
`shipping_id`	int	Identificatorul noului mod de livrare (`db_shipping.id`)
`paymod_id`	int	Identificatorul noului mod de plată
`partner_address_id`	int	Dacă > 0, actualizează înregistrarea adresei partenerului cu câmpurile de adresă de mai jos
`country_id`	int	Identificatorul țării
`zip`	string	Cod poștal
`city`	string	Oraș
`address`	string	Strada, numele căii publice
`address_number`	string	Numărul imobilului — punctele sunt eliminate automat
`address_building`	string	Clădire — punctele sunt eliminate automat
`address_floor`	string	Etaj — punctele sunt eliminate automat
`address_door`	string	Ușă — punctele sunt eliminate automat
`address_stairwell`	string	Scară — punctele sunt eliminate automat
`district`	string	Cartier — punctele sunt eliminate automat
`address_user_name`	string	Numele titularului adresei
`address_comment`	string	Observație adresă

Exemplu de cerere — doar schimbarea modului de livrare și de plată

POST /api/order_in/save_shipping
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{ "data": { "receipt_id": 45, "shipping_id": 3, "paymod_id": 2 } }

Exemplu de cerere — schimbarea modului de livrare + actualizarea adresei

POST /api/order_in/save_shipping
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{ "data": { "receipt_id": 45, "shipping_id": 3, "paymod_id": 2, "partner_address_id": 12, "country_id": 1, "zip": "1051", "city": "Budapest", "address": "Vörösmarty tér", "address_number": "7", "district": "V" } }

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!

Înregistrare