Inventory Filter Object
The inventory filter JSON object is returned as a single object or an array of objects depending on the API endpoint. The object’s attributes are described below:
|
Attribute |
Type |
Description |
|---|---|---|
|
id |
string |
Unique identifier for the inventory filter. |
|
name |
string |
User specified name of the inventory filter. |
|
app_scope_id |
string |
ID of the scope associated with the filter. |
|
short_query |
JSON |
Filter (or match criteria) associated with the filter. |
|
primary |
boolean |
When ‘true’ the filter is restricted to the ownership scope. |
|
public |
boolean |
When ‘true’ the filter provides a service for its scope. Must also be primary or scope restricted. |
|
query |
JSON |
Filter (or match criteria) associated with the filter in conjunction with the filters of the parent scopes. These conjunctions take effect if ‘restricted to ownership scope’ checkbox is checked. If ‘primary’ field is false then query is same as short_query. |