OrbitDocs packages are coming to npm soon. Until then, run it from the GitHub repo →
v1.0.0OpenAPI 3.1.1

Demo: Orbit Travel API

Download OpenAPI Document

Search destinations, flights and seat maps, book and pay, manage saved passengers and Orbit Miles, and receive booking and payment events by webhook or from the Events API.

Every request needs an API key in the x-api-key header, or an OAuth access token from Create an access token in Authorization: Bearer …. Each credential can make 60 requests a minute.

Server
Local
Authentication Required
Your API key. The sample server accepts `otk_test_4f9a2c1b8e7d6a5f`.
x-api-key:
Client Libraries
Shell

Authentication

Operations

Create an access token

Exchanges your client id and secret for an access token (OAuth 2.0 client credentials grant). Send the token as Authorization: Bearer … instead of an API key; it expires after an hour.

This endpoint takes no API key or token itself.

Bodyrequiredapplication/x-www-form-urlencoded

grant_typestringrequired

Always client_credentials.

Example: client_credentials
client_secretstring · passwordrequired

Your OAuth client secret. The sample server accepts ocs_test_5e8d2a7c9b1f.

Example: ocs_test_5e8d2a7c9b1f
client_idstringrequired

Your OAuth client id. The sample server accepts oc_test_orbit_demo.

Example: oc_test_orbit_demo
scopestring

Space-separated scopes. Omit for every scope the client may use.

Example: bookings:read bookings:write

Responses

200OK
application/json
token_typestringrequired

Token type.

Enum values:Bearer
Example: Bearer
access_tokenstringrequired

Send it as Authorization: Bearer <access_token>.

Example: oat_test_Q2xpZW50Q3JlZGVudGlhbHM
expires_innumberrequired

Seconds until the token expires. Request a new one before then.

Example: 3600
scopestringrequired

Scopes granted, space-separated.

Example: bookings:read bookings:write
Headers
X-RateLimit-Limitinteger

Requests allowed per minute for this credential.

Example: 60
X-RateLimit-Remaininginteger

Requests left in the current window.

Example: 59
X-RateLimit-Resetinteger

When the window resets, in Unix seconds.

Example: 1949398800
400Malformed request, unsupported `grant_type` or unknown scope.
application/json
errorstringrequired

Machine-readable error code.

Example: invalid_client
error_descriptionstringrequired

What went wrong, for people.

Example: Unknown client or wrong secret.
401Unknown client or wrong secret.
application/json
errorstringrequired

Machine-readable error code.

Example: invalid_client
error_descriptionstringrequired

What went wrong, for people.

Example: Unknown client or wrong secret.
429Too many requests: more than 60 a minute. Wait `Retry-After` seconds, then retry.
application/json
statusCodeintegerrequired

HTTP status code, repeated in the body.

Example: 404
messagestring | string[]required

What went wrong, for people. Validation failures list one entry per problem. Do not branch on this text.

Example: Booking not found
errorstring

Short name of the status.

Example: Not Found
Headers
Retry-Afterinteger

Seconds to wait before retrying.

Example: 42
X-RateLimit-Limitinteger

Requests allowed per minute for this credential.

Example: 60
X-RateLimit-Remaininginteger

Requests left in the current window.

Example: 59
X-RateLimit-Resetinteger

When the window resets, in Unix seconds.

Example: 1949398800
500Something failed on the server. Retry with backoff.
application/json
statusCodeintegerrequired

HTTP status code, repeated in the body.

Example: 404
messagestring | string[]required

What went wrong, for people. Validation failures list one entry per problem. Do not branch on this text.

Example: Booking not found
errorstring

Short name of the status.

Example: Not Found
POST/v1/oauth/token
curl http://localhost:3010/v1/oauth/token \
  --request POST \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'client_secret=ocs_test_5e8d2a7c9b1f' \
  --data-urlencode 'client_id=oc_test_orbit_demo' \
  --data-urlencode 'scope=bookings:read bookings:write'
{
  "token_type": "Bearer",
  "access_token": "oat_test_Q2xpZW50Q3JlZGVudGlhbHM",
  "expires_in": 3600,
  "scope": "bookings:read bookings:write"
}
OK

Destinations

Operations

List destinations

GET/v1/destinations

Get a destination

GET/v1/destinations/{id}

Flights

Operations

Search flights

GET/v1/flights

Get a flight

GET/v1/flights/{id}

Seats

Operations

Get a seat map

GET/v1/flights/{id}/seats

Hold seats

POST/v1/flights/{id}/seat-holds

Bookings

Operations

Create a booking

POST/v1/bookings

List bookings

GET/v1/bookings

Get a booking

GET/v1/bookings/{id}

Update a booking

PATCH/v1/bookings/{id}

Cancel a booking

POST/v1/bookings/{id}/cancel

Upload a travel documentbeta

POST/v1/bookings/{id}/documents

List travel documents

GET/v1/bookings/{id}/documents

Download a boarding pass

GET/v1/bookings/{id}/boarding-pass

Passengers

Operations

Create a passenger

POST/v1/passengers

List passengers

GET/v1/passengers

Get a passenger

GET/v1/passengers/{id}

Update a passenger

PATCH/v1/passengers/{id}

Delete a passenger

DELETE/v1/passengers/{id}

Payments

Operations

Pay for a booking

POST/v1/bookings/{id}/payments

Get a payment

GET/v1/payments/{id}

Refund a payment

POST/v1/payments/{id}/refunds

Loyalty

Operations

Get the loyalty account

GET/v1/loyalty/account

List loyalty transactions

GET/v1/loyalty/transactions

Redeem points

POST/v1/loyalty/redemptions

Events

Operations

List events

GET/v1/events

Get an event

GET/v1/events/{id}

Webhooks

Operations

Create a webhook endpoint

POST/v1/webhook-endpoints

List webhook endpoints

GET/v1/webhook-endpoints

Delete a webhook endpoint

DELETE/v1/webhook-endpoints/{id}

Send a test event

POST/v1/webhook-endpoints/{id}/test

Models

BankTransferInstructionsDto
BankTransferPaymentRequestDto
BoardingGroup Boarding group, called in order.
BoardingPassDto
BoardingPassFormat
BoardingPassPassengerDto
BookingDto
BookingListDto
BookingStatus Where the booking is in its life.
CabinClass Cabin.
CabinSeatMapDto
CancelBookingDto
CardBrand Card network.
CardDetailsDto
CardPaymentRequestDto
Climate
CreateBookingDto
CreatePassengerDto
CreateRedemptionDto
CreateRefundDto
CreateSeatHoldDto
CreateWebhookEndpointDto
DestinationDto
DestinationListDto
DocumentKind What the document is, detected from the scan.
DocumentStatus Review status. Boarding needs a verified passport.
EventDataDto
EventDto
EventListDto
FareDto
FlightDto
FlightListDto
GrantType Always `client_credentials`.
LegacyFlightSearchDto
LoyaltyAccountDto
LoyaltyTier Current tier, from lifetime points.
LoyaltyTransactionDto
LoyaltyTransactionListDto
LoyaltyTransactionType
MealPreference Meal served on board.
OAuthErrorCode Machine-readable error code.
OAuthErrorDto
PageInfoDto
PassengerDto
PassengerListDto
PassengerProfileDto
PassportDto
PaymentDto
PaymentMethodDetailsDto
PaymentMethodType How the payment was made. Exactly one of the objects below is set.
PaymentStatus Where the payment is in its life.
RedemptionDto
RedemptionStatus Redemptions complete immediately.
RefundDto
RefundReason Why the money went back.
RefundStatus Bank transfer refunds stay `pending` for a few days.
RewardType Reward to buy. Costs: `cabin_upgrade` 40,000, `booking_credit` 10,000 ($100 off), `extra_baggage` 8,000, `lounge_access` 5,000.
SeatDto
SeatFeature What makes this seat different.
SeatHoldDto
SeatHoldStatus Active until it is used on a booking or expires.
SeatMapDto
SeatPreference Preferred seat, used when seats are auto-assigned.
SeatPriceDto
SeatRowDto
SeatStatus Whether the seat can be held.
TestWebhookEndpointDto
TierProgressDto
TokenRequestDto
TokenResponseDto
TravelDocumentDto
TravelDocumentListDto
TravelPreferencesDto
UpdateBookingDto
UpdatePassengerDto
UpdateTravelPreferencesDto
UploadDocumentDto
WalletPaymentRequestDto
WalletType Wallet the token comes from.
WebhookDeliveryDto
WebhookDeliveryStatus `succeeded` when your endpoint answered with a 2xx status.
WebhookEndpointDto
WebhookEndpointListDto
WebhookEvent