Início > Categorias
Versão: 2.0
Categorias
Última Atualização: 28/02/2024
As categorias de produtos são uma solução que visa facilitar a busca do usuário por produtos através de categorias.
Exemplo: limpeza, linha de frutas, linha de bebê.
Nas mesmas, devem ser adicionados produtos que estejam correlacionados ao tema.
Parâmetros da requisição
arvore_id: Integer
Ex: 1
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
arvore_id
Id da arvore de categorias.
Tipo: Integer.
categorias
Categorias pertencentes a árvore.
Tipo: Lista de JSON.
nome
Nome da categoria.
Tipo: String.
categoria_id
Id da categoria.
Tipo: String.
categoria_superior_id
Categoria mãe. Caso não tenha uma categoria mãe, não é necessário enviar o campo.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
422 Validation Error
500 Internal Server Error
GET Categorias
Última Atualização: 08/05/2024
Este endpoint irá receber categorias de uma arvore de categorias.
Endpoint GET
POST Categorias
Última Atualização: 08/05/2024
Este endpoint irá adicionar categorias a uma arvore de categorias.
Endpoint POST
Sintaxe da Requisição
Para que a requisição do método Post seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da Requisição
arvore_id
Id da arvore de categorias.
Tipo: Integer.
categorias
Categorias pertencentes a árvore.
Tipo: Lista de JSON.
nome
Nome da categoria.
Tipo: String.
categoria_id
Id da categoria.
Tipo: String.
categoria_superior_id
Categoria mãe. Caso não tenha uma categoria mãe, não é necessário enviar o campo.
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
success
Sucesso da requisição.
Tipo: Boolean.
categorias
Categorias pertencentes a árvore.
Tipo: Lista de JSON.
id
id.
Tipo: Integer.
nome
Nome da categoria.
Tipo: String.
arvore_id
Id da arvore.
Tipo: Integer.
categoria_id
Id da categoria.
Tipo: String.
categoria_superior_id
Categoria mãe. Caso não tenha uma categoria mãe, não precisa enviar o campo.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
422 Validation Error
500 Internal Server Error
PATCH Categorias
Última Atualização: 08/05/2024
Este endpoint irá atualizar categorias de uma arvore de categorias.
Endpoint PATCH
Sintaxe da Requisição
Para que a requisição do método Patch seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da Requisição
arvore_id
Id da arvore de categorias.
Tipo: Integer.
categorias
Categorias pertencentes a árvore.
Tipo: Lista de JSON.
nome
Nome da categoria.
Tipo: String.
categoria_id
Id da categoria.
Tipo: String.
categoria_superior_id
Categoria mãe. Caso não tenha uma categoria mãe, não precisa enviar o campo.
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
success
Sucesso da requisição.
Tipo: Boolean.
categorias
Categorias pertencentes a árvore.
Tipo: Lista de JSON.
id
id.
Tipo: Integer.
nome
Nome da categoria.
Tipo: String.
arvore_id
Id da arvore.
Tipo: Integer.
categoria_id
Id da categoria.
Tipo: String.
categoria_superior_id
Categoria mãe. Caso não tenha uma categoria mãe, não é necessário enviar o campo.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
422 Validation Error
500 Internal Server Error
DELETE Categorias
Última Atualização: 08/05/2024
Este endpoint irá deletar categorias pelo id. Nele podem ser deletadas diversas categorias de uma vez.
Endpoint DELETE
Sintaxe da Requisição
Para que a requisição do método Delete seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da Requisição
arvore_id
Id da arvore de categorias.
Tipo: Integer.
ids
Lista de IDs das categorias que serão deletadas.
Tipo: Lista de integer.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
success
Sucesso da requisição.
Tipo: Boolean.
result
Categorias pertencentes a árvore.
Tipo: Lista de JSON.
id
id.
Tipo: Integer.
nome
Nome da categoria.
Tipo: String.
arvore_id
Id da arvore.
Tipo: Integer.
categoria_id
Id da categoria.
Tipo: String.
categoria_superior_id
Categoria mãe. Caso não tenha uma categoria mãe, não é necessário enviar o campo.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
422 Validation Error
500 Internal Server Error