INPUT_OBJECT

ProductFilterInput

Filter conditions for Product records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

link GraphQL Schema definition

  • input ProductFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [ProductFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [ProductFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: ProductFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Whether this product can be added to all pipelines or only the explicitly linked
  • # subset (see productPipelineRelations).
  • allowedPipelines: AccessPipelinesEnumFilterInput
  • # Id of the currency exchange rate list applied to this product.
  • currencyExchangeRatesListId: EntityFilterStringField
  • # Free-form description of the product.
  • description: EntityFilterStringField
  • # Name of the product, shown in catalogues and pickers.
  • name: EntityFilterStringField
  • # Id of the product picture document.
  • pictureId: EntityFilterStringField
  • # Id of the product category this product belongs to, or empty when it is not
  • # categorized.
  • productCategoryId: EntityFilterStringField
  • # Id of the product type that classifies this product.
  • productTypeId: EntityFilterStringField
  • # Stock-keeping unit (SKU) identifier of the product. Must be unique across
  • # products.
  • sku: EntityFilterStringField
  • # Unit of measure shown next to product quantities (e.g. pcs, kg, hours).
  • unitSymbol: EntityFilterStringField
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # Id of a pipeline. Matches products that can be used in it: products available in
  • # all pipelines and products assigned to this pipeline.
  • allowedForPipeline: UUID
  • # Filters products by whether their product type has been deleted.
  • isTypeDeleted: Boolean
  • # Conditions on custom fields, each identified by its api name. All listed
  • # conditions must match.
  • withCustom: [CustomField!]
  • # Currency exchange rate list used to convert monetary fields linked to this
  • # product. Empty to inherit the team space default. Matches records where a
  • # related record meets these conditions.
  • currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput
  • # Product picture. Matches records where a related record meets these conditions.
  • picture: CloudObjectFilterInput
  • # Product category this product belongs to. Categories form a hierarchy used in
  • # the catalog browser. Matches records where a related record meets these
  • # conditions.
  • productCategory: ProductCategoryFilterInput
  • # Product type that classifies this product. Product types are configurable per
  • # team space and drive which form, fields and product-line behavior apply. Matches
  • # records where a related record meets these conditions.
  • productType: ProductTypeFilterInput
  • # Deprecated pipeline connection. Matches records where a related record meets
  • # these conditions.
  • productPipelineRelations: ProductPipelineRelationFilterInput
  • }

link Require by