Produtos

Listar produtos

Método utilizado para fazer uma busca dos produtos, sendo possível utilizar os campos do produto como filtro. O retorno deste método será um array de objetos de produtos. Os produtos serão retornados de maneira resumida; caso queira o produto completo, deve ser buscado pelo ID através do endpoint Buscar produto abaixo.

Com exceção dos campos variacoes, imagens e promocao, todos os demais podem ser utilizados como filtro. Todos podem ser filtrados com o seu respectivo nome, com exceção do campo categorias, que deve ser filtrado como categoria.

Os campos descricao, codigo e detalhes fazem a busca parcial, ou seja, qualquer produto que contenha parte do texto informado será retornado. Os demais campos fazem busca exata (equivalente ao operador =).

get/produtos

Request

  • Base URL: https://app.vendizap.com/api
  • URL: https://app.vendizap.com/api/produtos
  • Auth: API key in header X-Auth-Id and API key in header X-Auth-Secret

Query parameters

descricaostring

Descrição (parcial) do produto.

skipinteger

Quantidade de registros a serem ignorados (paginação).

limitinteger

Quantidade máxima de registros a retornar.

sortstring

Campo a ser utilizado para ordenação (ex. descricao).

sortType'ASC' | 'DESC'

Tipo de ordenação.

categoriastring

ID da categoria para filtrar produtos.

Response

Lista de produtos (resumida).

idstring
descricaostring
preconumber
unidadeVendastring
destaqueboolean
codigostring nullable
exibirboolean
dt_cadastrostring
dt_alteracaostring

Changes

No recorded changes to this operation across all 1 revision of this API.