Base URL
https://{tenant}.logzi.com/api/offer_send/
Every request returns a JSON response. On success result.code == 1, on error result.code == 0. The Offer Send API allows you to track, close and download as PDF the offers sent to customers.
/api/offer_send/get
Retrieve a single sent offer document by its identifier.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Document identifier |
Example request
GET /api/offer_send/get?id=1
X-API-KEY: {your_api_key}/api/offer_send/list
Paginated list of sent offers.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_count | int | Maximum number of records to return | |
list_offset | int | Pagination offset (default: 0) | |
list_condition | object | Object containing filter conditions | |
list_sort | object | Object containing sort conditions |
Example request
GET /api/offer_send/list?list_offset=0&list_count=50
X-API-KEY: {your_api_key}/api/offer_send/download
Download a sent offer 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_send/download?file_type=pdf&receipt_id=1&language=hu
X-API-KEY: {your_api_key}/api/offer_send/close
Close a sent offer.
POST fields — data object
The data object must contain the identifier of the document to close.
Example request
POST /api/offer_send/close
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 1 } }/api/offer_send/delete
Delete a sent offer document.
POST fields — data object
The data object must contain the details of the document to delete.
Example request
POST /api/offer_send/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 1 } }Create your account now,
pay later!
