Skip to main content
GET
Listar produtos

Authorizations

Authorization
string
header
required

Token gerado através do sistema do SULTS. Deve ser enviado no cabeçalho Authorization de todas as requisições.

Query Parameters

start
integer
default:0

Número da página da listagem, começando em 0. Incremente até a resposta vir vazia ou até atingir totalPage.

Required range: x >= 0
limit
integer
default:100

Quantidade de registros por página. O máximo aceito pela API é 100.

Required range: 1 <= x <= 100
id
integer

Código do produto

ativo
boolean

Filtra os produtos pelo campo ativo. Por padrão busca ativos e inativos. true: somente ativos; false: somente inativos.

publicadoStart
string<date-time>

Busca os produtos publicados a partir da data informada (UTC ISO 8601).

publicadoEnd
string<date-time>

Busca os produtos publicados antes da data informada (UTC ISO 8601).

codigoExterno
string

Código externo do produto. Faz referência ao 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

Response

Lista paginada de produtos

data
object[]
start
integer

Página retornada

limit
integer

Registros por página

totalPage
integer

Quantidade de páginas disponíveis

size
integer

Quantidade de registros na página