Skip to main content
GET
Get items

Headers

X-Delogue-Api
string

Query Parameters

Free-text search matching items by name, item number, or description.

Name
string

Filters to items whose name matches the given text.

CustomId
string

Filters by item number, the customer-defined identifier.

Description
string

Filters to items whose description matches the given text.

Brand
integer<int64>[]

Filters to items belonging to any of the given brand ids.

Supplier
integer<int64>[]

Filters to items assigned to any of the given supplier organization ids.

CompanyContactPerson
string<uuid>[]

Filters to items whose brand-side contact person is any of the given user ids.

SupplierContactPerson
string<uuid>[]

Filters to items whose supplier-side contact person is any of the given user ids.

Category
integer<int64>[]

Filters to items belonging to any of the given item category ids.

Unit
integer<int64>[]

Filters to items using any of the given unit ids.

DefaultQtyFrom

Lower bound, inclusive, for the item's default quantity.

DefaultQtyTo

Upper bound, inclusive, for the item's default quantity.

IsActive
(integer<int32> | string<int32>)[]

Filters by active status. Pass 1 for active items or 0 for inactive items.

ReadyForExport
(integer<int32> | string<int32>)[]

Filters by ready-for-export status. Pass 1 for ready items or 0 for not-ready items.

LastUpdated
string<date-time>[]

Filters by last-updated date range. Pass two timestamps as the inclusive from and to bounds.

CustomFields
object[]

Filters by custom field values. Each entry matches items on the given field's values, allowed-value ids, or date range.

sort
object[]

Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id, Name, UserDefinedId, Brand, Supplier, CompanyContactPerson, SupplierContactPerson, IsActive, ReadyForExport, LastUpdated, Deadline, ETD, AdminUnit, DefaultQty.

pageSize

The maximum number of items to return per page. Defaults to 30, maximum 100.

pageNumber

The 1-based page number to return. Defaults to 1.

cursor
string

An opaque keyset pagination token. Mutually exclusive with the filter, sort, pageSize, and pageNumber parameters.

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
object[]
required

The page of results, always an array. An empty page is an empty array rather than null or an omitted field.

pagination
object
required

Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.