1. Home
  2. Compras
  3. Endpoint: Buscando produto pelo id

Endpoint: Buscando produto pelo id

Endpoint que permite a busca de um produto criado na plataforma da SULTS.

URL: https://api.sults.com.br/api/v1/comercial/produto/{produtoId}

Método: GET

Parâmetros

Headers

HeaderValor
Authorization<token_de_acesso>
Content-Typeapplication/json;charset=UTF-8

Path parameters

ParâmetroValor
produtoIdId do produto, deve ser passado na URL como parâmetro de path

Exemplo

fetch("https://api.sults.com.br/api/v1/comercial/produto/{produtoId}", {
	method: "GET",
	headers: {
		"Authorization": "<token_de_acesso>",
                "Content-Type":"application/json;charset=UTF-8"
	}
})

Resposta

{
	"data": {
		"id": 1,
		"codigoBarras": 99995662,
		"codigoExterno": "2001",
		"nome": "Chinelo Renners",
		"ativo": true,
		"publicado": "2024-02-20T03:00:00Z",
		"descricaoCurta": "Descricao Chinelo Renners",
		"descricaoHtml": "<b>Descricao</b> HTML Chinelo Renners",
		"categoria": 1,
		"produtoFornecedor": {
			"fornecedor": {
				"id": 1,
				"nomeFantasia": "Fornecedor Renners"
			},
			"condicaoVenda": {
				"preco": 50.50,
				"estoque": 94,
				"estoqueReposicao": "2024-02-20T03:00:00Z",
				"pedidoValorMinimo": 10.00,
				"pedidoQtdMinimo": 10,
				"pedidoQtdMaximo": 50,
				"pedidoQtdMultiplo": 2,
				"pedidoQtdMaximoFim": "2024-02-20T03:00:00Z"
			}
		},
		"imagem": [
			{
				"id": 21,
				"nome": "arquivo.png",
				"url": "https://link/arquivo.png",
				"tamanho": 7633
			}
		],
		"variacaoProduto": [
			{
				"id": 1,
				"nome": "Tamanho",
				"opcao": [
					{
						"id": 1,
						"nome": "39"
					},
					{
						"id": 2,
						"nome": "40"
					}
				]
			},
			{
				"id": 2,
				"nome": "Cor",
				"opcao": [
					{
						"id": 4,
						"nome": "Preto"
					},
					{
						"id": 5,
						"nome": "Branco"
					},
					{
						"id": 6,
						"nome": "Azul"
					}
				]
			}
		]
	}
}

Campos de resposta

Campos principais

Nome AtributoTipoDescrição
idIntegerCódigo do produto
codigoBarrasIntegerCódigo de barras do produto
codigoExternoStringCódigo externo do produto
nomeStringNome do produto
ativoBooleanProduto ativo:
true – ativo
false – inativo
publicadoStringData de publicação do produto

Busca os produtos publicados a partir da data informada. Essa data deve ser uma string UTC ISO 8601.

Exemplo: 2022-06-27T14:02:55Z
descricaoCurtaStringDescrição curta do produto
descricaoHtmlStringDescrição completa do produto em formato HTML
categoriaStringCategoria do produto
produtoFornecedorObjeto Produto FornecedorFornecedor do produto e informações da venda.

Os campos relacionados a esse objeto estão listados em uma tabela abaixo.
imagemLista Objeto ImagemEndereço do comprador.

Os campos relacionados a esse objeto estão listados em uma tabela abaixo.
variacaoProdutoLista Objeto variacaoProdutoFornecedor do pedido.

Os campos relacionados a esse objeto estão listados em uma tabela abaixo.

Campos do Objeto Produto Fornecedor

Nome AtributoTipoDescrição
fornecedorObjeto Fornecedor

– id
– nomeFantasia
Fornecedor do produto
condicaoVendaObjeto Condicao VendaCondição referente a venda do produto

Os campos relacionados a esse objeto estão listados em uma tabela abaixo.

Campos do Objeto Condicao Venda

Nome AtributoTipoDescrição
precoDecimalPreço do produto
estoqueIntegerQuantidade de itens do produto no estoque
estoqueReposicaoStringData em que o produto será reposto no estoque. A data é apresentada no formato UTC ISO 8601.
pedidoValorMinimoStringValor mínimo do pedido do produto
pedidoQtdMinimoIntegerNúmero mínimo de itens do produto em um pedido
pedidoQtdMaximoIntegerNúmero máximo de itens do produto em um pedido
pedidoQtdMultiploIntegerSe não for vazio, é a quantidade em múltiplo de itens do produto que pode ser adicionado no pedido respeitando o campos pedidoQtdMaximo e pedidoQtdMinimo
pedidoQtdMaximoFimStringData limite relacionada a quantidade máxima de itens do produto que pode ser adiquirido até esse período

A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z

Campos do Objeto Imagem

Nome AtributoTipoDescrição
idIntegerId da imagem
nomeStringNome da imagem
uroStringUrl da imagem
tamanhoLongTamanho da imagem

Campos do Objeto Variacao

Nome AtributoTipoDescrição
idIntegerCódigo da variação
nomeStringNome da variação
opcaoObjeto Opcao:

– id
– nome
Opção a qual a variação foi selecionada no pedido.
Atualizado em 26/02/2024