Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método de consulta que retorna informações dos produto.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Produto

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

Parâmetros URI (URI Parameters)

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

IdProduto

Lista de identificadores de produtos

array[integer]

Não há.

DataHoraAlteracao

Data/Hora de alteração

string($date-time)

Não há.

DataInclusao

Data de inclusão

string($date-time)

Não há.

CodigoAcesso

Código de Acesso

string

Não há.
ExpandExpandir os camposstringNão há.

Fields

CamposstringNão há.

Order

OrdenaçãostringNão há.
PagePáginas

integer($int32)

Não há.
PageSizeTamanho das páginas

integer($int32)

Não há.

Parâmetros do Corpo (Body Parameters)

Nã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"
      ],
      "idProduto": 0,
      "idFamilia": 0,
      "complemento": "string",
      "descricaoCompleta": "string",
      "descricaoReduzida": "string",
      "descricaoGenerica": "string",
      "referenciaFabricante": "string",
      "especificacaoDetalhada": "string",
      "processoFabricacao": "string",
      "idProdutoBase": 0,
      "numeroDiasValidadeRecebimento": 0,
      "codigoANP": 0,
      "descricaoANP": "string",
      "usuarioInclusao": "string",
      "dataHoraInclusao": "2020-11-18T16:06:09.736Z",
      "usuarioAlteracao": "string",
      "dataHoraAlteracao": "2020-11-18T16:06:09.736Z",
      "familia": {
        "expandables": [
          "string"
        ],
        "idFamilia": 0,
        "marca": {
          "expandables": [
            "string"
          ],
          "idMarca": 0,
          "nomeMarca": "string",
          "status": "string"
        },
        "nomeFamilia": "string",
        "pesavel": "string",
        "aliquotaIpi": 0,
        "usuarioAlteracao": "string",
        "dtaHorAlteracao": "2020-11-18T16:06:09.736Z",
        "usuarioInclusao": "string",
        "dtaHorInclusao": "2020-11-18T16:06:09.736Z",
        "pmtDecimal": "string",
		"pmtMultiplicacao": "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",
        "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": "2020-11-18T16:06:09.736Z",
            "usuarioInclusao": "string",
            "dtaHorAlteracao": "2020-11-18T16:06:09.736Z",
            "usuarioAlteracao": "string",
            "codOrigemTrib": "string",
            "idPauta": 0,
            "idPautaIcms": 0,
            "familia": {
              "expandables": [
                "string"
              ],
              "idFamilia": 0,
              "nomeFamilia": "string"
            },
            "divisao": {
              "expandables": [
                "string"
              ],
              "idDivisao": 0,
              "nomeDivisao": "string"
            }
          }
        ]
      },
      "produtoCodigo": [
        {
          "cgcFornecedor": 0,
          "tipoCodigo": "string",
          "idFamilia": 0,
          "qtdPorEmbalagem": 0,
          "idProduto": 0,
          "indUtilVenda": "string",
          "codigoAcesso": "string",
          "indPrefEdi": "string",
          "indEanTribNfe": "string",
          "usuarioAlteracao": "string"
        }
      ],
      "produtoImagem": [
        {
          "expandables": [
            "string"
          ],
          "idProdutoImagem": 0,
          "idProduto": 0,
          "descricao": "string",
          "urlEcommerceImg": "string",
          "indPrincipal": "string",
          "dispImagem": "string",
          "statusEcomm": "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
    }
  ]
}