POST categorias produto - Varejonline/api GitHub Wiki

URL

POST https://integrador.varejonline.com.br/apps/api/categorias-produto

Parâmetros

Envie um JSON no corpo da requisição, contendo:

  • nome: nome da categoria de produtos (string) (obrigatório)
  • unidade: sigla da unidade de medida utilizada pelos produtos desta categoria (string) (obrigatório)
  • origem: número de 0 a 7 que representa a origem a ser sugerida aos produtos da categoria, segundo a tabela da receita federal (long) (obrigatório) [veja a lista de Origens] (Origens-de-Mercadoria)
  • categoriaPai: lista de ids das categorias de produtos pai, caso a nova categoria a ser criada for uma subcategoria de outras categorias de produtos já existente(long) (opcional)
  • classificacao: classificação a ser sugerida aos produtos desta categoria, que indica a finalidade para a qual eles serão utilizados. Pode assumir um dos seguintes valores: PRODUCAO_PROPRIA, REVENDA, ATIVO_IMOBILIZADO, CONSUMO, SERVICO_ISS, SERVICO_ICMS, INSUMO (string) (obrigatório)
  • metodoControle: método de controle de estoque a ser sugerido aos produtos associados à categoria, podendo assumir um dos seguintes valores: ESTOCAVEL, LOTE, SERIE, NAO_ESTOCAVEL (string) (obrigatório)
  • ativo: indica se a categoria de produto está ativa ou não. Se não for informado, o produto é cadastrado como ativo. (boolean) ( opcional)
  • nivel: nome do nível de categoria (string)

Retorno

Retorna um Json com informações do resultado da operação realizada, contendo:

  • idRecurso: id da categoria gerada.
  • codigoMensagem: Código de identificação da operação realizada. [veja a lista de Códigos] (Retorno-API)
  • mensagem: Mensagem da operação realizada

Exemplo

POST https://integrador.varejonline.com.br/apps/api/categorias-produto

'Content-Type'='application/json'

   {
      "nome":"CATEGORIA LIMPEZA",
      "classificacao":"REVENDA",
      "unidade":"CAIXA",
      "metodoControle":"ESTOCAVEL",
      "origem":0,
      "ativo":true,
      "nivel":"NOME DO NIVEL",
   }

Exemplo de retorno:

Sucesso:

  • HTTP STATUS 201 – CREATED
  • Body:
{
      "idRecurso": 1,
      "codigoMensagem": 0,
      "mensagem": "Operação realizada com sucesso."
}

Requisição inválida:

  • HTTP STATUS 400 – BAD REQUEST
  • Body:
{
      "idRecurso": 0,
      "codigoMensagem": 51,
      "mensagem": "Categoria sem nome"
}