Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

A finalidade deste método é possibilitar a consulta a dados cadastrais básicos de produtos.

Chamada

GET [URLAPI]/SMProdutosAPI/api/v4/produtos/dados-cadastrais

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
modelo.codigoAcessoCódigos de acessos associados ao produto (GTIN, Interno, Fornecedor)String

Quando não informado o IdFornecedor, a busca irá se basear apenas nos tipos de códigos de acesso: EAN, DUN e Interno (E, D e B).

modelo.descricaoDescrição do produtoStringNão há
modelo.familiaDescrição da família do produtoStringNão há
modelo.dataAtualizacaoData da ultima atualização Formato: YYYY-MM-DDThh:mm:ssStringQuando informada a dataAtualizacao serão filtrados os registros que tiveram alteração a partir desta data.
modelo.idFamiliaCódigo sequencial do cadastro de família do produtoIntegerNão há
modelo.idProdutoCódigo sequencial do cadastro do produtoIntegerNão há
modelo.idFornecedorCódigo sequencial do cadastro de fornecedorIntegerQuando informado IdFornecedor, a busca também irá considerar o código de acesso do tipo Fornecedor (F).
modelo.statusVendaStatus da VendaStringNão há
modelo._pageNo
IntegerNão há
modelo._pageSize
IntegerNão há

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

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

String

Não há
DescricaoCompletaDescrição CompletaStringNão há
DescricaoGenericaDescrição GenéricaStringNão há
DescricaoReduzidaDescrição ReduzidaStringNão há
DescricaoComposicaoDescrição da composição do produto (Produto com fabricação própria)StringNão há
DetalhesProdutoEspecificação detalhadaStringNão há
ReferenciaFabricanteReferência do fabricanteStringNão há
DescricaoFamiliaDescrição da familia do produtoStringNão há
ValidadeDiasNro. de dias de validadeIntegerNão há
ValidadeMesNro. de meses de validadeIntegerNão há
NroDiasValidadeDeRecebtoNro de dias de validade a partir do recebimentoIntegerNão há
ProcessoFabricacaoProcesso de fabricação: P – Produto final de receita. S – Sem Processo de Produção B – Produto base para desmembramento F – Produto final composto V – Produto de composição variavel I – Insumo para Produção C – Composto para Separação M – Movimentação Automática(MA)StringNão há
PermiteDecimalIndica se permite quantidade em decimal S – Sim N – NãoStringNão há
PesavelIndica se o produto é pesável S – Sim N – NãoStringNão há
UrlEcommerceURL do produto no e-commerce da rede.StringNão há
IntegraEcommerceIndica se integra com o E-Commerce. S – Sim N – NãoStringNão há
MultiploVendaEcommerceMultiplo de venda do E-CommerceIntegerNão há
IdFornecedorPrincCódigo do fornecedor principalIntegerNão há
IdMarcaCódigo da marcaIntegerNão há
DescricaoMarcaDescrição da marcaStringNão há
StatusVendaStatus de Venda do ProdutoStringNão há
PrincipiosAtivosLista de princípios ativosArray of objects (PrincipioAtivoRespostaDTO)Não há
CodigoAcessoPrincipalCódigo de acesso principalStringNão há
IdProdutoCódigo sequencial do cadastro do produtoIntegerNão há
IdFamiliaCódigo sequencial do cadastro da família do produtoIntegerNão há
IdProdutoBaseCódigo sequencial do cadastro do produto baseIntegerNão há
DataUltimaAtualizacaoData da ultima atualizaçãoStringNão há
RetornoCustumizadosColuna especial para customizaçõesDynamicPossui valor apenas em clientes com customização da API de Produtos

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

{
  "DtaInclusao": "2021-05-17T12:02:51.889Z",
  "DescricaoCompleta": "string",
  "DescricaoGenerica": "string",
  "DescricaoReduzida": "string",
  "DescricaoComposicao": "string",
  "DetalhesProduto": "string",
  "ReferenciaFabricante": "string",
  "DescricaoFamilia": "string",
  "ValidadeDias": 0,
  "ValidadeMes": 0,
  "NroDiasValidadeDeRecebto": 0,
  "ProcessoFabricacao": "string",
  "PermiteDecimal": "string",
  "Pesavel": "string",
  "UrlEcommerce": "string",
  "IntegraEcommerce": "string",
  "MultiploVendaEcommerce": 0,
  "IdFornecedorPrinc": 0,
  "IdMarca": 0,
  "DescricaoMarca": "string",
  "StatusVenda": "string",
  "PrincipiosAtivos": [
    {
      "IdPrincipioAtivo": 0,
      "DescPrincipioAtivo": "string"
    }
  ],
  "RetornoCustumizados": {},
  "CodigoAcessoPrincipal": "string",
  "IdProduto": 0,
  "IdFamilia": 0,
  "IdProdutoBase": 0,
  "DataUltimaAtualizacao": "2021-05-17T12:02:51.889Z"
}