Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método para incluir similaridades.

Chamada

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

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)

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

Descrição da similaridade

stringTamanho Máximo: 40
tipoSimilaridade

Tipo de similaridade Valores : K - Kit, L - Lista, C - Correlatos, D - Grupo Desconto, I - Indenização Bonificação, E - Entre Empresa, P - Lista Padrão, G - Grupo Campanha, A - Abastecimento(substituto), S\null - Similaridade.

stringTamanho Máximo: 1

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

{
  "idSimilaridade": 0,
  "descricao": "string",
  "tipoSimilaridade": "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
    }
  ]
}