Sign up Log in

Barcode Collector API

Managing collection sheets — retrieving, creating, updating, closing and changing the status of incoming and outgoing collectors

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

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

GET /api/collect/get

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

Query parameters

Parameter Type Required Description
id int Unique identifier of the collection sheet

Example request

GET /api/collect/get?id=101
X-API-KEY: {your_api_key}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 101,
    "identify": "COL-2024-0101",
    "date_create": "2024-05-01 10:00:00",
    "date_update": "2024-05-01 11:30:00",
    "receipt_type_id": 34,
    "status_id": 1,
    "company_id": 1,
    "company_user_id": 3,
    "pallet_based": 0,
    "order_out_identify": "OR-2024-0055",
    "comment_top": "",
    "comment_bottom": "",
    "item": [
      {
        "id": 201,
        "partnumber": "PROD-001",
        "quantity": 5,
        "price": 3000,
        "store_id": 1,
        "store_locality_id": 12,
        "pallet_id": null,
        "checked": 0,
        "status_id": 1
      }
    ]
  }
}
GET /api/collect/list

Paginated retrieval of the list of collection sheets, with filtering options.

Query parameters

Parameter Type Required Description
list_offset int Pagination offset (default: 0)
list_count int Number of records shown per page
list_sort[field] string Name of the field to sort by
list_sort[sort] string Sort direction: ASC or DESC
list_condition[identify] string Filter by identifier (LIKE)
list_condition[status_id] int Filter by status
list_condition[receipt_type_id] int Filter by collector type (32=incoming, 34=outgoing)
list_condition[company_user_id] int Filter by responsible user
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[partnumber] string Filter by product part number (LIKE)
list_condition[order_out_identify] string Filter by outgoing order identifier
list_condition[pallet_barcode] string Filter by pallet barcode
list_condition[store_locality_barcode] string Filter by warehouse location barcode

Example request

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

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 101,
      "identify": "COL-2024-0101",
      "date_create": "2024-05-01 10:00:00",
      "receipt_type_id": 34,
      "status_id": 1,
      "status_name": "Nyitott",
      "company_user_id": 3
    }
  ],
  "params": {
    "list_count": 20,
    "list_offset": 0,
    "list_all": 134
  }
}
POST /api/collect/save

Create or update a collection sheet. For a new collector use data[id] = 0, for an update supply the existing ID.

POST fields — data object

Field Type Required Description
id int 0 = new collection sheet, >0 = update
receipt_type_id int Collector type: 32 = incoming, 34 = outgoing
company_id int Company identifier
company_user_id int Responsible user ID
company_address_id int Company site ID
pallet_based int 1 = pallet-based collection (every item requires a pallet_id)
order_out_identify string Outgoing order reference number
order_in_identify string Incoming order reference number
invoice_in_identify string Incoming invoice reference number
delivery_note_in_identify string Incoming delivery note reference number
jobnumber_id int Job number identifier
departmentnumber_id int Department number identifier
comment_top string Comment (public)
comment_bottom string Internal comment
item array Array of items (see below)

Item fields — data[item][]

Field Type Required Description
id int 0 = new item, >0 = update existing
partnumber string Product part number
quantity float Collected quantity
price float Unit price (if left empty, filled in based on the price list)
store_id int Warehouse identifier
store_locality_id int Warehouse location identifier
pallet_id int Pallet identifier
checked int 1 = item checked/scanned
comment_top string Item comment
serialnumber array Array of serial numbers (see below)
remove int 1 = delete item on update

Serial number fields — data[item][][serialnumber][]

Field Type Required Description
val string Serial number value
expire date Expiration date (YYYY-MM-DD)
qty float Quantity belonging to this serial number

POST fields — params object (optional)

Field Type Required Description
close int 1 = automatically close after saving
status_change int Automatically change to the given status after saving

Example request

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

{
  "data": {
    "id": 0,
    "receipt_type_id": 34,
    "company_id": 1,
    "company_user_id": 3,
    "order_out_identify": "OR-2024-0055",
    "comment_bottom": "Sürgős kiszedés",
    "item": [
      {
        "partnumber": "PROD-001",
        "quantity": 5,
        "store_id": 1,
        "store_locality_id": 12,
        "checked": 1
      }
    ]
  },
  "params": {
    "close": 0
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 102,
    "identify": "COL-2024-0102",
    "item": {
      "1": {
        "id": 205,
        "partnumber": "PROD-001"
      }
    }
  }
}
POST /api/collect/delete

Delete a collection sheet. Deletable statuses: open (1), closed (2), and the various in-progress states (15, 16, 31–36).

POST fields — data object

Field Type Required Description
receipt_id int Identifier of the collection sheet to delete

Example request

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

{
  "data": {
    "receipt_id": 101
  }
}

Example response

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

Close an open collection sheet. Closing performs the stock movement and validates the item quantities. Only a collector with status_id = 1 (open) can be closed.

POST fields — data object

Field Type Required Description
receipt_id int Identifier of the collection sheet to close

Example request

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

{
  "data": {
    "receipt_id": 101
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/collect/status_change

Change the status of a collection sheet between the steps of the processing workflow. Status 16 (picked) can only be set for an outgoing (type 34) collector, from status 15.

POST fields — data object

Field Type Required Description
receipt_id int Identifier of the collection sheet
status_id int Identifier of the new status
comment_bottom string Update the internal comment
company_user_id int Reassign the responsible user to another user

Example request

POST /api/collect/status_change
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "receipt_id": 101,
    "status_id": 15,
    "comment_bottom": "Kiszedésre vár"
  }
}

Example response

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

Download/generate the document of a collection sheet in various formats (PDF, base64 string, stream).

Query parameters

Parameter Type Required Description
receipt_id int Identifier of the collection sheet
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 file_type values

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/collect/download?receipt_id=101&file_type=pdf
X-API-KEY: {your_api_key}

Example response (file_type=pdf)

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