Categorias

Listar categorias

Método utilizado para listar as categorias existentes. Os parâmetros abaixo são opcionais — caso nenhum seja informado, serão retornadas todas as categorias. Os parâmetros não fazem busca exata; retornam registros que contenham o texto informado. Por exemplo, ao filtrar a descrição "carne", serão retornadas todas as categorias que contêm a palavra "carne" em sua descrição. O filtro de código possui o mesmo comportamento.

Retorno

O retorno deste método será sempre um array com os objetos das categorias filtradas.

get/categorias

Request

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

Query parameters

nomestring

Nome da categoria a ser filtrada (busca parcial).

codigostring

Código da categoria a ser filtrada (busca parcial).

Response

Lista de categorias.

idstring
nomestring
codigostring nullable
imagemstring nullable

Example response

[
  {
    "id": "6048f2b4b6fa7c28844582d5",
    "nome": "Utensílios",
    "codigo": "12234",
    "imagem": "https://minio.vendizap.com/vendizap-categorias/550a0eb3812c3e44071a03ea13cb0170.jpg"
  }
]

Changes

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