## Retrieves a paginated list of products.

`products.list_products(ProductListProductsParams**kwargs)  -> ProductListProductsResponse`

**get** `/api/v2/public/products`

Retrieves a paginated list of products.

### Parameters

- `page_size: Optional[str]`

- `page_start: Optional[str]`

- `product_number: Optional[Sequence[str]]`

### Returns

- `class ProductListProductsResponse: …`

  Lightweight paginated result set.

  - `page_number: int`

    Current page number (1-based).

  - `page_size: int`

    Maximum number of records returned per page.

  - `total_record_count: int`

    Total number of records matching the query across all pages.

  - `records: Optional[List[ProductItem]]`

    Collection of records for the current page.

    - `barcode: str`

      Primary barcode for the product.

    - `carrier_item_quantity: float`

    - `edit_min_max_percentage: int`

    - `price_compare_multiplier: float`

    - `product_name: str`

      Display name of the product.

    - `product_number: str`

      Unique product number.

    - `shelf_label_quantity: int`

    - `allow_decimal: Optional[bool]`

    - `attention_code: Optional[str]`

    - `average_weight: Optional[float]`

    - `barcodes_array: Optional[str]`

    - `base_unit_name: Optional[str]`

    - `brand_code: Optional[str]`

    - `brand_description: Optional[str]`

    - `category_code: Optional[str]`

    - `color: Optional[str]`

    - `color_code: Optional[str]`

    - `countries_allowed: Optional[List[str]]`

    - `countries_not_allowed: Optional[List[str]]`

    - `country_code: Optional[str]`

    - `deprecation_date: Optional[datetime]`

    - `expiration_min_range: Optional[int]`

    - `free_fields: Optional[List[FreeField]]`

      - `sort_order: int`

      - `key: Optional[str]`

      - `value: Optional[str]`

    - `general_ledger: Optional[str]`

    - `image_url: Optional[str]`

    - `is_active: Optional[bool]`

    - `is_counted: Optional[bool]`

    - `is_edit_min_max: Optional[bool]`

    - `is_edit_replenishment: Optional[bool]`

    - `is_expiration: Optional[bool]`

    - `is_order_manually: Optional[bool]`

    - `is_promotion: Optional[bool]`

    - `is_set: Optional[bool]`

    - `is_stock: Optional[bool]`

    - `is_store_product: Optional[bool]`

    - `is_template: Optional[bool]`

    - `margin_category: Optional[str]`

    - `moq: Optional[float]`

    - `old_price: Optional[float]`

    - `price: Optional[float]`

    - `price_compare_unit: Optional[str]`

    - `price_lines: Optional[str]`

    - `product_details: Optional[str]`

    - `product_type: Optional[str]`

    - `product_url: Optional[str]`

    - `promo_stores_allowed: Optional[List[str]]`

    - `promo_stores_not_allowed: Optional[List[str]]`

    - `promotion: Optional[str]`

    - `promotion_price: Optional[float]`

    - `promotion_week: Optional[str]`

    - `purchase_price: Optional[float]`

    - `purchase_unit_barcode: Optional[str]`

    - `purchase_unit_name: Optional[str]`

    - `purchase_unit_product_number: Optional[str]`

    - `purchase_unit_quantity: Optional[float]`

    - `referral_product_id: Optional[str]`

    - `reset_store_stock: Optional[bool]`

    - `set_product: Optional[List[SetProduct]]`

      - `set_item_quantity: Optional[str]`

      - `set_product_number: Optional[str]`

    - `shelf_label: Optional[bool]`

    - `shelf_label_barcode: Optional[bool]`

    - `shelf_label_layout: Optional[int]`

    - `shelf_label_price: Optional[bool]`

    - `size: Optional[str]`

    - `size_code: Optional[str]`

    - `smallest_product_number: Optional[str]`

    - `smallest_quantity: Optional[float]`

    - `special_price: Optional[float]`

    - `stores_allowed: Optional[List[str]]`

    - `stores_not_allowed: Optional[List[str]]`

    - `supplier_id: Optional[str]`

    - `supplier_name: Optional[str]`

    - `supplier_product_number: Optional[str]`

    - `units: Optional[List[Unit]]`

      - `unit_quantity: float`

      - `unit_barcode: Optional[str]`

      - `unit_name: Optional[str]`

    - `variant_code: Optional[str]`

    - `variant_factor: Optional[float]`

    - `variant_family: Optional[str]`

    - `volume: Optional[str]`

### Example

```python
import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.products.list_products()
print(response.page_number)
```

#### Response

```json
{
  "page_number": 0,
  "page_size": 0,
  "total_record_count": 0,
  "records": [
    {
      "barcode": "barcode",
      "carrier_item_quantity": 0,
      "edit_min_max_percentage": 0,
      "price_compare_multiplier": 0,
      "product_name": "product_name",
      "product_number": "product_number",
      "shelf_label_quantity": 0,
      "allow_decimal": true,
      "attention_code": "attention_code",
      "average_weight": 0,
      "barcodes_array": "barcodes_array",
      "base_unit_name": "base_unit_name",
      "brand_code": "brand_code",
      "brand_description": "brand_description",
      "category_code": "category_code",
      "color": "color",
      "color_code": "color_code",
      "countries_allowed": [
        "string"
      ],
      "countries_not_allowed": [
        "string"
      ],
      "country_code": "country_code",
      "deprecation_date": "2019-12-27T18:11:19.117Z",
      "expiration_min_range": 0,
      "free_fields": [
        {
          "sort_order": 0,
          "key": "key",
          "value": "value"
        }
      ],
      "general_ledger": "general_ledger",
      "image_url": "image_url",
      "is_active": true,
      "is_counted": true,
      "is_edit_min_max": true,
      "is_edit_replenishment": true,
      "is_expiration": true,
      "is_order_manually": true,
      "is_promotion": true,
      "is_set": true,
      "is_stock": true,
      "is_store_product": true,
      "is_template": true,
      "margin_category": "margin_category",
      "moq": 0,
      "old_price": 0,
      "price": 0,
      "price_compare_unit": "price_compare_unit",
      "price_lines": "price_lines",
      "product_details": "product_details",
      "product_type": "product_type",
      "product_url": "product_url",
      "promo_stores_allowed": [
        "string"
      ],
      "promo_stores_not_allowed": [
        "string"
      ],
      "promotion": "promotion",
      "promotion_price": 0,
      "promotion_week": "promotion_week",
      "purchase_price": 0,
      "purchase_unit_barcode": "purchase_unit_barcode",
      "purchase_unit_name": "purchase_unit_name",
      "purchase_unit_product_number": "purchase_unit_product_number",
      "purchase_unit_quantity": 0,
      "referral_product_id": "referral_product_id",
      "reset_store_stock": true,
      "set_product": [
        {
          "set_item_quantity": "set_item_quantity",
          "set_product_number": "set_product_number"
        }
      ],
      "shelf_label": true,
      "shelf_label_barcode": true,
      "shelf_label_layout": 0,
      "shelf_label_price": true,
      "size": "size",
      "size_code": "size_code",
      "smallest_product_number": "smallest_product_number",
      "smallest_quantity": 0,
      "special_price": 0,
      "stores_allowed": [
        "string"
      ],
      "stores_not_allowed": [
        "string"
      ],
      "supplier_id": "supplier_id",
      "supplier_name": "supplier_name",
      "supplier_product_number": "supplier_product_number",
      "units": [
        {
          "unit_quantity": 0,
          "unit_barcode": "unit_barcode",
          "unit_name": "unit_name"
        }
      ],
      "variant_code": "variant_code",
      "variant_factor": 0,
      "variant_family": "variant_family",
      "volume": "volume"
    }
  ]
}
```