Search

[POST] .../v1/item/search

Searches items and returns item IDs. Use this method for lightweight item matching when the client only needs matching item IDs. It searches by at least one of code, name, articul or barcode, checks item select permission and returns a long array in result. The the request supports filters; this search action still uses the explicit search fields in the request body. The request body is required and at least one search key must be provided; missing criteria, denied access and persistent search errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
articul string Item article number.
assemblable bool Whether the item can be used in production assembly.
barcode string Item barcode.
code string Item code.
compound bool Whether the item is compound.
deleted_mark bool Deletion mark filter: null - all items, true - only marked for deletion, false - only not marked for deletion.
disassemblable bool Whether the item can be used in production disassembly.
has_child bool Whether the item has child items.
name string Item name.
type string Item type: Item - item, Service - service. Null means all item types.

Request Example

{
  "filters": [
    {
      "Field": "articul",
      "Operator": "Equal",
      "Value": "string"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of Int64 Result object.

Response Example

{
  "ok": true,
  "result": [
    1
  ]
}