> ## Documentation Index > Fetch the complete documentation index at: https://developers.sults.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Listar pedidos na API v1 do SULTS > Busca os pedidos cadastrados na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/comercial/pedido openapi: 3.1.0 info: title: API SULTS version: v1 description: >- API REST do SULTS. Todas as chamadas devem ser autenticadas por um token enviado, puro e sem o prefixo `Bearer`, no cabeçalho HTTP `Authorization`. As datas seguem o formato UTC ISO 8601 (`yyyy-MM-ddTHH:mm:ssZ`) e campos com máscara (CNPJ, telefone, CEP etc.) são retornados sem máscara. Endpoints de listagem paginados aceitam os parâmetros `start` e `limit`. contact: name: Suporte SULTS url: https://ajuda.sults.com.br servers: - url: https://api.sults.com.br description: Produção security: - apiKeyAuth: [] tags: - name: Unidades description: >- Unidades da rede e colaboradores ativos cadastrados no SULTS. Somente leitura: a API não grava unidades nem colaboradores. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: Chamados description: >- Chamados abertos na plataforma e a timeline de cada um, com os endpoints de criação e conclusão. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: Checklist description: >- Avaliações de checklist aplicadas nas unidades, com respostas, check-ins, check-outs e planos de ação. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: Compras description: >- Pedidos de compra e catálogo de produtos da v1, incluindo o cadastro e a edição de produto e a edição de pedido. A v1 de Compras não recebe novas funcionalidades: mix de produtos, etapas de pedido e as próximas novidades do módulo estão só na API v2, que é a indicada para integrações novas de Compras. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: implantacao description: >- Projetos de implantação de novas unidades e as tarefas de cada projeto. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. x-group: Implantação - name: Projetos description: >- Projetos da operação e as tarefas vinculadas a eles. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: expansao description: >- Negócios do funil de Expansão e a timeline de cada um, com o endpoint de criação de negócio. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. x-group: Expansão paths: /api/v1/comercial/pedido: get: tags: - Compras summary: Listar pedidos description: >- Busca os pedidos cadastrados na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página. operationId: listarPedidos parameters: - $ref: '#/components/parameters/Start' - $ref: '#/components/parameters/Limit' - name: id in: query required: false description: Código do pedido schema: type: integer example: 1 - name: situacao in: query required: false description: |- Situação do pedido. | Valor | Significado | | ----- | ----------- | | 2 | Aguardando | | 3 | Faturado | | 4 | Enviado | | 5 | Entregue | schema: type: integer enum: - 2 - 3 - 4 - 5 example: 4 - name: unidadeId in: query required: false description: Código da unidade do pedido schema: type: integer example: 12 - name: fornecedorId in: query required: false description: Código do fornecedor do pedido schema: type: integer example: 5 - name: compradorId in: query required: false description: Código da pessoa que efetuou o pedido schema: type: integer example: 8 - name: dtPedidoStart in: query required: false description: >- Busca os pedidos realizados a partir da data informada (UTC ISO 8601). schema: type: string format: date-time example: '2026-07-01T00:00:00Z' - name: dtPedidoEnd in: query required: false description: Busca os pedidos realizados antes da data informada (UTC ISO 8601). schema: type: string format: date-time example: '2026-07-31T23:59:59Z' - name: cancelado in: query required: false description: >- Pedidos cancelados (por padrão `false`). `true`: somente cancelados; `false`: somente ativos. schema: type: boolean default: false example: false - name: canceladoEmStart in: query required: false description: >- Busca os pedidos cancelados a partir da data informada (UTC ISO 8601). Necessita do parâmetro `cancelado` igual a `true`. schema: type: string format: date-time example: '2026-07-01T00:00:00Z' - name: canceladoEmEnd in: query required: false description: >- Busca os pedidos cancelados antes da data informada (UTC ISO 8601). Necessita do parâmetro `cancelado` igual a `true`. schema: type: string format: date-time example: '2026-07-31T23:59:59Z' responses: '200': description: Lista paginada de pedidos content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Pedido' start: type: integer description: Página retornada limit: type: integer description: Registros por página totalPage: type: integer description: Quantidade de páginas disponíveis size: type: integer description: Quantidade de registros na página '400': $ref: '#/components/responses/ErroValidacao' '401': $ref: '#/components/responses/TokenInvalido' '404': $ref: '#/components/responses/NaoEncontrado' '429': $ref: '#/components/responses/LimiteDeRequisicoes' 5XX: $ref: '#/components/responses/ErroDoServidor' components: parameters: Start: name: start in: query description: >- Número da página da listagem, começando em `0`. Incremente até a resposta vir vazia ou até atingir `totalPage`. schema: type: integer minimum: 0 default: 0 example: 0 Limit: name: limit in: query description: Quantidade de registros por página. O máximo aceito pela API é `100`. schema: type: integer minimum: 1 maximum: 100 default: 100 example: 100 schemas: Pedido: type: object properties: id: type: integer description: Código do pedido example: 1 criado: type: string format: date-time description: Data de realização do pedido (UTC ISO 8601) example: '2026-09-22T14:18:37Z' valor: type: number description: Valor total do pedido example: 24.9 valorMin: type: number description: Valor mínimo do pedido example: 24.9 situacaoId: type: integer enum: - 2 - 3 - 4 - 5 description: |- Situação do pedido. | Valor | Significado | |-------|-------------| | 2 | Aguardando | | 3 | Faturado | | 4 | Enviado | | 5 | Entregue | example: 2 unidade: type: object description: Unidade do comprador do pedido properties: id: type: integer description: Código da unidade do comprador example: 1 nome: type: string description: Nome fantasia da unidade do comprador example: Sabor Mineiro Savassi razaoSocial: type: string description: Razão social da unidade do comprador example: SULTS Tecnologia LTDA cnpj: type: string description: CNPJ da unidade do comprador example: '12345678000190' comprador: type: object description: Pessoa que efetuou o pedido properties: id: type: integer description: Código da pessoa example: 1 nome: type: string description: Nome da pessoa example: Rafael Souza celular: type: string description: Celular da pessoa example: '34988776655' email: type: string description: E-mail da pessoa example: operacoes@sabormineiro.com.br compradorObservacao: type: string description: Observação do comprador em relação ao pedido example: Entregar até as 10h, antes da abertura da loja endereco: type: object description: Endereço do comprador properties: cep: type: string description: CEP do endereço do comprador example: '38026000' rua: type: string description: Rua do endereço do comprador example: Avenida Leopoldino de Oliveira numero: type: string description: Número do endereço do comprador example: '3200' bairro: type: string description: Bairro do endereço do comprador example: Centro complemento: type: string description: Complemento do endereço do comprador example: Sala 12 cidade: type: string description: Cidade do endereço do comprador example: Uberaba uf: type: string description: UF do endereço do comprador example: MG meioPagamento: type: object description: Meio de pagamento do pedido properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Boleto 28 dias meioEntrega: type: object description: Meio de entrega do pedido properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Transportadora fornecedor: type: object description: Fornecedor do pedido properties: id: type: integer description: Código do fornecedor do pedido example: 1 nome: type: string description: Nome fantasia do fornecedor do pedido example: Laticínios Serra Azul razaoSocial: type: string description: Razão social do fornecedor do pedido example: SULTS Tecnologia LTDA cnpj: type: string description: CNPJ do fornecedor do pedido example: '12345678000190' telefone: type: array items: type: string example: '3432125000' description: Telefones do fornecedor observacao: type: string description: Observação do fornecedor em relação ao pedido example: Pedido faturado com a nota fiscal 4512 mensagem: type: string description: Mensagem destinada ao comprador example: Chamado aberto pela unidade. cancelado: type: boolean description: '`true`: cancelado. `false`: ativo.' example: true canceladoMotivo: type: string description: Motivo do cancelamento do pedido example: Pedido duplicado pela unidade canceladoEm: type: string format: date-time description: Data de cancelamento do pedido (UTC ISO 8601) example: '2026-09-22T16:02:11Z' canceladoPor: type: object description: Pessoa que cancelou o pedido properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Patrícia Lima Erro: type: object description: >- Corpo padrão de erro da API. Não existe código de erro interno: decida a sua lógica pelo status HTTP e use a mensagem apenas para logs e diagnóstico. required: - error properties: error: type: string description: >- Mensagem legível, em português, descrevendo a falha. O texto pode mudar: nunca o use como condição de código. example: Campo responsavel não pode ser vazio ou nulo. responses: ErroValidacao: description: >- Erro de validação ou formato errado nos dados de entrada. A API aponta **um campo por vez**: corrija o campo indicado na mensagem, reenvie e repita até o 200. content: application/json: schema: $ref: '#/components/schemas/Erro' example: error: Campo responsavel não pode ser vazio ou nulo. TokenInvalido: description: >- Token ausente ou inválido. Confira: copiado por completo, cabeçalho `Authorization` com o nome exato, valor sem o prefixo `Bearer` e gerado na **Gestão de Tokens v1** (tokens v2 não funcionam nesta API). Sem retry automático. O corpo real é `{"error": "Acesso não autorizado."}`. content: application/json: schema: $ref: '#/components/schemas/Erro' example: error: Acesso não autorizado. NaoEncontrado: description: >- Recurso ou entidade inexistente (por exemplo, um `{id}` do caminho que não existe ou foi excluído no SULTS). Reenviar sem corrigir devolve o mesmo erro. content: application/json: schema: $ref: '#/components/schemas/Erro' LimiteDeRequisicoes: description: >- Limite de requisições excedido: **2 requisições por segundo, por IP**. A resposta é a página HTML padrão do servidor, não JSON, e não há o header `Retry-After`: trate pelo status 429, sem fazer parse do corpo, com espera crescente a partir de 1 segundo. content: text/html: schema: type: string description: >- Página HTML padrão do servidor. Não faça parse; decida pelo status. ErroDoServidor: description: >- Falha inesperada do servidor (raro). Repita com espera crescente; persistindo, acione o suporte com data, hora e endpoint. content: application/json: schema: $ref: '#/components/schemas/Erro' securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: >- Token gerado através do sistema do SULTS. Deve ser enviado no cabeçalho `Authorization` de todas as requisições. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.