Endpoint: Buscando produtos

Endpoint que permite a listagem dos produtos criados na plataforma da SULTS.

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

Método: GET

Observação

A busca da lista de produtos é paginada. O endpoint é limitado a 100 registros por página.

Parâmetros

Headers

Header	Valor
Authorization	<token_de_acesso>
Content-Type	application/json;charset=UTF-8

Query parameters

Filtro	Valor	Descrição
start	Integer	Início da paginação (número da página). Padrão 0
limit	Integer	Número de registros por página. Máximo 100. Padrão 100
id	Integer	Código do produto
ativo	Boolean	Produtos ativos (Por padrão é true) true – somente os produtos ativos false – somente os produtos inativos
publicadoStart	String	Data 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
publicadoEnd	String	Data de publicação do produto Busca os produtos publicados anterior a data informada. Essa data deve ser uma string UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
codigoExterno	String	Código externo do produto Faz referência do código do produto cadastrado em um sistema externo ao SULTS.
codigoBarras	Integer	Código de barras do produto
categoriaId	Integer	Código da categoria do produto
fornecedorId	Integer	Código do fornecedor do produto

Exemplo

fetch("https://api.sults.com.br/api/v1/comercial/produto", {
	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"
						}
					]
				}
			]
		}
	],
	"start": 0,
	"limit": 100,
	"size": 1,
	"totalPage": 1
}

Campos de resposta

Campos principais

Nome Atributo	Tipo	Descrição
id	Integer	Código do produto
codigoBarras	Integer	Código de barras do produto
codigoExterno	String	Código externo do produto
nome	String	Nome do produto
ativo	Boolean	Produto ativo: true – ativo false – inativo
publicado	String	Data 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
descricaoCurta	String	Descrição curta do produto
descricaoHtml	String	Descrição completa do produto em formato HTML
categoria	String	Categoria do produto
produtoFornecedor	Objeto Produto Fornecedor	Fornecedor do produto e informações da venda. Os campos relacionados a esse objeto estão listados em uma tabela abaixo.
imagem	Lista Objeto Imagem	Endereço do comprador. Os campos relacionados a esse objeto estão listados em uma tabela abaixo.
variacaoProduto	Lista Objeto variacaoProduto	Fornecedor do pedido. Os campos relacionados a esse objeto estão listados em uma tabela abaixo.

Campos do Objeto Produto Fornecedor

Nome Atributo	Tipo	Descrição
fornecedor	Objeto Fornecedor – id – nomeFantasia	Fornecedor do produto
condicaoVenda	Objeto Condicao Venda	Condiçã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 Atributo	Tipo	Descrição
preco	Decimal	Preço do produto
estoque	Integer	Quantidade de itens do produto no estoque
estoqueReposicao	String	Data em que o produto será reposto no estoque. A data é apresentada no formato UTC ISO 8601.
pedidoValorMinimo	String	Valor mínimo do pedido do produto
pedidoQtdMinimo	Integer	Número mínimo de itens do produto em um pedido
pedidoQtdMaximo	Integer	Número máximo de itens do produto em um pedido
pedidoQtdMultiplo	Integer	Se 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
pedidoQtdMaximoFim	String	Data 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 Atributo	Tipo	Descrição
id	Integer	Id da imagem
nome	String	Nome da imagem
uro	String	Url da imagem
tamanho	Long	Tamanho da imagem

Campos do Objeto Variacao

Nome Atributo	Tipo	Descrição
id	Integer	Código da variação
nome	String	Nome da variação
opcao	Objeto Opcao: – id – nome	Opção a qual a variação foi selecionada no pedido.