Base URL
https://{tenant}.logzi.com/api/offer_request/
Every request returns a JSON response. On success result.code == 1; on error result.code == 0. The offer request API allows managing, closing, downloading, and bulk-recording offer request documents sent to customers.
/api/offer_request/get
Retrieve a single offer request document by identifier.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Document identifier |
Example request
GET /api/offer_request/get?id=1
X-API-KEY: {your_api_key}
/api/offer_request/list
Paginated list of offer requests.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_count | int | Maximum number of records returned | |
list_offset | int | Pagination offset (default: 0) | |
list_condition | object | Filter conditions object | |
list_sort | object | Sorting conditions object |
Example request
GET /api/offer_request/list?list_offset=0&list_count=50
X-API-KEY: {your_api_key}
/api/offer_request/download
Download an offer request document as PDF or another format.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file_type | string | File type (e.g. pdf) | |
receipt_id | int | Document identifier | |
language | string | Document language (e.g. hu) | |
language_id | int | Language identifier | |
template_id | int | Print template identifier |
Example request
GET /api/offer_request/download?file_type=pdf&receipt_id=1&language=hu
X-API-KEY: {your_api_key}
/api/offer_request/save_bulk
Save multiple offer request documents at once.
POST fields — data array
The data array can hold multiple documents' data for bulk recording at once.
Example request
POST /api/offer_request/save_bulk
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": [ { "partner_id": 1 }, { "partner_id": 2 } ] }
/api/offer_request/close
Close an offer request document.
POST fields — data object
The data object must contain the identifier of the document to close.
Example request
POST /api/offer_request/close
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 1 } }
/api/offer_request/delete
Delete an offer request document.
POST fields — data object
The data object must contain the data of the document to delete.
Example request
POST /api/offer_request/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 1 } }
Create your account now,
pay later!