Search

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

Searches items and returns item IDs. Search the item catalog when only matching item IDs are needed. Requires at least one of code, name, articul or barcode and item select permission; returns an array of item IDs in result. The filters field does not affect the search. Missing body or criteria, denied access and search failures return 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 Unsigned 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
  ]
}