Categorias

Cadastrar categoria

Método utilizado para inserir novas categorias no sistema. Caso já exista uma categoria com a mesma descrição da que está sendo inserida, será retornado apenas o Id da categoria existente com status 200, pois não deve existir duas categorias com a mesma descrição. Caso a categoria não exista, ao criá-la também retornará o Id, porém o status retornado será 201.

post/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

Request body

nomestring required

Nome da categoria (deve ser único).

imagemstring

Imagem da categoria. Pode ser enviada em base64 ou via URL.

codigostring

Código da categoria. Pode ser usado para buscar, listar ou atualizar categorias no lugar do Id.

Example request

{
  "nome": "Utensílios",
  "imagem": "https://www.vendizap.com/wp-content/themes/startit/assets/img/logo.png",
  "codigo": "api"
}

Response

Já existia uma categoria com a mesma descrição. Retornado o ID da existente.

idstring

Example response

{
  "id": "6048f2b4b6fa7c28844582d5"
}

Changes

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