Skip to main content
POST
/
api
/
v1
/
ops
/
orders
/
{orderId}
/
tickets
/
{ticketId}
/
cancel
Cancel Ticket
curl --request POST \
  --url https://api.example.com/api/v1/ops/orders/{orderId}/tickets/{ticketId}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "ticketId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tripId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tripItineraryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "seatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "seatTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "passengerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "seatPrice": 123,
  "tripItineraryPrice": 123,
  "price": 123,
  "qrCode": "<string>",
  "code": "<string>",
  "snapshot": {},
  "boardedAt": "2023-11-07T05:31:56Z",
  "issuedAt": "2023-11-07T05:31:56Z",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
orderId
string<uuid>
required

Order identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

​
ticketId
string<uuid>
required

Ticket identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Passagens emitidas vinculando pedido, viagem, itinerário, assento e passageiro

​
ticketId
string<uuid>
required

Identificador único

​
orderId
string<uuid>
required

Referência ao pedido

​
tripId
string<uuid>
required

Referência à viagem

​
tripItineraryId
string<uuid>
required

Referência ao itinerário

​
seatId
string<uuid>
required

Referência ao assento

​
seatTypeId
string<uuid>
required

Referência ao tipo de assento

​
passengerId
string<uuid>
required

Referência ao Passenger

​
seatPrice
integer
required

Preço do tipo de assento no momento da emissão (centavos)

​
tripItineraryPrice
integer
required

Preço do itinerário no momento da emissão (centavos)

​
price
integer
required

Preço final pago pela passagem (centavos)

​
qrCode
string
required

Payload codificado para validação de embarque

​
code
string
required

Código legível da passagem

​
snapshot
object | null
required

Snapshot denormalizado (trip, itinerário, assento, tipo, passageiro) para exibição

​
boardedAt
string<date-time> | null
required

Data/hora do embarque (null se ainda não embarcou)

​
issuedAt
string<date-time>
required

Data de emissão da passagem

​
status
enum<string>
required

Status da passagem (default VALID)

Available options:
VALID,
CANCELLED
​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização