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-response

Parâmetros da Rota

NomeTipoDescriçãoObrigatório
PUBLIC_IDStringO ID público do pedidoSim

Códigos de Resposta HTTP

CódigoDescrição
200 OKPedido encontrado e retornado com sucesso.
400 Bad RequestAutenticação inválida ou ausente.
500 Internal Server ErrorO 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
}