> For the complete documentation index, see [llms.txt](https://apidocs.cloudinvoice.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.cloudinvoice.net/documentacao-api/produtos/list.md).

# List

Fornece uma lista de todos os produtos existentes.

## Listar Produtos

<mark style="color:blue;">`GET`</mark> `https://api.cloudinvoice.net/products/`

#### Query Parameters

<table data-search="false"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>limit</td><td>integer</td><td>Define o número de registos por pesquisa.</td></tr><tr><td>offset</td><td>integer</td><td><p>Indica a posição inicial da pesquisa.</p><p>Retorna a lista de registos compreendida entre <code>offset</code> e <code>offset+limit</code>.</p></td></tr><tr><td>ordering</td><td>string<br><sub><mark style="color:$info;">Default: "id"</mark></sub></td><td><p>Define o campo e a direção a usar na pesquisa de registos. </p><p></p><p>Campos ordenáveis:</p><ul><li><code>id</code>, <code>code</code>, <code>description</code>, <code>short_description</code>, <code>family</code></li></ul><p>Use '-' antes do nome para ordem decrescente.</p></td></tr><tr><td>search</td><td>string</td><td><p>Define o termo de pesquisa a utilizar na lista de registos. </p><p></p><p>Campos Pesquisados:</p><ul><li><code>code</code>, <code>description</code>, <code>short_description</code>, <code>long_description</code>, <code>bar_code</code>, etc.</li></ul></td></tr><tr><td>code</td><td>integer</td><td><p>Código do Produto</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>__search</code>: para pesquisa parcial</li></ul></td></tr><tr><td>description</td><td>string</td><td><p>Descrição</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>__search</code>: para pesquisa parcial</li></ul></td></tr><tr><td>short_description</td><td>string</td><td><p>Descrição Curta</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>__search</code>: para pesquisa parcial</li></ul></td></tr><tr><td>long_description</td><td>string</td><td><p>Descrição Alargada</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>__search</code>: para pesquisa parcial</li></ul></td></tr><tr><td>family</td><td>integer</td><td>Família</td></tr><tr><td>sub_family</td><td>integer</td><td>Sub-Família</td></tr><tr><td>bar_code</td><td>string</td><td><p>Código de Barras</p><p></p><p>Sufixos disponíveis:</p><ul><li><code>__search</code>: para pesquisa parcial</li></ul></td></tr></tbody></table>

{% tabs %}
{% tab title="Exemplo de Pedido" %}

```shell
curl https://api.cloudinvoice.net/products/
    -H "Content-Type: application/json"
```

{% endtab %}

{% tab title="Exemplo de Resposta" %}

```json
{
    "limit": 10,
    "offset": 0,
    "count": 46,
    "next": "https://api.cloudinvoice.net/products/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 1,
            "code": "PROD1",
            "bar_code": "5449000000996",
            "description": "Produto Standard 1",
            "short_description": "Produto Standard 1",
            "vat_tax_rate": 23.0,
            "unit_price": 100.0,
            "unit_price_tax_inc": 123.0,
            "family_id": 1,
            "family": {
                "code": "FAM1",
                "description": "Família 1"
            },
            "sub_family_id": null,
            "sub_family": null,
            "product_type_id": 131,
            "product_type": {
                "code": "01",
                "description": "Produto"
            },
            "product_category_id": 211,
            "product_category": {
                "code": "M",
                "description": "Mercadorias"
            },
            "measure_unit_id": 1,
            "measure_unit": {
                "code": "UNI",
                "description": "Unidade"
            },
            "vat_tax_id": 1,
            "vat_tax": {
                "code": 1,
                "description": "Taxa Normal"
            }
        },
        ...
    ]
}
```

{% endtab %}
{% endtabs %}

Para ver exemplos de pedidos nas várias linguagens, consulte a página[ Exemplos de Pedidos.](/introducao/exemplos-de-pedidos.md)

{% hint style="info" %}
**Notas:** Alguns dos campos do termo de pesquisa geral poderão ser incluídos mediante critérios específicos (Ex: Descrição será incluída na pesquisa geral apenas se o termo de pesquisa contiver 3 ou mais caracteres). Por defeito, o comportamento expectável será obter-se todos os items cujo o texto a pesquisar (search) esteja CONTIDO em pelo menos um dos campos incluídos na pesquisa geral.
{% endhint %}