Skip to main content

BillOfMaterialsFilterInput

Filtering options for a list of bills of materials. Every product filter applies to the product being built, so this list narrows the same way the product list does.

input BillOfMaterialsFilterInput {
  archiveStatus: ProductArchiveStatusEnum
  bomStatus: [BomRevisionStatusEnum!]
  brandIds: [ID!]
  categoryIds: [ID!] @deprecated
  colorIds: [ID!] @deprecated
  deletionStatus: ProductDeletionStatusEnum @deprecated
  description: String
  hasOpenDraft: Boolean
  ids: [ID!]
  includeBrandless: Boolean
  innerPack: Boolean
  keyword: String
  masterCarton: Boolean
  name: String
  packagingGtin: String
  pallet: Boolean
  productAttributeFilters: [ProductAttributeFilterInput!]
  productType: ProductTypeEnum
  quickSearch: String
  sizeIds: [ID!] @deprecated
  sku: String
  skus: [String!]
  sortField: BomSortFieldEnum
  sortType: SortTypeEnum
  status: ProductStatusEnum @deprecated
  styleIds: [ID!] @deprecated
  supplierIds: [ID!]
  upc: String
  upcs: [String!]
}

Fields​

BillOfMaterialsFilterInput.archiveStatus ● ProductArchiveStatusEnum enum products​

The archive status of the queried products.

BillOfMaterialsFilterInput.bomStatus ● [BomRevisionStatusEnum!] list enum products​

Limit to bills of materials whose standing revision is in these states. Only ACTIVE and DRAFT can stand; other values match nothing.

BillOfMaterialsFilterInput.brandIds ● [ID!] list scalar common​

IDs of the brands to get products for.

BillOfMaterialsFilterInput.categoryIds ● [ID!] deprecated list scalar common​

DEPRECATED

Use productAttributeFilters instead. This argument will be removed in the future.

IDs of the categories to filter products by.

BillOfMaterialsFilterInput.colorIds ● [ID!] deprecated list scalar common​

DEPRECATED

Use productAttributeFilters instead. This argument will be removed in the future.

IDs of the colors to filter products by.

BillOfMaterialsFilterInput.deletionStatus ● ProductDeletionStatusEnum deprecated enum products​

DEPRECATED

Use archiveStatus instead. This argument will be removed in the future.

The deletion status of the queried products.

BillOfMaterialsFilterInput.description ● String scalar common​

Filter products by description.

BillOfMaterialsFilterInput.hasOpenDraft ● Boolean scalar common​

Limit to products with a change in progress, or to those without one.

BillOfMaterialsFilterInput.ids ● [ID!] list scalar common​

IDs of the products to return, for fetching a known set in one request.

BillOfMaterialsFilterInput.includeBrandless ● Boolean scalar common​

When true, include products with no brand in the result set (within the current company scope).

BillOfMaterialsFilterInput.innerPack ● Boolean scalar common​

Filter products by whether they have inner pack data.

BillOfMaterialsFilterInput.keyword ● String scalar common​

Filter products by keyword. Searches in name, SKU, UPC, product type, description, brand name, and external identifiers such as an ASIN or a retailer item number. This filter is case-insensitive and should have a minimum length of 3 characters. If a keyword with less than 3 characters is provided, it will be ignored.

BillOfMaterialsFilterInput.masterCarton ● Boolean scalar common​

Filter products by whether they have master carton data.

BillOfMaterialsFilterInput.name ● String scalar common​

Filter products by name.

BillOfMaterialsFilterInput.packagingGtin ● String scalar common​

Products whose inner pack, master carton, or pallet carries this GTIN. Matches any spelling of the code, such as 12 or 14 digits.

BillOfMaterialsFilterInput.pallet ● Boolean scalar common​

Filter products by whether they have pallet data.

BillOfMaterialsFilterInput.productAttributeFilters ● [ProductAttributeFilterInput!] list input products​

Filter products by attribute values. Each entry filters by a specific attribute definition. Multiple entries are AND-combined (product must match all filters).

BillOfMaterialsFilterInput.productType ● ProductTypeEnum enum products​

Filter products by product type.

BillOfMaterialsFilterInput.quickSearch ● String scalar common​

Fast product search scoped to SKU and name. This filter is case-insensitive and is optimized for product list search.

BillOfMaterialsFilterInput.sizeIds ● [ID!] deprecated list scalar common​

DEPRECATED

Use productAttributeFilters instead. This argument will be removed in the future.

IDs of the sizes to filter products by.

BillOfMaterialsFilterInput.sku ● String scalar common​

Filter products by SKU.

BillOfMaterialsFilterInput.skus ● [String!] list scalar common​

Exact SKUs of the products to return, for matching an uploaded list in one request. Maximum 200 per request.

BillOfMaterialsFilterInput.sortField ● BomSortFieldEnum enum products​

Field to sort by.

BillOfMaterialsFilterInput.sortType ● SortTypeEnum enum common​

Sort direction.

BillOfMaterialsFilterInput.status ● ProductStatusEnum deprecated enum products​

DEPRECATED

This argument will be removed in the future. Use archiveStatus instead to determine if the product is active or inactive(archived).

BillOfMaterialsFilterInput.styleIds ● [ID!] deprecated list scalar common​

DEPRECATED

Use productAttributeFilters instead. This argument will be removed in the future.

IDs of the styles to filter products by.

BillOfMaterialsFilterInput.supplierIds ● [ID!] list scalar common​

IDs of the suppliers associated with the products.

BillOfMaterialsFilterInput.upc ● String scalar common​

Filter products by UPC.

BillOfMaterialsFilterInput.upcs ● [String!] list scalar common​

Exact UPCs of the products to return, for matching an uploaded list in one request. Maximum 200 per request.

Member Of​

productBillsOfMaterials query