Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método para atualização dos dados de família.

Chamada

PATCH [URLAPI]/CadastrosEstruturaisAPI/api/v1/Familia

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)
idFamiliaCódigo da família

integer($int64)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
pathCaminhostringNão há.
opTipo de Operação - “add”, “remove”, “replace”, “move”, “copy” e “test”stringNão há.
valueValorstringNão há.

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

{
  "hasNext": true,
  "items": [
    {
      "expandables": [
        "string"
      ],
      "idFamilia": 0,
      "idMarca": 0,
      "nomeFamilia": "string",
      "pesavel": "string",
      "aliquotaIpi": 0,
      "usuarioAlteracao": "string",
      "dtaHorAlteracao": "2021-01-21T19:37:55.414Z",
      "usuarioInclusao": "string",
      "dtaHorInclusao": "2021-01-21T19:37:55.414Z",
      "pmtDecimal": "string",
      "indCalcIpiSaida": "string",
      "perBaseIpi": 0,
      "perIsentoIpi": 0,
      "perOutroIpi": 0,
      "perAliquotaIpi": 0,
      "vlrIpiPauta": 0,
      "codTipi": 0,
      "indComplVlrImp": "string",
      "codNbmsh": "string",
      "situacaoNfPis": "string",
      "situacaoNfCofins": "string",
      "perBasePis": 0,
      "perBaseCofins": 0,
      "atualizNcmIpi": "string",
      "aliqPadraoIcms": 0,
      "codNatRec": 0,
      "situacaoNfPisSai": "string",
      "atualizaNcmImpImport": "string",
      "perImpostoImport": 0,
      "perRedImpostoImport": 0,
      "perRedBaseIpiEnt": 0,
      "seqNatRec": 0,
      "indBebidaAlcoolica": "string",
      "sitPisCofinsSimples": "string",
      "situacaoNfIpi": "string",
      "situacaoNfIpiSai": "string",
      "aliqPadraoIcmsProtege": 0,
      "indEscritOutrosEI": "string",
      "codProdDacAl": 0,
      "codNve": "string",
      "classeEnquadramentoIpi": "string",
      "codigoSeloIpi": "string",
      "codigoEnquadramentoIpi": "string",
      "litrosTabIpiPisCofins": 0,
      "codCest": 0,
      "indMaterialApoio": "string",
      "perTributadoInt": 0,
      "situacaoNfCofinsSai": "string",
      "indVasilhame": "string",
      "marca": {
        "expandables": [
          "string"
        ],
        "idMarca": 0,
        "nomeMarca": "string",
        "status": "string"
      },
      "familiaEmbalagem": [
        {
          "expandables": [
            "string"
          ],
          "idFamilia": 0,
          "qtdPorEmbalagem": 0,
          "embalagem": "string",
          "pesoBruto": 0,
          "pesoLiquido": 0,
          "altura": 0,
          "largura": 0,
          "profundidade": 0,
          "status": "string",
          "qtdUnidEmbalagem": 0,
          "multEquipQtdEmbalagem": 0,
          "fatorMultVolume": 0,
          "multEquipEmbalagem": "string",
          "percToleranciaPeso": 0
        }
      ],
      "informacaoNutricionalFamilia": [
        {
          "idInformacaoNutricional": 0,
          "descricao": "string",
          "obsInfNutric": "string",
          "qtdPorcao": 0,
          "unidPorcao": "string",
          "intMedCaseira": "string",
          "decMedCaseira": "string",
          "medCaseira": "string",
          "tabelaNutricional": [
            {
              "idInformacaoNutricional": 0,
              "idAtributoFixo": 0,
              "descricaoQuantidadePorcao": "string",
              "percVlrDiaRef": 0
            }
          ]
        }
      ],
      "familiaDivisao": [
        {
          "expandables": [
            "string"
          ],
          "idFamilia": 0,
          "idDivisao": 0,
          "padraoEmbTransf": 0,
          "padraoEmbCompra": 0,
          "idComprador": 0,
          "idTributacao": 0,
          "finalidadeFamilia": "string",
          "formaAbastecimento": "string",
          "dtaHorInclusao": "2021-01-21T19:37:55.414Z",
          "usuarioInclusao": "string",
          "dtaHorAlteracao": "2021-01-21T19:37:55.414Z",
          "usuarioAlteracao": "string",
          "codOrigemTrib": "string",
          "idPauta": 0,
          "idPautaIcms": 0,
          "familia": {
            "expandables": [
              "string"
            ],
            "idFamilia": 0,
            "nomeFamilia": "string"
          },
          "divisao": {
            "expandables": [
              "string"
            ],
            "idDivisao": 0,
            "nomeDivisao": "string"
          },
          "comprador": {
            "expandables": [
              "string"
            ],
            "idComprador": 0,
            "nomeComprador": "string",
            "apelido": "string"
          },
          "pautaImposto": {
            "expandables": [
              "string"
            ],
            "idPauta": 0,
            "descricao": "string"
          },
          "pautaImpostoIcms": {
            "expandables": [
              "string"
            ],
            "idPautaIcms": 0,
            "descricao": "string"
          },
          "tributacao": {
            "expandables": [
              "string"
            ],
            "idTributacao": 0,
            "descricao": "string"
          },
          "familiaFinalidade": {
            "expandables": [
              "string"
            ],
            "finalidade": "string",
            "descricao": "string"
          },
          "formaAbastec": {
            "expandables": [
              "string"
            ],
            "forma": "string",
            "descricao": "string",
            "tipoCalcAbastec": "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
    }
  ]
}