Endpoint que permite a listagem dos produtos criados na plataforma da SULTS.
URL: https://api.sults.com.br/api/v2/compras/product/list
Método: GET
Parâmetros
Headers
| Header | Valor |
|---|---|
| Authorization | <token_de_acesso> |
| Content-Type | application/json;charset=UTF-8 |
Query parameters
| Filtro | Valor | Descrição |
|---|---|---|
| id | Integer | Código do produto |
| referenceCode | String | Código externo do produto Faz referência do código do produto cadastrado em um sistema externo ao SULTS. |
| barcode | Integer | Código de barras do produto |
| active | Boolean | 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 de: Exemplo: 2027-05-29 |
| saleableBefore | String | Produtos publicados anterior a: Exemplo: 2027-05-29 |
| page | Integer | Índice da paginação da listagem. Inicia-se em 0 |
Exemplo
fetch("https://api.sults.com.br/api/v2/compras/product/list?active=true&categoryId=2&page=0", {
method: "GET",
headers: {
"Authorization": "<token_de_acesso>",
"Content-Type":"application/json;charset=UTF-8"
}
})Resposta
[
{
"id": 1,
"name": "Produto 1",
"barcode": 1223334,
"referenceCode": "1a2b3c4d",
"category": {
"id": 1,
"name": "Produtos especiais"
},
"supplier": {
"id": 5,
"name": "Fornecedor 1",
"legalName": "Fornecedor 1",
"active": true
},
"saleableDate": "2027-01-01",
"inventoryScope": "ON_PRODUCT",
"active": true,
"variation": [
{
"id": 8,
"name": "Sabor",
"active": true,
"index": 0,
"option": [
{
"id": 18,
"name": "Uva",
"active": true,
"index": 0
},
{
"id": 19,
"name": "Morango",
"active": true,
"index": 1
}
]
}
],
"image": [
{
"id": 1,
"name": "produto1.png",
"url": "https://link/produto1.png",
"fileLength": 615324
}
],
"shortDescription": "Produto especial 1",
"htmlDescription": "<b>Produto especial 1</b>"
}
]