> 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/componentes/list.md).

# List

Fornece uma lista de components de produtos.

## Listar Componentes de Produtos

{% hint style="warning" %}
Os Componentes estão disponíveis apenas para certos tipos de Produtos (Compostos, Pack, Fabricados, Transformados).
{% endhint %}

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

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

#### Path Parameters

| Name     | Type    | Description   |
| -------- | ------- | ------------- |
| prod\_id | integer | ID do Produto |

#### Query Parameters

| Name     | Type                                                                                      | Description                                                                                                                                                                                           |
| -------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| limit    | integer                                                                                   | Define o número de registos por pesquisa.                                                                                                                                                             |
| offset   | integer                                                                                   | <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>                                                    |
| ordering | <p>string<br><sub><mark style="color:$info;">Default: "sequence\_number"</mark></sub></p> | <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>sequence\_number</code></li></ul><p>Use '-' antes do nome para ordem decrescente.</p> |

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

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

{% endtab %}

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

```json
{
    "limit": 10,
    "offset": 0,
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "sequence_number": 1,
            "quantity": 1.0,
            "description": "",
            "product_id": 6,
            "product": {
                "code": "COMP",
                "description": "Produto Composto"
            },
            "product_component_id": 1,
            "product_component": {
                "code": "001",
                "description": "Produto 1"
            }
        },
        {
            "id": 2,
            "sequence_number": 2,
            "quantity": 1.0,
            "description": "",
            "product_id": 6,
            "product": {
                "code": "COMP",
                "description": "Produto Composto"
            },
            "product_component_id": 2,
            "product_component": {
                "code": "002",
                "description": "Produto 2"
            }
        }
    ]
}
```

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