List

Lista de Produtos

Fornece uma Lista de todos os produtos existentes.

GET 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	Define o campo e a direcção a usar na pesquisa de produtos. Campos ordenáveis: id, code, description, short_description, family. Para ordenar de forma descendente, deve usar o sinal de '-' antes do campo.
search	string	Define o termo de pesquisa a utilizar na lista de produtos. Campos Pesquisados: Código, Descrição, Descrição Curta, Descrição Alargada, Código de Barras, Grupo de Produto
code	integer	Código do Produto. Para pesquisa parcial pode usar o formato: "code__search"
description	string	Descrição. Para pesquisa parcial pode usar o formato: "description__search"
short_description	string	Descrição Curta. Para pesquisa parcial pode usar o formato: "short_description__search"
long_description	string	Descrição Alargada. Para pesquisa parcial pode usar o formato: "long_description__search"
family	integer	Família
sub_family	integer	Sub-Família
bar_code	string	Código de Barras. Para pesquisa parcial pode usar o formato: "bar_code__search"
price_line	integer	Linha de Preços a usar nos campos de Preços.

200: OK Lista de Produtos

401: Unauthorized (Sem Resposta)

400 Lista de erros detectados

{
    // Response
}

403: Forbidden (Sem Resposta)

Exemplo de Pedido

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

Exemplo de Resposta

{
    "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"
            }
        },
        ...
    ]
}

Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.

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.