---
title: "Consultar lista de pedidos"
method: GET
path: "/partners/api/v6/orders"
tags: ["Pedidos"]
---

# Consultar lista de pedidos

`GET /partners/api/v6/orders`

Consulta lista de pedidos por um filtro específico. Retorna informações resumidas sobre os pedidos, incluindo dados do cliente, tickets de ida/volta, pagamentos e status.

É obrigatório fornecer pelo menos um identificador do cliente (email, documentNumber ou phone), exceto quando `externalRemoteId` for informado (nesse caso a identificação é feita pelo ID externo). Os filtros de data, status e ordenação podem ser combinados livremente.

Casos de uso típicos: - Buscar pedido pelo ID externo do parceiro (externalRemoteId) - Listar próximas viagens (departureDateFrom + sort=departureDate,asc + ticketStatus=completed) - Buscar por localizador do ticket (localizer) - Filtrar por período de compra (dateFrom + dateTo) - Buscar por nome de passageiro (passenger) - Exibir histórico de compras (sort=createdAt,desc + size para paginação) - Buscar pedidos por status específico (status=canceled ou ticketStatus=canceled)

## Query parameters

- `externalRemoteId` string
- `email` string, email
- `phone` number
- `documentNumber` number
- `size` number
- `departureDateFrom` string
- `departureDateTo` string
- `dateFrom` string
- `dateTo` string
- `localizer` string
- `passenger` string
- `sort` 'departureDate,asc' | 'departureDate,desc' | 'createdAt,asc' | 'createdAt,desc'
- `ticketStatus` 'completed' | 'pending' | 'canceled' | 'partially_canceled'
- `status` 'pending' | 'completed' | 'canceled' | 'partially_canceled' | 'incomplete'

## Response `200`

Lista de pedidos do cliente

- OrderDto[] — Lista de pedidos do cliente. Retorna array vazio quando nenhum pedido é encontrado para os filtros informados. Cada item contém informações resumidas do pedido, tickets de ida/volta e pagamentos.
  - `publicId` string, required — Identificador público único do pedido. Código alfanumérico de 8 caracteres usado para referência em todas as operações (consulta individual, cancelamento, etc).
  - `status` 'pending' | 'completed' | 'canceled' | 'partially_canceled' | 'incomplete', required — Status atual do pedido. Reflete o estado consolidado da ordem. 'pending' = aguardando processamento do pagamento; 'completed' = pagamento confirmado e tickets emitidos; 'canceled' = pedido totalmente cancelado (todos os itens); 'partially_canceled' = alguns itens cancelados, outros ativos; 'incomplete' = falha no pagamento ou timeout.
  - `createdAt` string, required — Data e hora de criação do pedido no formato ISO 8601. Representa o momento em que o checkout foi iniciado.
  - `totalAmount` number, double, required — Valor total pago pelo pedido em reais (BRL). Inclui tickets, taxas de serviço e seguros. Não inclui descontos já subtraídos. Para pedidos parcialmente cancelados, reflete o valor original (não o valor residual).
  - `currency` 'BRL', required — Código da moeda no padrão ISO 4217. Atualmente sempre 'BRL' para operações Brasil.
  - `clientApplication` ClientApplicationDTO, required — Identificação da aplicação/canal que originou o pedido
    - `id` number, required — ID interno da aplicação cliente. Usado para identificar o canal de venda (ex: 2 = BR Web Desktop, 5 = Partner App, etc).
    - `name` string, required — Nome legível da aplicação cliente
  - `customer` CustomerDTO, required — Dados resumidos do cliente/comprador
    - `email` string, required — Endereço de email do cliente que realizou a compra
    - `activeUser` boolean, required — Indica se o cliente possui cadastro ativo na plataforma ClickBus. false = comprador avulso (guest checkout).
  - `directionNextTrip` string, nullable, required — Direção da próxima viagem quando aplicável (usado internamente para ordenação de próximos embarques). Geralmente null na resposta de listagem.
  - `tickets` TicketsDTO, required — Estrutura contendo tickets de ida (departure) e volta (return). Para viagens somente ida, o campo 'return' será null.
    - `departure` TicketDTO, required — Informações detalhadas de um trecho (ida ou volta)
      - `origin` string, required — Nome completo do ponto de embarque no formato "Cidade, UF - Terminal". Pode variar de acordo com o terminal (ex: "Sao Paulo, SP - Tiete" vs "Sao Paulo, SP - Barra Funda").
      - `destination` string, required — Nome completo do ponto de desembarque no formato "Cidade, UF" ou "Cidade, UF - Terminal".
      - `originSlug` string, required — Slug identificador da origem. Usado para construção de URLs e deep links. Formato: cidade-estado ou cidade-terminal-estado.
      - `destinationSlug` string, required — Slug identificador do destino. Mesmo formato do originSlug.
      - `travelCompany` string, required — Nome da companhia rodoviária que opera o trecho.
      - `departureDate` string, required — Data e hora de partida no formato ISO 8601 (sem timezone - considera horário local do embarque). Formato: YYYY-MM-DDTHH:mm:ss
      - `arrivalDate` string, required — Data e hora estimada de chegada no formato ISO 8601 (sem timezone - considera horário local do destino). Formato: YYYY-MM-DDTHH:mm:ss
      - `passengerNames` string[], required — Nomes completos dos passageiros deste trecho. Um pedido pode ter múltiplos passageiros (ex: família viajando junta). A ordem dos nomes corresponde à ordem de cadastro no checkout.
    - `return` TicketDTO, required — Informações detalhadas de um trecho (ida ou volta)
      - `origin` string, required — Nome completo do ponto de embarque no formato "Cidade, UF - Terminal". Pode variar de acordo com o terminal (ex: "Sao Paulo, SP - Tiete" vs "Sao Paulo, SP - Barra Funda").
      - `destination` string, required — Nome completo do ponto de desembarque no formato "Cidade, UF" ou "Cidade, UF - Terminal".
      - `originSlug` string, required — Slug identificador da origem. Usado para construção de URLs e deep links. Formato: cidade-estado ou cidade-terminal-estado.
      - `destinationSlug` string, required — Slug identificador do destino. Mesmo formato do originSlug.
      - `travelCompany` string, required — Nome da companhia rodoviária que opera o trecho.
      - `departureDate` string, required — Data e hora de partida no formato ISO 8601 (sem timezone - considera horário local do embarque). Formato: YYYY-MM-DDTHH:mm:ss
      - `arrivalDate` string, required — Data e hora estimada de chegada no formato ISO 8601 (sem timezone - considera horário local do destino). Formato: YYYY-MM-DDTHH:mm:ss
      - `passengerNames` string[], required — Nomes completos dos passageiros deste trecho. Um pedido pode ter múltiplos passageiros (ex: família viajando junta). A ordem dos nomes corresponde à ordem de cadastro no checkout.
  - `payments` PaymentDTO[], required — Lista de pagamentos associados ao pedido. Um pedido pode ter múltiplos pagamentos quando há split (ex: parte cartão + parte voucher) ou reprocessamento.
    - `paymentGateway` 'mercadoPago' | 'paymee' | 'nuPay' | 'tuna', required — Gateway de pagamento utilizado para processar a transação. Valores possíveis: mercadoPago, paymee, nuPay, tuna.
    - `paymentType` 'credit_card' | 'debit_card' | 'pix' | 'pix_installment' | 'wallet', required — Método de pagamento escolhido pelo cliente. 'credit_card' = cartão de crédito (com ou sem parcelamento); 'debit_card' = cartão de débito; 'pix' = transferência instantânea PIX; 'pix_installment' = PIX parcelado; 'wallet' = saldo em carteira ClickBus.

## Other responses

- `400` — Requisição inválida. Causas comuns: nenhum identificador fornecido (email/documentNumber/phone), email em formato inválido, ou campo numérico com caracteres especiais.
- `401` — Não autorizado - token inválido, expirado ou ausente
- `500` — Erro interno do servidor

---

[API](https://skmtc.net/clickbus/apis/documenta-o-da-api-de-autentica-o-clickbus.md) · [All operations](https://skmtc.net/clickbus/apis/documenta-o-da-api-de-autentica-o-clickbus/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clickbus/documenta-o-da-api-de-autentica-o-clickbus/revisions/ead7d81fdb28/schema)