InventoryFiltersInput

Filtering options for inventory items.

input InventoryFiltersInput {
  brandIds: [ID!]
  buildingIds: [ID!]
  depths: [DepthEnum!]
  keyword: String
  locationIds: [ID!]
  productAttributeFilters: [ProductAttributeFilterInput!]
  productStatus: StatusEnum
  productType: ProductTypeEnum
  quickSearch: String
  sortField: InventorySortFieldsEnum
  sortType: SortTypeEnum
}

Fields

InventoryFiltersInput.brandIds ● [ID!] list scalar common

Product Brand IDs to filter inventory items by. If not provided, the system will use company context.

InventoryFiltersInput.buildingIds ● [ID!] list scalar common

Building IDs to filter inventory items by.

InventoryFiltersInput.depths ● [DepthEnum!] list enum inventory

Depth to filter inventory items by.

InventoryFiltersInput.keyword ● String scalar common

Keyword to search for in the inventory items. This filters by name, sku, and UPC.

InventoryFiltersInput.locationIds ● [ID!] list scalar common

Location IDs to filter inventory items by.

InventoryFiltersInput.productAttributeFilters ● [ProductAttributeFilterInput!] list input products

Filter inventory items by product attribute values. Multiple entries are AND-combined.

InventoryFiltersInput.productStatus ● StatusEnum enum common

Status of the product.

InventoryFiltersInput.productType ● ProductTypeEnum enum products

Product type to filter inventory items by.

InventoryFiltersInput.quickSearch ● String scalar common

Quick search for inventory items. This only searches by SKU prefix or product name.

InventoryFiltersInput.sortField ● InventorySortFieldsEnum enum inventory

Field to sort the inventory items by.

InventoryFiltersInput.sortType ● SortTypeEnum enum common

Sort type for the inventory items.

Member Of

listAvailableItems query ● listInventory query