Skip to main content
GET
Listar produtos

Authorizations

Authorization
string
header
required

Token gerado na Gestão de Tokens v2 do SULTS. Deve ser enviado no cabeçalho Authorization de todas as requisições.

Query Parameters

id
integer

Código do produto.

referenceCode
string

Código externo do produto (referência do sistema do cliente).

barcode
integer

Código de barras do produto.

active
boolean
default:true

true (padrão): produtos ativos. false: produtos inativos.

categoryId
integer

Código da categoria do produto.

supplierId
integer

Código do fornecedor do produto.

saleableAfter
string

Produtos publicados a partir desta data. Exemplo: 2027-05-29.

saleableBefore
string

Produtos publicados antes desta data. Exemplo: 2027-05-29.

page
integer
default:0

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

Required range: x >= 0

Response

Lista de produtos.

id
integer

Código do produto.

Example:

1

name
string

Nome do produto.

Example:

"Café Especial 500 g"

barcode
integer

Código de barras do produto.

Example:

7891234567890

referenceCode
string

Código do produto no sistema externo (código de referência do cliente).

Example:

"ERP-4471"

category
object

Categoria do produto.

supplier
object

Fornecedor do produto.

saleableDate
string

Data em que o produto fica disponível para compra. Formato yyyy-MM-dd.

Example:

"2026-07-01"

inventoryScope
enum<string>

Escopo do controle de estoque: define em que nível o saldo é mantido.

Available options:
ON_PRODUCT,
ON_VARIANT,
ON_PRODUCT_ASSORTMENT,
ON_PRODUCT_ASSORTMENT_VARIANT
Example:

"ON_PRODUCT"

active
boolean

true: produto ativo.

Example:

true

variation
object[] | null

Variações do produto e suas opções.

image
object[]

Imagens do produto.

shortDescription
string

Descrição curta do produto.

Example:

"Café torrado e moído, pacote de 500 g"

htmlDescription
string

Descrição completa em HTML.

Example:

"<p>Café torrado e moído, pacote de 500 g.</p>"