Endpoint que permite a listagem dos pedidos criados na plataforma da SULTS.
URL: https://api.sults.com.br/api/v2/compras/order/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 pedido |
| companyId | Integer | Código da empresa |
| supplierId | Integer | Código do fornecedor do produto |
| stageId | Integer | Código da etapa |
| status | String | Situação do pedido Valores aceitos (‘OPEN‘, ‘CONCLUDED‘) |
| page | Integer | Define a página da listagem que será retornada |
| canceled | Boolean | true – pedidos cancelados false – (Padrão) pedidos não cancelados |
Exemplo
fetch("https://api.sults.com.br/api/v2/compras/order/list?companyId=10&supplierId=5&page=0", {
method: "GET",
headers: {
"Authorization": "<token_de_acesso>",
"Content-Type":"application/json;charset=UTF-8"
}
})Resposta
[
{
"id": 1,
"amount": "302.00",
"minAmount": "100.00",
"productSubtotal": "47.90",
"productDiscount": "2.00",
"note": "",
"message": "",
"stage": {
"id": 3,
"name": "Enviado",
"color": "#00cdac",
"index": 4
},
"createdAt": "2026-05-20T02:37:52Z",
"concludedAt": null,
"company": {
"id": 10,
"name": "REDE",
"legalName": "Modelo",
"cnpj": "99999999999999",
"active": true
},
"supplier": {
"id": 5,
"name": "Fornecedor GX",
"legalName": "Fornecedor GX",
"active": true
},
"paymentMethod": {
"id": 3,
"name": "A Combinar"
},
"shippingMethod": {
"id": 1,
"name": "A Combinar"
},
"createdByUser": {
"id": 53,
"name": "Pessoa G"
},
"shippingAddress": {
"postalCode": "99999999",
"street": "Rua H1",
"neighborhood": "Barra da Tijuca",
"number": "0",
"complement": "",
"city": "Rio de Janeiro",
"state": "RJ"
},
"status": "OPEN",
"canceled": false
}
]