Sign in

v1

latestOpenAPI 3.0.02026-07-2420104111.7 KB
Pedidos

Consultar detalhes do pedido

Consulta detalhes de um pedido específico por ID. Retorna informações completas sobre o pedido, incluindo dados do cliente, itens, pagamentos e status. Requer autenticação por email ou documento para validação de acesso. É obrigatório fornecer pelo menos um dos parâmetros: email ou documentNumber.

get/partners/api/v4/orders/{id}

Path parameters

publicIdstring required
Example:Q4RPRZ85

Identificador único do pedido

Query parameters

emailstring
Example:test@email.com

O e-mail do usuário (obrigatório se documentNumber não for fornecido)

documentNumberstring

Número do documento do usuário. Deve ser numérico. (obrigatório se email não for fornecido)

Response

Detalhes do pedido solicitado

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"
    }
  ]
}