Base URL
https://{tenant}.logzi.com/api/collect_item/
Every request returns a JSON response. On success result.code == 1, on error result.code == 0. A collect item represents a line of a picking document. Through the item you can update the storage location, the pallet, the price, the checked status and the serial numbers.
/api/collect_item/get
Retrieve a single collect item by its identifier.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Collect item identifier |
Example request
GET /api/collect_item/get?id=1
X-API-KEY: {your_api_key}/api/collect_item/list
List of items belonging to a picking document.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
receipt_id | int | Picking document identifier | |
receipt_type_id | int | Document type identifier | |
list_count | int | Maximum number of rows to return | |
list_offset | int | Pagination offset (default: 0) | |
list_condition | object | Object containing filter conditions | |
list_params | object | Additional query parameters | |
list_sort | string | Sort field name |
Example request
GET /api/collect_item/list?receipt_id=100&receipt_type_id=22&list_offset=0
X-API-KEY: {your_api_key}/api/collect_item/save
Update the storage details and status of a collect item.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the item to update | |
store_id | int | Warehouse identifier | |
store_locality_id | int | Storage location identifier | |
pallet_id | int | Pallet identifier | |
comment_top | string | Item comment | |
price | float | Item price | |
checked | int | 1 = checked, 0 = not checked |
Example request
POST /api/collect_item/save
X-API-KEY: {your_api_key}
Content-Type: application/json
{
"data": {
"id": 42,
"store_locality_id": 5,
"checked": 1
}
}/api/collect_item/delete
Delete a collect item by its identifier.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the item to delete |
Example request
POST /api/collect_item/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 42 } }Create your account now,
pay later!
