Sign up Log in

Warehouse Receiving API

Manage warehouse receipts — retrieve, create, modify, close and download documents

Endpoints

Authentication

Every API request requires sending the X-API-KEY header.

X-API-KEY: {your_api_key}

Still have questions?

Open a ticket with us, or browse our help center.

If you liked it, share it with others

Base URL

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

Every request returns a JSON response. On success result.code == 1, on error result.code == 0.

GET /api/booking/get

Retrieve a single warehouse receipt by identifier, with full details (items, serial numbers, project).

Query parameters

Parameter Type Required Description
id int Unique identifier of the warehouse receipt

Example request

GET /api/booking/get?id=42
X-API-KEY: {your_api_key}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 42,
    "identify": "BK-2024-0042",
    "date_create": "2024-05-01 10:00:00",
    "date_perform": "2024-05-10",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_brutto": 127000,
    "price_netto": 100000,
    "price_tax": 27000,
    "currency_name": "HUF",
    "item": [
      {
        "product_id": 5,
        "quantity": 2,
        "price": 50000,
        "price_brutto": 63500
      }
    ]
  }
}
GET /api/booking/list

Paginated retrieval of the warehouse receipt list with filtering options.

Query parameters

Parameter Type Required Description
list_offset int Pagination offset (default: 0)
list_condition[identify] string Filter by identifier (LIKE)
list_condition[company_name] string Filter by partner name (LIKE)
list_condition[status_id] int Filter by status (1=open, 2=closed)
list_condition[date_create_from] date Creation date — from (YYYY-MM-DD)
list_condition[date_create_to] date Creation date — to (YYYY-MM-DD)
list_condition[partner_id] int Filter by partner ID

Example request

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

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 42,
      "identify": "BK-2024-0042",
      "date_create": "2024-05-01",
      "status_name": "Nyitott",
      "partner_company_name": "Minta Kft.",
      "price_brutto": 127000
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 87
  }
}
POST /api/booking/save

Create or modify a warehouse receipt. For a new receipt use data[id] = 0, for a modification supply the existing ID.

POST fields — data object

Field Type Required Description
id int 0 = new warehouse receipt, >0 = modification
company_id int Company identifier
company_user_id int ID of the responsible employee
company_address_id int Company site/address ID
date_perform datetime Performance date (YYYY-MM-DD HH:MM:SS)
currency_id int Currency identifier
partner_id int Partner/customer identifier
partner_shipping_id int Partner shipping address ID
comment_top string Comment visible to the customer
comment_bottom string Internal comment
jobnumber_id int Job number identifier
project_id int Project identifier
item array Array of items (see below)

Item fields — data[item][]

Field Type Required Description
product_id int Product identifier
store_id int Warehouse identifier
quantity float Quantity
tax_id int VAT rate identifier
price float Net unit price
price_discount float Discount percentage
remove int 1 = remove item on modification

POST fields — params object (optional)

Field Type Required Description
close int 1 = automatically close after saving
download int 1 = generate PDF after saving

Example request

POST /api/booking/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "company_address_id": 1,
    "date_perform": "2024-06-15 09:00:00",
    "partner_id": 12,
    "currency_id": 1,
    "comment_top": "Kérjük csomagolt szállítást.",
    "item": [
      {
        "product_id": 5,
        "store_id": 1,
        "quantity": 3,
        "tax_id": 2,
        "price": 15000
      }
    ]
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 43,
    "identify": "BK-2024-0043"
  }
}
POST /api/booking/delete

Delete a warehouse receipt. Only an open (status_id=1) or closed (status_id=2) receipt can be deleted, provided its serial numbers are not in use.

POST fields — data object

Field Type Required Description
receipt_id int Identifier of the warehouse receipt to delete

Example request

POST /api/booking/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "receipt_id": 42
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/booking/close

Close an open warehouse receipt. Closing performs stock movement and quantity validation. Only a receipt with status_id = 1 (open) can be closed.

POST fields — data object

Field Type Required Description
receipt_id int Identifier of the warehouse receipt to close

Example request

POST /api/booking/close
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "receipt_id": 42
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
GET /api/booking/download

Download/generate the warehouse receipt document in various formats (PDF, base64 string, stream).

Query parameters

Parameter Type Required Description
receipt_id int Identifier of the warehouse receipt
file_type string Output format (see below)
language string Name of the template language folder (e.g. hungarian)
language_id int Language identifier (for ID-based lookup)
template_id int Custom print template ID

Possible values for file_type

Value Description
pdf Returns a base64-encoded PDF with metadata
pdf-string Same as pdf — base64 string + metadata
pdf-string-sample Preview PDF generation
stream Direct file stream (browser download)

Example request

GET /api/booking/download?receipt_id=42&file_type=pdf
X-API-KEY: {your_api_key}

Example response (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "BK-2024-0042.pdf",
    "content": "JVBERi0xLjQK...",
    "receipt": { ... }
  }
}

Get in touch with us

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

Send an inquiry

Need help?

If you can't find the answer and need assistance

Browse the help center

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!
Create an account
Register