---
title: "Retorna uma lista de produtos."
method: GET
path: "/v1/products"
tags: ["products"]
---

# Retorna uma lista de produtos.

`GET /v1/products`

Utilize este método para listar os produtos associados à sua conta na Vindi. Leia a documentação sobre [paginação](http://atendimento.vindi.com.br/hc/pt-br/articles/203020644#pagination) e [filtros de busca](http://atendimento.vindi.com.br/hc/pt-br/articles/204163150).

#### Atributos para busca
<code>id</code>, <code>name</code>, <code>code</code>, <code>status</code>, <code>invoice</code>, <code>unit</code>, <code>pricing_schema_id</code>, <code>created_at</code>, <code>updated_at</code>, <code>schema_type</code> e <code>price</code>.

## Query parameters

- `page` integer
- `per_page` integer
- `query` string
- `sort_by` 'id' | 'name' | 'code' | 'status' | 'invoice' | 'unit' | 'pricing_schema_id' | 'created_at' | 'updated_at' | 'schema_type' | 'price'
- `sort_order` 'asc' | 'desc'

## Response `200`

Consulta realizada com sucesso.

- Product[]
  - `id` integer, required — ID do produto
  - `name` string, required — Nome do produto
  - `code` string — Código externo do produto
  - `unit` string — Texto para descrever uma unidade do produto. Apenas para quantidade variável
  - `status` 'active' | 'inactive' | 'deleted', required — Status do produto
  - `description` string — Descrição interna do produto
  - `invoice` 'always' | 'never' — Indica se este produto será incluído na emissão de notas fiscais. Se não informado, o valor `always` será utilizado
  - `created_at` string, required — Data e hora do cadastro do produto
  - `updated_at` string, required — Data e hora da última atualização do produto
  - `pricing_schema` PricingSchema
    - `id` string, required — ID do esquema de precificação
    - `short_format` string, required — Descrição da precificação gerada automaticamente
    - `price` number, required — Preço base
    - `minimum_price` number — Preço mínimo
    - `schema_type` 'flat' | 'per_unit' | 'step_usage' | 'volume_usage' | 'tier_usage', required — Tipo de cálculo da precificação
    - `pricing_ranges` PricingRange[] — Lista de faixas de precificação
      - `id` string, required — ID do faixa de precificação
      - `start_quantity` integer, required — Início da faixa
      - `end_quantity` integer — Término da faixa. Opcional apenas para a última
      - `price` number, required — Preço da unidade ou da faixa, dependendo do tipo escolhido
      - `overage_price` number — Preço unitário do excedente da faixa
    - `created_at` string, required — Data e hora do cadastro do esquema de precificação
  - `metadata` object — Metadados do produto

## Other responses

- `400` — Erro de sintaxe JSON no corpo do request.
- `422` — Parâmetros inválidos. Verificar erro na resposta.

---

[API](https://skmtc.net/vindi/apis/001-vindi-pagamentos-agost.md) · [All operations](https://skmtc.net/vindi/apis/001-vindi-pagamentos-agost/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vindi/001-vindi-pagamentos-agost/revisions/9d11e5de9308/schema)