Listar pedidos na API v2 do SULTS

GET

api

compras

order

list

Listar pedidos

curl --request GET \
  --url https://api.sults.com.br/api/v2/compras/order/list \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sults.com.br/api/v2/compras/order/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sults.com.br/api/v2/compras/order/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

using RestSharp;


var options = new RestClientOptions("https://api.sults.com.br/api/v2/compras/order/list");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

[
  {
    "id": 1,
    "amount": 16,
    "minAmount": 0,
    "productSubtotal": 47.9,
    "productDiscount": 2,
    "note": "",
    "message": "",
    "stage": {
      "id": 3,
      "name": "Enviado",
      "color": "#00cdac",
      "index": 4
    },
    "createdAt": "2026-05-20T02:37:52Z",
    "concludedAt": null,
    "company": {
      "id": 10,
      "name": "Aurora Cafés Centro",
      "legalName": "Aurora Cafés Ltda",
      "cnpj": "99999999999999",
      "active": true
    },
    "supplier": {
      "id": 5,
      "name": "Aurora Distribuidora",
      "legalName": "Aurora Distribuidora Ltda"
    },
    "paymentMethod": {
      "id": 3,
      "name": "A Combinar"
    },
    "shippingMethod": {
      "id": 1,
      "name": "A Combinar"
    },
    "createdByUser": {
      "id": 53,
      "name": "Ana Aurora"
    },
    "shippingAddress": {
      "postalCode": "99999999",
      "street": "Rua H1",
      "neighborhood": "Barra da Tijuca",
      "number": "0",
      "complement": "",
      "city": "Rio de Janeiro",
      "state": "RJ"
    },
    "status": "OPEN",
    "canceled": false
  }
]

{
  "error": "Campo supplierId não pode ser vazio ou nulo."
}

{
  "error": "Acesso não autorizado."
}

{
  "error": "Campo supplierId não pode ser vazio ou nulo."
}

<string>

{
  "error": "Campo supplierId não pode ser vazio ou nulo."
}

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

integer

Código do pedido.

companyId

integer

Código da empresa (unidade).

supplierId

integer

Código do fornecedor.

stageId

integer

Código da etapa.

status

enum<string>

Situação do pedido.

Valor	Significado
`OPEN`	Aberto
`CONCLUDED`	Concluído

Para listar os cancelados, use o filtro canceled.

Available options:

OPEN,

CONCLUDED

canceled

boolean

default:false

Filtro de cancelamento. true lista só os pedidos cancelados; false (padrão) lista só os não cancelados.

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 pedidos.

integer

Código do pedido.

Example:

1

amount

number

Valor total do pedido.

Example:

1

minAmount

number

Valor mínimo exigido para o pedido.

Example:

1

productSubtotal

number

Subtotal dos produtos do pedido, antes do desconto.

Example:

47.9

productDiscount

number

Desconto aplicado sobre os produtos do pedido.

Example:

2

note

string

Anotação do pedido.

Example:

"Conferir a validade dos itens refrigerados"

message

string

Mensagem do pedido.

Example:

"Pedido semanal da unidade Barra"

stage

object

Etapa atual do pedido no fluxo.

Show child attributes

createdAt

string

Data de criação. Formato UTC ISO 8601.

Example:

"2026-05-20T02:37:52Z"

concludedAt

string | null

Data de conclusão, quando concluído.

Example:

"2026-05-22T14:10:00Z"

company

object

Empresa (unidade) que fez o pedido.

Show child attributes

supplier

object

Fornecedor do pedido.

Show child attributes

paymentMethod

object

Método de pagamento.

Show child attributes

shippingMethod

object

Método de entrega.

Show child attributes

createdByUser

object

Usuário que criou o pedido.

Show child attributes

shippingAddress

object

Endereço de entrega.

Show child attributes

status

enum<string>

Situação do pedido.

Valor	Significado
`OPEN`	Aberto
`CONCLUDED`	Concluído
`CANCELED`	Cancelado

Available options:

OPEN,

CONCLUDED,

CANCELED

Example:

"OPEN"

canceled

boolean

Indica se o pedido foi cancelado.

Example:

false

Listar pedidos

curl --request GET \
  --url https://api.sults.com.br/api/v2/compras/order/list \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sults.com.br/api/v2/compras/order/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sults.com.br/api/v2/compras/order/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

using RestSharp;


var options = new RestClientOptions("https://api.sults.com.br/api/v2/compras/order/list");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

[
  {
    "id": 1,
    "amount": 16,
    "minAmount": 0,
    "productSubtotal": 47.9,
    "productDiscount": 2,
    "note": "",
    "message": "",
    "stage": {
      "id": 3,
      "name": "Enviado",
      "color": "#00cdac",
      "index": 4
    },
    "createdAt": "2026-05-20T02:37:52Z",
    "concludedAt": null,
    "company": {
      "id": 10,
      "name": "Aurora Cafés Centro",
      "legalName": "Aurora Cafés Ltda",
      "cnpj": "99999999999999",
      "active": true
    },
    "supplier": {
      "id": 5,
      "name": "Aurora Distribuidora",
      "legalName": "Aurora Distribuidora Ltda"
    },
    "paymentMethod": {
      "id": 3,
      "name": "A Combinar"
    },
    "shippingMethod": {
      "id": 1,
      "name": "A Combinar"
    },
    "createdByUser": {
      "id": 53,
      "name": "Ana Aurora"
    },
    "shippingAddress": {
      "postalCode": "99999999",
      "street": "Rua H1",
      "neighborhood": "Barra da Tijuca",
      "number": "0",
      "complement": "",
      "city": "Rio de Janeiro",
      "state": "RJ"
    },
    "status": "OPEN",
    "canceled": false
  }
]

{
  "error": "Campo supplierId não pode ser vazio ou nulo."
}

{
  "error": "Acesso não autorizado."
}

{
  "error": "Campo supplierId não pode ser vazio ou nulo."
}

<string>

{
  "error": "Campo supplierId não pode ser vazio ou nulo."
}