v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
products

Retorna uma lista de produtos.

Utilize este método para listar os produtos associados à sua conta na Vindi. Leia a documentação sobre paginação e filtros de busca.

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>.

get/v1/products

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

querystring

Filtro para busca

sort_by'id' | 'name' | 'code' | 'status' | 'invoice' | 'unit' | 'pricing_schema_id' | 'created_at' | 'updated_at' | 'schema_type' | 'price'

Atributo opcional para ordenação

sort_order'asc' | 'desc'

Sentido opcional para ordenação

Response

Consulta realizada com sucesso.

idinteger required

ID do produto

namestring required

Nome do produto

codestring

Código externo do produto

unitstring

Texto para descrever uma unidade do produto. Apenas para quantidade variável

status'active' | 'inactive' | 'deleted' required

Status do produto

descriptionstring

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_atstring required

Data e hora do cadastro do produto

updated_atstring required

Data e hora da última atualização do produto

metadataobject

Metadados do produto