Consulta de Pedido
Esta API permite a consulta de informações de pedidos de diversas formas: através da resposta de um checkout, de um pedido específico, ou de uma lista de pedidos de um cliente.
Consultar pedido recém-criado: Resposta de Checkout
Busca o pedido recém-criado/processado imediatamente após uma transação de checkout, usando um ID referente ao pedido.
Rota
GET /partners/v4/orders/{PUBLIC_ID}/checkout-responseParâmetros da Rota
| Nome | Tipo | Descrição | Obrigatório |
|---|---|---|---|
PUBLIC_ID | String | O ID público do pedido | Sim |
Códigos de Resposta HTTP
| Código | Descrição |
|---|---|
200 OK | Pedido encontrado e retornado com sucesso. |
400 Bad Request | Autenticação inválida ou ausente. |
500 Internal Server Error | O checkoutId não corresponde a um pedido finalizado. |
Exemplos de Resposta
200 - Sucesso na confirmação do pedido
{
"success": true,
"data": {
"orderId": "Q4RPRZ85",
"checkoutId": "checkout_789012",
"status": "completed",
"createdAt": "2024-04-29T17:09:32Z",
"updatedAt": "2024-04-29T17:09:32Z",
"totalAmount": 57.23,
"currency": "BRL",
"paymentResponses": [
{
"id": "payment_resp_123456",
"status": "approved",
"amount": 57.23,
"currency": "BRL",
"gateway": "mercadoPago",
"externalId": "123456789",
"processedAt": "2024-04-29T17:09:32Z",
"responseCode": "00",
"responseMessage": "Transação aprovada"
}
],
"checkoutStatus": {
"status": "completed",
"message": "Checkout processado com sucesso",
"timestamp": "2024-04-29T17:09:32Z",
"code": "CHECKOUT_SUCCESS"
},
"redirectUrl": "https://www.clickbus.com.br/checkout/success",
"errorDetails": {
"code": "PAYMENT_FAILED",
"message": "Pagamento rejeitado pelo gateway",
"details": "Cartão expirado"
},
"metadata": {
"sessionId": "session_123456",
"userAgent": "Mozilla/5.0...",
"ipAddress": "192.168.1.1"
}
},
"message": "Checkout response retrieved successfully",
"timestamp": "2024-04-29T17:09:32Z"
}400 - Bad Request
{
"code":"3156",
"error":"HttpException",
"canRebook":false,
"transactionId":"TWeb=3b6faae6-11f4-4be1-89f6-48b2b21fb139",
"status":0
}500 - Internal Server Error
{
"genericBookingError":true,
"code":"2111",
"pageData":{
"id":"WN0E09XX"
},
"error":"HttpException",
"message":"Booking was not possible",
"canRebook":false,
"transactionId":"TWeb=241463d8-21d1-45cb-8d25-6a0f76f1d987",
"status":0
}Consultar detalhes do Pedido
Busca os detalhes completos de um pedido através do seu ID público.
Rota
GET /partners/api/v4/orders/{PUBLIC_ID}Parâmetros da Rota
| Nome | Tipo | Descrição | Obrigatório |
|---|---|---|---|
PUBLIC_ID | String | O ID público do pedido | Sim |
Códigos de Resposta HTTP
| Código | Descrição |
|---|---|
200 OK | Pedido encontrado e retornado com sucesso. |
Estrutura da Resposta (200 OK)
Informações Principais
publicId: ID público do pedidostatus: Status atual do pedidototalAmount: Valor totalcurrency: Moeda utilizadaemail: Email do clienteorigin: Origem da viagemdestination: Destino da viagem
Dados do Cliente
customer: Objeto com dados completospassengerNames: Nomes dos passageirospaymentGateway: Gateway de pagamentopaymentType: Tipo de pagamentoboardingPass: Se possui passe de embarque
Exemplo Completo de Resposta
{
"publicId": "Q4RPRZ85",
"status": "completed",
"createdAt": "2024-04-29 17:09:32",
"updatedAt": "2024-04-29 17:09:32",
"totalAmount": 27.05,
"currency": "BRL",
"clientId": 2,
"clientName": "BR Web Desktop",
"email": "[email protected]",
"activeUser": true,
"origin": "Sao Paulo, SP - Tiete",
"destination": "Campinas, SP",
"originSlug": "sao-paulo-tiete-sp",
"destinationSlug": "campinas-sp",
"passengerNames": [
"José da Silva"
],
"paymentExternalRemoteIds": [
0
],
"paymentGateway": "mercadoPago",
"paymentType": "credit_card",
"boardingPass": true,
"totalItems": 2,
"totalDiscount": "0.00",
"percentageFee": "18.00",
"refundedItems": 0,
"customer": {
"id": 5082716,
"email": "[email protected]",
"name": "Joao Victor Raia",
"phone": "(11) 98989-8998",
"documentType": "cpf",
"documentNumber": 698463323,
"birthDate": "1990-01-01",
"gender": "M",
"newsletterSubscription": true
},
"item": [
{
"id": 37158284,
"type": "ticket",
"status": "completed",
"amount": "99.99",
"currency": "BRL",
"createdAt": "2022-10-17 15:56:12",
"updatedAt": "2022-10-17 15:56:20",
"itemDetails": {
"trip": {
"id": "trip-uuid-123",
"type": "direct",
"departure": {
"schedule": {
"date": "2022-10-18",
"time": "08:30:00",
"timezone": "America/Sao_Paulo"
},
"place": {
"id": 4017,
"name": "São Paulo, SP - Tietê",
"slug": "sao-paulo-tiete-sp",
"city": "São Paulo",
"state": "São Paulo",
"country": "Brazil",
"terminal": "Terminal Rodoviário do Tietê - São Paulo"
}
},
"arrival": {
"schedule": {
"date": "2022-10-18",
"time": "14:30:00",
"timezone": "America/Sao_Paulo"
},
"place": {
"id": 3827,
"name": "Rio de Janeiro, RJ - Rodoviária do Rio",
"slug": "rio-de-janeiro-rj",
"city": "Rio de Janeiro",
"state": "Rio de Janeiro",
"country": "Brazil",
"terminal": "Rodoviária do Rio"
}
},
"serviceClass": {
"id": 3,
"name": "Semi-Leito"
},
"travelCompany": {
"id": 6,
"name": "Catarinense",
"logo": "https://static.clickbus.com/fallen/travel-company-logos/catarinense.svg",
"slug": "catarinense"
},
"duration": "6h 00m",
"busName": "Semi-Leito",
"availableSeats": 45,
"hasBoardingPass": true,
"hasElectronicBoardingPass": true
},
"passenger": {
"id": 12345,
"name": "Joao Victor Raia",
"documentType": "cpf",
"documentNumber": "00698463323",
"phone": "(11) 98989-8998",
"email": "[email protected]",
"birthDate": "1990-01-01",
"gender": "M",
"seat": {
"id": 1,
"label": "A1",
"position": {
"x": 1,
"y": 1,
"z": 0
}
}
}
},
"actions": {
"canCancel": true,
"canChange": true,
"canRefund": false,
"cancellationDeadline": "2022-10-17T23:59:59Z",
"changeDeadline": "2022-10-17T23:59:59Z"
},
"isLowFare": false
}
],
"payments": [
{
"id": 13028664,
"type": "pix",
"status": "PROCESSING",
"amount": "57.23",
"currency": "BRL",
"gateway": "mercadoPago",
"externalId": "123456789",
"createdAt": "2024-04-29 17:09:32",
"updatedAt": "2024-04-29 17:09:32",
"lastUpdatedBy": "whitelabel_busao",
"installments": 1,
"installmentAmount": "57.23",
"discountAmount": "0.00",
"refundedAmount": "0.00",
"responseReasonCode": "pending",
"responseReason": "pending",
"itemIds": [
38361184
],
"descriptor": null,
"gatewayEnum": "PayMee Brasil Serviços de Pagamentos",
"meta": {}
}
]
}Updated 2 months ago
Did this page help you?

