> ## 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 v2 do SULTS > Lista os pedidos da plataforma, com etapa atual, empresa, fornecedor, métodos de pagamento e entrega, e endereço de entrega. ## OpenAPI ````yaml /api-reference/openapi-v2.json get /api/v2/compras/order/list openapi: 3.1.0 info: title: API do SULTS v2 version: '2.0' description: >- A nova geração da API do SULTS, em migração módulo a módulo (Compras primeiro). Autenticação por token v2 no cabeçalho `Authorization`; tokens v1 não funcionam aqui. Nas requisições com corpo, envie `Content-Type: application/json;charset=UTF-8`. contact: name: Suporte SULTS url: https://ajuda.sults.com.br servers: - url: https://api.sults.com.br security: - apiKeyAuth: [] tags: - name: Produtos description: >- Cadastro, preço, estoque, variações e variantes de produto no módulo de Compras da v2. 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 v2. O limite é de 2 requisições por segundo, por IP. - name: Mix de produtos description: >- Sortimento de produtos por empresa. Disponível apenas quando o recurso de mix está habilitado na plataforma, em Comercial > Configuração > Mix de produto. 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 v2. O limite é de 2 requisições por segundo, por IP. - name: Pedidos e etapas description: >- Pedidos de compra da v2 e o fluxo de etapas, que é configurável por operaçã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 v2. O limite é de 2 requisições por segundo, por IP. - name: Comunicados description: >- Comunicados publicados na plataforma, com o público de cada um, a confirmação de leitura e o conteúdo publicado. 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 v2. O limite é de 2 requisições por segundo, por IP. - name: Chamados description: >- Chamados da plataforma: abertura, timeline, interações, apoios, etiquetas, prazo 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 v2. O limite é de 2 requisições por segundo, por IP. - name: Checklist description: >- Avaliações de checklist com respostas, check-in e check-out, os modelos com seções e questões, e os planos de ação com a timeline. 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 v2. O limite é de 2 requisições por segundo, por IP. paths: /api/v2/compras/order/list: get: tags: - Pedidos e etapas summary: Listar pedidos description: >- Lista os pedidos da plataforma, com etapa atual, empresa, fornecedor, métodos de pagamento e entrega, e endereço de entrega. operationId: listarPedidosV2 parameters: - name: id in: query schema: type: integer description: Código do pedido. example: 1 - name: companyId in: query schema: type: integer description: Código da empresa (unidade). example: 12 - name: supplierId in: query schema: type: integer description: Código do fornecedor. example: 5 - name: stageId in: query schema: type: integer description: Código da etapa. example: 2 - name: status in: query schema: type: string enum: - OPEN - CONCLUDED description: |- Situação do pedido. | Valor | Significado | | ----- | ----------- | | `OPEN` | Aberto | | `CONCLUDED` | Concluído | Para listar os cancelados, use o filtro `canceled`. example: OPEN - name: canceled in: query schema: type: boolean default: false description: >- Filtro de cancelamento. `true` lista só os pedidos cancelados; `false` (padrão) lista só os não cancelados. example: false - $ref: '#/components/parameters/Page' responses: '200': description: Lista de pedidos. content: application/json: schema: type: array items: $ref: '#/components/schemas/PedidoV2' example: - 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 '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: Page: name: page in: query description: >- Número da página da listagem, começando em `0`. Incremente até a resposta vir vazia. schema: type: integer minimum: 0 default: 0 example: 0 schemas: PedidoV2: type: object properties: id: type: integer description: Código do pedido. example: 1 amount: type: number description: Valor total do pedido. example: 1 minAmount: type: number description: Valor mínimo exigido para o pedido. example: 1 productSubtotal: type: number description: Subtotal dos produtos do pedido, antes do desconto. example: 47.9 productDiscount: type: number description: Desconto aplicado sobre os produtos do pedido. example: 2 note: type: string description: Anotação do pedido. example: Conferir a validade dos itens refrigerados message: type: string description: Mensagem do pedido. example: Pedido semanal da unidade Barra stage: $ref: '#/components/schemas/EtapaPedidoV2' description: Etapa atual do pedido no fluxo. createdAt: type: string description: Data de criação. Formato UTC ISO 8601. example: '2026-05-20T02:37:52Z' concludedAt: type: - string - 'null' description: Data de conclusão, quando concluído. example: '2026-05-22T14:10:00Z' company: $ref: '#/components/schemas/EmpresaResumoV2' description: Empresa (unidade) que fez o pedido. supplier: $ref: '#/components/schemas/FornecedorResumoV2' description: Fornecedor do pedido. paymentMethod: $ref: '#/components/schemas/MetodoV2' description: Método de pagamento. shippingMethod: $ref: '#/components/schemas/MetodoV2' description: Método de entrega. createdByUser: $ref: '#/components/schemas/UsuarioResumoV2' description: Usuário que criou o pedido. shippingAddress: $ref: '#/components/schemas/EnderecoEntregaV2' description: Endereço de entrega. status: type: string description: |- Situação do pedido. | Valor | Significado | | ----- | ----------- | | `OPEN` | Aberto | | `CONCLUDED` | Concluído | | `CANCELED` | Cancelado | example: OPEN enum: - OPEN - CONCLUDED - CANCELED canceled: type: boolean description: Indica se o pedido foi cancelado. example: false EtapaPedidoV2: type: object properties: id: type: integer description: Código da etapa. example: 1 name: type: string description: Nome da etapa. example: Café Especial 500 g color: type: string description: Cor da etapa em hexadecimal, como exibida na plataforma. example: '#EFA64C' active: type: boolean description: '`true`: etapa ativa.' example: true index: type: integer description: Posição da etapa no fluxo. example: 0 EmpresaResumoV2: type: object properties: id: type: integer description: Código da empresa (unidade). example: 1 name: type: string description: Nome fantasia da empresa. example: Café Especial 500 g legalName: type: string description: Razão social da empresa. example: SULTS Tecnologia LTDA cnpj: type: string description: CNPJ da empresa, sem máscara. example: '12345678000190' active: type: boolean description: '`true`: empresa ativa.' example: true FornecedorResumoV2: type: object properties: id: type: integer description: Código do fornecedor. example: 1 name: type: string description: Nome fantasia do fornecedor. example: Café Especial 500 g legalName: type: string description: Razão social do fornecedor. example: SULTS Tecnologia LTDA MetodoV2: type: object properties: id: type: integer description: Código do método. example: 1 name: type: string description: Nome do método. example: A Combinar UsuarioResumoV2: type: object properties: id: type: integer description: Código do usuário. example: 1 name: type: string description: Nome do usuário. example: Café Especial 500 g EnderecoEntregaV2: type: object properties: postalCode: type: string description: CEP, sem máscara. example: '99999999' street: type: string description: Logradouro. example: Rua H1 neighborhood: type: string description: Bairro. example: Barra da Tijuca number: type: string description: Número. example: '1250' complement: type: string description: Complemento. example: Loja 3 city: type: string description: Cidade. example: Rio de Janeiro state: type: string description: UF. example: RJ 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 supplierId 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 supplierId 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 v2** (tokens v1 não funcionam aqui). 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 inexistente, ou recurso condicionado desabilitado (por exemplo, endpoints de Mix sem o recurso de mix habilitado na operação). 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 na Gestão de Tokens v2 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.