Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Atualizar a categoria vinculada à uma família/divisão.

Chamada

POST ​[URLAPI]/CadastrosEstruturaisAPI/api/v1/Familia/{id}/ativar-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)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

idParâmetro de rota para indicar a categoria a ser ativada

integer($int64)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

idCategoria

Identificador da categoria

integer($int64)Mínimo: 0
Máximo: 9999
nroDivisao

Número da divisão

integer($int64)Mínimo: 0
Máximo: 999
tipoTipo. Valores: M - Mix / C - Consumidor / L - Lista de preçostringMáximo: 1

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • Success (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

[
  {
    "idFamilia": 0,
    "idCategoria": 0,
    "nroDivisao": 0,
    "status": "string",
    "dataHoraAlteracao": "2021-02-17T19:00:44.538Z",
    "usuarioAlteracao": "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
    }
  ]
}