Exibir origem

Objetivo

Adicionar uma categoria para uma família/divisão.

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Familia/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

Home TOTVS Varejo Supermercados > Incluir Informações da categoria de Família - POST > image-2024-5-6_12-37-49.png

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)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
idFamilia	Identificador da família	integer($int64)	Tamanho Máximo: 2147483647 Tamanho Mínimo: 0
idCategoria	Identificador da categoria	integer($int64)	Tamanho Máximo: 99999 Tamanho Mínimo: 0
nroDivisao	Número da divisão	integer($int64)	Tamanho Máximo: 999 Tamanho Mínimo: 0
status	Status. Valores: A - Ativo, I - Inativo	string	Tamanho Máximo: 1
idCategoriaImportacaoERP	Identificador da categoria utilizada para importação ERP	integer($int64)	Tamanho Máximo: 99999 Tamanho Mínimo: 0
nroDivisaoImportacaoERP	Número da divisão utilizada para importação ERP	integer($int64)	Tamanho Máximo: 999 Tamanho Mínimo: 0

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (201)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 201 - SUCCESS

{
  "idFamilia": 0,
  "idCategoria": 0,
  "nroDivisao": 0,
  "status": "string"
}

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
    }
  ]
}