v1
latestOpenAPI 3.0.02026-07-2420104111.7 KBGerenciamento de Pedidos
Criar novo pedido
Cria um novo pedido com os itens, dados do cliente e informações de pagamento fornecidos. Este endpoint processa a criação completa de um pedido, incluindo validação dos dados, processamento do pagamento e geração do identificador único do pedido de forma assíncrona.
post/partners/api/v4/orders?mode=async
Request body
Example request
{
"client": {
"clientVersion": "v1"
},
"customer": {
"id": 5082716,
"email": "test-env@clickbus.com",
"name": "Joao Victor Raia",
"phone": "(11) 98989-8998",
"documentType": "cpf",
"birthDate": "1990-01-01",
"gender": "M",
"newsletterSubscription": true
},
"device": {
"id": "192.168.199.9"
},
"orderItems": [
{
"type": "ticket",
"meta": {
"id": "xlv51gva3tgbmtz5ith2nvgxb",
"amount": 18.84,
"tripTypeDirection": "departure_type",
"type": "direct",
"tripLeg": 1,
"passenger": {
"documentType": "cpf",
"documentNumber": "99999999999",
"name": "John Doe"
}
}
}
],
"payment": {
"amount": 18.84,
"currency": "BRL",
"installments": 1,
"paymentDetails": {},
"meta": {},
"type": "direct"
},
"totalAmount": 18.84,
"externalId": "PARTNER12345"
}Response
Pedido criado com sucesso
Example response
{
"orderId": "QMTL04R2",
"status": "pending",
"totalAmount": 18.84,
"createdAt": "2024-01-15T10:30:00Z",
"externalOrderId": "PARTNER12345",
"paymentStatus": "processing",
"itemDetails": {
"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": "test-env@clickbus.com",
"birthDate": "1990-01-01",
"gender": "M",
"seat": {
"id": 1,
"label": "A1",
"position": {
"x": 1,
"y": 1
}
}
}
},
"actions": {
"canCancel": true,
"canChange": true,
"cancellationDeadline": "2022-10-17T23:59:59Z",
"changeDeadline": "2022-10-17T23:59:59Z"
}
}
}