Offer Request API

Manage offer request documents

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.

GET /api/offer_request/get

Retrieve a single offer request document by identifier.

Query parameters

ParameterTypeRequiredDescription
idintDocument identifier

Example request

GET /api/offer_request/get?id=1
X-API-KEY: {your_api_key}
GET /api/offer_request/list

Paginated list of offer requests.

Query parameters

ParameterTypeRequiredDescription
list_countintMaximum number of records returned
list_offsetintPagination offset (default: 0)
list_conditionobjectFilter conditions object
list_sortobjectSorting conditions object

Example request

GET /api/offer_request/list?list_offset=0&list_count=50
X-API-KEY: {your_api_key}
GET /api/offer_request/download

Download an offer request document as PDF or another format.

Query parameters

ParameterTypeRequiredDescription
file_typestringFile type (e.g. pdf)
receipt_idintDocument identifier
languagestringDocument language (e.g. hu)
language_idintLanguage identifier
template_idintPrint template identifier

Example request

GET /api/offer_request/download?file_type=pdf&receipt_id=1&language=hu
X-API-KEY: {your_api_key}
POST /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 } ] }
POST /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 } }
POST /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 } }

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!