Sign in

v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB
Produtos

Produto específico

Retorna um Produto específico com base no parâmetro enviado na requisição.

get/v1/produtos/{codigoProduto}

Path parameters

codigoProdutointeger required

Código do Produto para retorno

Response

Dados do Produto retornados com sucesso.

dataAltercaostring

Data de alteração

codigoProdutointeger

Código do produto

nomestring

Nome do produto

complementostring

Complemento da descrição do produto

caracteristicasstring

Informações detalhadas dobre o produto

referenciastring

Referência do produto

codigoGrupoProdutointeger

Código do grupo de produto

nomeGrupoProdutostring

Nome do grupo de produto

volumestring

Unidade de medida (volume) padrão do produto

marcastring

Marca do produto

decimaisValorinteger

Número de casas decimais para valor

decimaisQuantidadeinteger

Número de casas decimais para quantidade

pesoBrutonumber float

Peso bruto do produto

agrupamentoMinimonumber float

Agrupamento mínimo de venda ou compra

quantidadeEmbalageminteger

Quantidade de embalagens

tipoControleEstoque1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Tipo de controle de estoque: 1 - Série 2 - Grade 3 - Livre 4 - Data de validade 5 - Sem controle adicional 6 - Parceiro 7 - Lista 8 - Lote

ativoboolean

Indica se o produto está ativo

estoqueMaximonumber float

Estoque máximo permitido

estoqueMinimonumber float

Estoque mínimo permitido

homepagestring

URL da homepage do produto

grupoDescontostring

Grupo de desconto do Produto

referenciaFornecedorstring

Referência do fornecedor

usadoComo1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14

Uso do produto: 1 - Subproduto 2 - Produto intermediário 3 - Demonstração 4 - Brinde 5 - Consumo 6 - Revenda (por fórmula) 7 - Embalagem 8 - Brinde (NF) 9 - Imobilizado 10 - Matéria-prima 11 - Outros insumos 12 - Em processo 13 - Revenda 14 - Terceiros 15 - Produdto Intermediário

cnaeinteger

Código CNAE do produto

metroCubiconumber float

Metros Cúbicos do produto

alturanumber float

Altura do produto

larguranumber float

Largura do produto

espessuranumber float

Espessura ou profundidade do produto

unidadeMedida'CM' | 'MM' | 'M'

Uso do produto: CM -centímetro MM - milímetro M - metro

utilizaBalancaboolean

Indica se o produto utiliza balança

codigoPaisinteger

Código do país de origem

ncmstring

Código NCM

ceststring

Código Especificador ST

Example response

{
  "dataAltercao": "01/09/2025 11:03:11",
  "codigoProduto": 123,
  "nome": "Produto exemplo",
  "complemento": "Produto modelo 2025",
  "caracteristicas": "Resistente à água",
  "referencia": "REF123456",
  "codigoGrupoProduto": 10,
  "nomeGrupoProduto": "Camisa Masculina",
  "volume": "UN",
  "marca": "MarcaGenérica",
  "decimaisValor": 2,
  "decimaisQuantidade": 3,
  "pesoBruto": 1.25,
  "agrupamentoMinimo": 0.5,
  "quantidadeEmbalagem": 12,
  "tipoControleEstoque": 2,
  "ativo": true,
  "estoqueMaximo": 500,
  "estoqueMinimo": 10,
  "homepage": "https://exemplo.com/produto",
  "grupoDesconto": "DESC10",
  "referenciaFornecedor": "FORN001",
  "usadoComo": 2,
  "cnae": 1234567,
  "metroCubico": 3.45,
  "altura": 10.5,
  "largura": 15,
  "espessura": 2,
  "unidadeMedida": "MM",
  "codigoPais": 55,
  "ncm": "267328",
  "cest": "0100100"
}