Árvore de páginas

Objetivo

Método que permite inserir as categorias dos produtos.

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Categoria

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo >  Sistemas/Módulo/Aplicações > Comercial Web > API Cadastros Estruturais > API Cadastros Estruturais 


Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

AdicionarCategoriaReqDto

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
idCategoria

Identificador da categoria

integer($int64)

Mínimo: 0

Máximo: 99999

nroDivisao*

Número da divisão

integer($int64)

Mínimo: 0

Máximo: 999

descricao*

Descrição da categoria

stringTamanho Máximo: 25
tipo*

Tipo da categoria. Valores: M - Mix, C - Consumidor, L - Lista de Preço

stringTamanho Máximo: 1
aceitaFamilia*

Define se a categoria aceita famílias. Valores: S - Sim, N - Não

stringTamanho Máximo: 1
objetivoNoNegocio

Objetivo no negócio. Valores: L - Gerar Lucro, M - Gerar Movimento

stringTamanho Máximo: 1
idCategoriaPai

Identificador da categoria pai

integer($int64)

Mínimo: 0

Máximo: 99999

percMargemLucro

Percentual de margem de lucro

number($double)

Mínimo: 0

Máximo: 999.99

status*

Status da categoria. Valores: A - Ativo, I - Inativo

stringTamanho Máximo: 1
idCategoriaImportacaoERP

Identificador da categoria utilizada para importação ERP

integer($int64)

Mínimo: 0

Máximo: 99999

nroDivisaoImportacaoERP

Número da divisão utilizada para importação ERP

integer($int64)

Mínimo: 0

Máximo: 999

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

  "expandables": [
    "string"
  ],
  "idCategoria": 0,
  "nroDivisao": 0,
  "descricao": "string",
  "tipo": "string",
  "aceitaFamilia": "string",
  "objetivoNoNegocio": "string",
  "idCategoriaPai": 0,
  "categoriaPai": {
    "expandables": [
      "string"
    ],
    "idCategoria": 0,
    "nroDivisao": 0,
    "descricao": "string",
    "tipo": "string",
    "aceitaFamilia": "string",
    "objetivoNoNegocio": "string",
    "idCategoriaPai": 0,
    "percMargemLucro": 0,
    "status": "string",
    "idCategoriaImportacaoERP": 0,
    "nroDivisaoImportacaoERP": 0
  },
  "percMargemLucro": 0,
  "status": "string",
  "idCategoriaImportacaoERP": 0,
  "nroDivisaoImportacaoERP": 0
}

application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}