Sign up Log in

Inter-Warehouse Transfer API

Manage inter-warehouse transfers — retrieval, creation, modification, closing and document download

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/transmission/

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

GET /api/transmission/get

Retrieve a single inter-warehouse transfer by ID, with full details (items, source/destination warehouse, serial numbers, project).

Query parameters

Parameter Type Required Description
id int Unique identifier of the inter-warehouse transfer

Example request

GET /api/transmission/get?id=11
X-API-KEY: {your_api_key}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 11,
    "identify": "TR-2024-0011",
    "date_create": "2024-05-06 08:30:00",
    "date_perform": "2024-05-06",
    "status_id": 1,
    "item": [
      {
        "product_id": 3,
        "quantity": 10,
        "src_store_id": 1,
        "src_store_locality_id": 4,
        "dst_store_id": 2,
        "dst_store_locality_id": 7
      }
    ]
  }
}
GET /api/transmission/list

Paginated retrieval of the inter-warehouse transfer 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[status_id] int Filter by status (1=open, 2=closed)
list_condition[status_ids] array Filter by multiple statuses at once
list_condition[company_user_id] int Filter by responsible employee ID
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[date_perform_from] date Completion date — from (YYYY-MM-DD)
list_condition[date_perform_to] date Completion date — to (YYYY-MM-DD)
list_condition[partnumber] string Filter by part number or barcode (LIKE)
list_condition[comment_bottom] string Filter by internal comment (LIKE)

Example request

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

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 11,
      "identify": "TR-2024-0011",
      "date_create": "2024-05-06",
      "status_name": "Nyitott",
      "company_user_name": "Kovács Péter"
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 8
  }
}
POST /api/transmission/save

Create or modify an inter-warehouse transfer. The source and destination warehouse must be specified separately for each item. Use data[id] = 0 for a new transfer, or provide the existing ID to modify one.

POST fields — data object

Field Type Required Description
id int 0 = new transfer, >0 = modification
company_id int Company identifier
company_user_id int Responsible employee ID
date_perform datetime Completion date (YYYY-MM-DD HH:MM:SS)
comment_bottom string Internal comment
jobnumber_id int Job number identifier
departmentnumber_id int Department number identifier
project_id int Project identifier
source_receipt_id int Source document identifier
source_receipt_type_id int Source document type identifier
item array Array of items — at least one item is required (see below)

Item fields — data[item][]

Field Type Required Description
product_id int Product identifier
quantity decimal Quantity to move
src_store_id int Source warehouse identifier
src_store_locality_id int Source storage location identifier
src_pallet_id int Source pallet identifier
dst_store_id int Destination warehouse identifier
dst_store_locality_id int Destination storage location identifier
dst_pallet_id int Destination pallet identifier

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/transmission/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "date_perform": "2024-06-10 08:00:00",
    "item": [
      {
        "product_id": 3,
        "quantity": 10,
        "src_store_id": 1,
        "src_store_locality_id": 4,
        "dst_store_id": 2,
        "dst_store_locality_id": 7
      }
    ]
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 12,
    "identify": "TR-2024-0012"
  }
}
POST /api/transmission/save_group

Create a bulk inter-warehouse transfer. The source and destination warehouse/storage location/pallet data must be specified at the data level — these apply uniformly to all items.

POST fields — data object

Field Type Required Description
company_id int Company identifier
company_user_id int Responsible employee ID
src_store_id int Source warehouse identifier (applies to all items)
src_store_locality_id int Source storage location identifier (applies to all items)
src_pallet_id int Source pallet identifier (applies to all items)
dst_store_id int Destination warehouse identifier (applies to all items)
dst_store_locality_id int Destination storage location identifier (applies to all items)
dst_pallet_id int Destination pallet identifier (applies to all items)
date_perform datetime Completion date (YYYY-MM-DD HH:MM:SS)
comment_bottom string Internal comment
item array Array of items — only product_id and quantity are required per item

Example request

POST /api/transmission/save_group
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "company_id": 1,
    "company_user_id": 3,
    "src_store_id": 1,
    "src_store_locality_id": 4,
    "dst_store_id": 2,
    "dst_store_locality_id": 7,
    "date_perform": "2024-06-10 08:00:00",
    "item": [
      { "product_id": 3, "quantity": 10 },
      { "product_id": 7, "quantity": 4 }
    ]
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 13,
    "identify": "TR-2024-0013"
  }
}
POST /api/transmission/delete

Delete an inter-warehouse transfer. Only documents with status_id = 1 (open) or status_id = 2 (closed) can be deleted.

POST fields — data object

Field Type Required Description
receipt_id int Identifier of the inter-warehouse transfer to delete

Example request

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

{
  "data": {
    "receipt_id": 11
  }
}

Example response

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

Close an open inter-warehouse transfer. Only documents with status_id = 1 (open) can be closed.

POST fields — data object

Field Type Required Description
receipt_id int Identifier of the inter-warehouse transfer to close

Example request

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

{
  "data": {
    "receipt_id": 11
  }
}

Example response

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

Generate the inter-warehouse transfer document in various formats (PDF, base64 string, stream).

Query parameters

Parameter Type Required Description
receipt_id int Identifier of the inter-warehouse transfer
file_type string Output format (see below)
language string Name of the template language folder (e.g. hungarian)
language_id int Language identifier (default: 1)
template_id int Custom print template ID

Possible file_type values

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

Example request

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

Example response (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "TR-2024-0011.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