Items
List serialized items
Returns the specific physical units of the inventory with their serial number, their status and which order they are committed to right now.
items:readitems:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Filter by itemId to keep those of one catalog item. It is the piece that lets an external system know which unit is where. It emits no purchase prices or supplier agreements.
Arguments
Page size (1-500). Defaults to 50.
Limits: min 1, max 500
Opaque cursor of the page to return. Pass the value of pagination. from the previous response; treat it as opaque.
Limits: max length 200
Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, code, serialNumber, status, condition, itemName. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.
Limits: max length 200
Filter by catalog item: returns only its physical units.
Limits: min length 1, max length 100
Filter by itemId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Filter by warehouse or space where the unit is located.
Limits: min length 1, max length 100
Filter by spaceId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Filter by unit status. If omitted, all are returned.
Available options: available, prepared, picked_up, returned, broken, archived, sold
Filter by status, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Available options: available, prepared, picked_up, returned, broken, archived, sold
Limits: min 1 items, max 50 items
Filter by inventory type: "regular" is own stock, "temporary" is stock brought in for a specific job (subrent). If omitted, both are returned.
Available options: regular, temporary
Filter by inventoryType, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Available options: regular, temporary
Limits: min 1 items, max 50 items
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, updated.
Show child attributesHide child attributes
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique identifier of the physical unit.
Internal code of the unit.
Manufacturer serial number; null if not registered.
Current status of the unit within the inventory cycle.
Condition; null if not assessed.
"regular" for own stock, "temporary" for stock brought in for a specific job.
Identifier of the catalog item this unit belongs to.
Name of the catalog item.
SKU of the item; null if it has none.
Variant identifier; null if the item has no variants.
Variant name; null if not applicable.
Order that holds the unit once it is prepared, picked up, sold or returned; null otherwise. A unit that is only reserved on an order is not committed yet: it stays available and this is null (the reservation is read from the serial numbers of the order line).
Number of that order; null if the unit is free.
Project associated with the current order; null if not applicable.
Customer of the current order; null if not applicable.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs GET /api/v1/serialized-items.
Related pages
Link to this section: Related pagesItems
List serialized items
Returns the specific physical units of the inventory with their serial number, their status and which order they are committed to right now.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?