Sign in

v1

latestOpenAPI 3.0.02026-07-2420104111.7 KB
Pedidos

Consultar lista de pedidos

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)

get/partners/api/v6/orders

Query parameters

externalRemoteIdstring
Example:PARTNER-ORDER-789

ID externo fornecido pelo parceiro no momento do checkout. Quando informado, dispensa a obrigatoriedade de email/documentNumber/phone — a busca é feita diretamente pelo identificador do parceiro.

emailstring email
Example:test@email.com

E-mail do cliente. Obrigatório se documentNumber, phone e externalRemoteId não forem fornecidos. Deve ser um email válido. A busca é case-insensitive.

phonenumber
Example:11999998888

Número de telefone do cliente. Deve ser numérico, sem caracteres especiais (sem +, parênteses, hífens ou espaços). Inclui DDD. Obrigatório se email e documentNumber não forem fornecidos.

documentNumbernumber
Example:12345678901

Número do documento do cliente (CPF). Deve ser numérico, sem pontos ou hífens. Obrigatório se email e phone não forem fornecidos.

sizenumber
Example:10

Quantidade máxima de pedidos retornados na resposta. Quando omitido, retorna todos os pedidos encontrados para os filtros informados. Recomendação: usar sempre para evitar respostas muito grandes em clientes com muitos pedidos.

departureDateFromstring
Example:2025-06-24T00:00

Data de embarque a partir da qual filtrar os pedidos (inclusive). Formato: YYYY-MM-DDTHH:mm. Filtra pedidos cuja data de partida do ticket é igual ou posterior ao valor informado. Ideal para listar "próximas viagens".

departureDateTostring
Example:2025-07-31T23:59

Data de embarque até a qual filtrar os pedidos (inclusive). Formato: YYYY-MM-DDTHH:mm. Use em conjunto com departureDateFrom para definir um período específico de embarque.

dateFromstring
Example:2025-01-01

Filtra pedidos criados a partir desta data (inclusive). Formato: YYYY-MM-DD. Refere-se à data de criação/compra do pedido, não à data de embarque.

dateTostring
Example:2025-03-31

Filtra pedidos criados até esta data (inclusive). Formato: YYYY-MM-DD. Use em conjunto com dateFrom para definir um período de compras.

localizerstring
Example:ABC123

Código localizador do ticket. É o código que o passageiro recebe após a compra para identificar sua passagem. Busca exata.

passengerstring
Example:José da Silva

Nome do passageiro para busca. Suporta busca parcial (contém o texto informado). Útil quando o parceiro quer localizar um pedido pelo nome de quem vai viajar.

sort'departureDate,asc' | 'departureDate,desc' | 'createdAt,asc' | 'createdAt,desc'
Example:departureDate,asc

Critério de ordenação dos pedidos no formato "campo,direção". Valores aceitos: departureDate,asc | departureDate,desc | createdAt,asc | createdAt,desc. 'departureDate' ordena pela data de embarque do ticket; 'createdAt' ordena pela data de criação do pedido. Quando omitido, a ordenação padrão é por relevância interna.

ticketStatus'completed' | 'pending' | 'canceled' | 'partially_canceled'
Example:completed

Filtra pedidos pelo status dos tickets/itens. Atenção: filtra pelo status dos itens internos do pedido, não pelo status da ordem em si. 'completed' = tickets emitidos com sucesso; 'pending' = aguardando processamento; 'canceled' = tickets cancelados; 'partially_canceled' = parcialmente cancelados.

status'pending' | 'completed' | 'canceled' | 'partially_canceled' | 'incomplete'
Example:completed

Filtra pelo status da ordem (diferente de ticketStatus que filtra itens). 'pending' = aguardando processamento do pagamento; 'completed' = pagamento confirmado; 'canceled' = pedido totalmente cancelado; 'partially_canceled' = alguns itens cancelados, outros ativos; 'incomplete' = falha no pagamento ou timeout.

Response

Lista de pedidos do cliente

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

createdAtstring required

Data e hora de criação do pedido no formato ISO 8601. Representa o momento em que o checkout foi iniciado.

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

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

Example response

[
  {
    "publicId": "Q4RPRZ85",
    "status": "completed",
    "createdAt": "2024-09-27T20:25:01.203",
    "totalAmount": 154.9,
    "currency": "BRL",
    "clientApplication": {
      "id": 2,
      "name": "BR Web Desktop"
    },
    "customer": {
      "email": "test-env@clickbus.com",
      "activeUser": true
    },
    "tickets": {
      "departure": {
        "origin": "Sao Paulo, SP - Tiete",
        "destination": "Campinas, SP",
        "originSlug": "sao-paulo-tiete-sp",
        "destinationSlug": "campinas-sp",
        "travelCompany": "LiraBus",
        "departureDate": "2024-10-15T02:00:00",
        "arrivalDate": "2024-10-15T03:15:00",
        "passengerNames": [
          "José da Silva",
          "Maria da Silva"
        ]
      },
      "return": {
        "origin": "Sao Paulo, SP - Tiete",
        "destination": "Campinas, SP",
        "originSlug": "sao-paulo-tiete-sp",
        "destinationSlug": "campinas-sp",
        "travelCompany": "LiraBus",
        "departureDate": "2024-10-15T02:00:00",
        "arrivalDate": "2024-10-15T03:15:00",
        "passengerNames": [
          "José da Silva",
          "Maria da Silva"
        ]
      }
    },
    "payments": [
      {
        "paymentGateway": "mercadoPago",
        "paymentType": "credit_card"
      }
    ]
  }
]