# List

## Lista de Produtos

## Fornece uma Lista de todos os produtos existentes.

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

#### Query Parameters

| Name               | Type    | Description                                                                                                                                                                                                                        |
| ------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| limit              | integer | Define o número de produtos por pesquisa.                                                                                                                                                                                          |
| offset             | integer | Indica a posição inicial da pesquisa. Retorna a lista de produtos compreendida entre offset:offset+limit.                                                                                                                          |
| ordering           | string  | <p>Define o campo e a direcção a usar na pesquisa de produtos. </p><p></p><p>Campos ordenáveis: id, code, description, short\_description, family. Para ordenar de forma descendente, deve usar o sinal de '-' antes do campo.</p> |
| search             | string  | <p>Define o termo de pesquisa a utilizar na lista de produtos. </p><p></p><p>Campos Pesquisados: Código, Descrição, Descrição Curta, Descrição Alargada, Código de Barras, Grupo de Produto</p>                                    |
| code               | integer | <p>Código do Produto.</p><p></p><p>Para pesquisa parcial pode usar o formato: "code\_\_search"</p>                                                                                                                                 |
| description        | string  | <p>Descrição.</p><p></p><p>Para pesquisa parcial pode usar o formato: "description\_\_search"</p>                                                                                                                                  |
| short\_description | string  | <p>Descrição Curta.</p><p></p><p>Para pesquisa parcial pode usar o formato: "short\_description\_\_search"</p>                                                                                                                     |
| long\_description  | string  | <p>Descrição Alargada.</p><p></p><p>Para pesquisa parcial pode usar o formato: "long\_description\_\_search"</p>                                                                                                                   |
| family             | integer | Família                                                                                                                                                                                                                            |
| sub\_family        | integer | Sub-Família                                                                                                                                                                                                                        |
| bar\_code          | string  | <p>Código de Barras.</p><p></p><p>Para pesquisa parcial pode usar o formato: "bar\_code\_\_search"</p>                                                                                                                             |
| price\_line        | integer | Linha de Preços a usar nos campos de Preços.                                                                                                                                                                                       |

{% 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.](https://apidocs.cloudinvoice.net/introducao/exemplos-de-pedidos)

{% 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 %}