Products Queries

Retrieve the product catalog including variants, options, suppliers, and images.

`Product` — Returns a single product by `id`

query GetProduct($id: ID!) {
  Product(id: $id) {
    id
    label
    sku
    type
    active
    variants_on_hand
    variants_available
    variants_count
    brand { id label }
    variants {
      paginatorInfo { total }
      data { id sku label }
    }
  }
}

`Products` — Returns a paginated list of products with sorting and filters

query Products(
  $where: QueryProductsWhereWhereConditions,
  $orderBy: [QueryProductsOrderByOrderByClause!],
  $search: String,
  $first: Int,
  $page: Int,
  $trashed: Trashed
) {
  Products(
    where: $where,
    orderBy: $orderBy,
    search: $search,
    first: $first,
    page: $page,
    trashed: $trashed
  ) {
    paginatorInfo {
      total
      currentPage
    }
    data {
      id
      label
      active
      sku
      type
      variants_available
      brand { label }
    }
  }
}

Available fields

Field	Type	Description
`id`	Int	Unique identifier.
`label`	String	Name of the product (Parent).
`active`	Boolean	True if the product is active in the catalog.
`sku`	String	Representative SKU (usually from the first variant).
`type`	String	Product category (Standard, Variant, Kit).
`description`	String	Public description used in documents and portal.
`supplier_description`	String	Specific description for purchase orders.
`track_inventory`	Boolean	True if inventory levels are managed for this product.
`country_of_origin`	String	Origin country for customs.
`has_serial_numbers`	Boolean	True if any variant uses serial number tracking.
`options_count`	Float	Number of defined options (Color, Size, etc.).
`variants_count`	Float	Total number of child variations.
`variants_with_inventory_count`	Float	Count of variations with physical stock.
`variants_on_hand`	Float	Aggregate physical stock (takes `location_ids` argument).
`variants_available`	Float	Aggregate sellable stock (takes `location_ids` argument).
`variants_incoming`	Float	Aggregate pending stock from purchases.
`variants_reserved`	Float	Aggregate committed stock from sales.
`has_batch_numbers`	Boolean	True if any variant uses batch/lot tracking.
`default_supplier_id`	Int	ID of the primary supplier.
`cover_image`	String	URL to the primary product image.
`options`	[OptionProduct]	List of options linked to the product.
`variants`	[Variant]	Paginated list of variations.
`default_variant`	Variant	Usually the first variation created.
`attributes`	[AttributeVariant]	List of attributes across all variants.
`suppliers`	[Supplier]	List of assigned suppliers.
`product_tags`	[ProductTag]	Associated classification tags.
`seasons`	[Season]	Associated commercial seasons.
`brand`	Brand	Manufacturer or brand link.
`images`	[File]	Full list of uploaded images.
`integrations`	[Integration]	Links to external platforms (Shopify, QBO, etc.).
`created_at`	DateTime	Creation timestamp.
`updated_at`	DateTime	Last update timestamp.
`custom_fields`	[EntityCustomField]	Custom fields for this entity.
`variant_custom_fields`	[EntityCustomField]	Custom fields from the first variant.

Filters

The following fields can be used in the where parameter:

id, label, sku, active, created_at, updated_at, option_id, option1_id, option2_id, option3_id, product_type, supplier_id, variants_on_hand, variants_available.

Example Filters:

Field	Example
`label`	`{ "column": "LABEL", "operator": "LIKE", "value": "%Tee-Shirt%" }`
`sku`	`{ "column": "SKU", "operator": "EQ", "value": "TSH-BLUE" }`
`active`	`{ "column": "ACTIVE", "operator": "EQ", "value": true }`
`supplier_id`	`{ "column": "SUPPLIER_ID", "operator": "EQ", "value": 5001 }`
`trashed`	Filter by trashed status. Accepts `ALL`, `TRASHED`, or `NOT_TRASHED`.

Sorting

You can sort results using the orderBy parameter:

id
label
active
created_at
updated_at
sku

Data Types

`OptionProduct`

Field	Type	Description
`product_id`	Int	Product ID.
`id`	Int	Option ID (renamed from `option_id`).
`option`	Option	The option details (e.g., Color, Size).
`product`	Product	The product this option belongs to.

`ProductIDInput`

Field	Type	Description
`id`	ID	Product ID.

Enums

`ProductImageType`

Value	Description
`productImage`	Standard image used for products.