Základná URL
https://{tenant}.logzi.com/api/order_out_confirm/
Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. Toto API spravuje proces potvrdzovania odchádzajúcich objednávok — umožňuje získanie, uloženie potvrdzovacích záznamov a odoslanie e-mailového potvrdenia.
/api/order_out_confirm/get_confirm
Získanie jedného potvrdzovacieho záznamu na základe identifikátora.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor potvrdzovacieho záznamu |
Príklad požiadavky
GET /api/order_out_confirm/get_confirm?id=1
X-API-KEY: {vas_api_kluc}
/api/order_out_confirm/list_confirm
Stránkovateľný zoznam potvrdzovacích záznamov.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_condition | object | Objekt filtrovacích podmienok |
Príklad požiadavky
GET /api/order_out_confirm/list_confirm?list_offset=0
X-API-KEY: {vas_api_kluc}
/api/order_out_confirm/list_confirm_full_order
Zoznam potvrdení rozšírený o úplné údaje objednávky.
Rovnaké parametre ako pri koncovom bode /list_confirm, odpoveď však obsahuje aj hlavičkové údaje súvisiacej objednávky.
/api/order_out_confirm/save_confirm
Uloženie alebo úprava potvrdzovacieho záznamu.
POST polia — objekt data
V objekte data je potrebné zadať polia potvrdzovacieho záznamu (identifikátor objednávky, stav potvrdenia, dátum atď.).
Príklad požiadavky
POST /api/order_out_confirm/save_confirm
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { ... } }
/api/order_out_confirm/email_confirm
Odoslanie e-mailového potvrdenia k objednávke.
POST polia — objekt data
V objekte data je potrebné zadať identifikátor objednávky a parametre odosielania e-mailu.
Príklad požiadavky
POST /api/order_out_confirm/email_confirm
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }
Zaregistruj sa teraz,
zaplať neskôr!