API reference

Trip

Find Pnr details like BookingId and TripId

Trip API (v2)

Download OpenAPI description

TripApi.json

TripApi.yaml

Servers

Staging URL

https://apis.spotnana.com/

Spotnana mock server

https://developer.spotnana.com/_mock/openapi/tripapi/

Trips

APIs to manage trips.

Operations

Get PNR by external Id

Request

This endpoint gets PNR Id and Trip Id for a given external Id.

Query

externalIdstringrequired

External ID

Example: externalId=external-pnr-id

curl -i -X GET \
  'https://apis.spotnana.com/v2/pnrs?externalId=external-pnr-id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

pnrIdstringrequired

Spotnana PNR Id mapped with external Id

Example: "1234567890"

tripIdstringrequired

Spotnana trip Id mapped with external Id

Example: "1234567890"

Response

application/json

{
  "pnrId": "1234567890",
  "tripId": "1234567890"
}

Find Pnr details like BookingId and TripId

Request

This API gets Pnr details for a given Source Pnr/ Ticket Number/ Vendor Confirmation.

Query

searchTextstringrequired

The Source Pnr or Ticket Number or Vendor Confirmation to be searched

Example: searchText=MDIB5C

inputTypestringrequired

The type of Search text,i.e, SOURCE_PNR or TICKET_NUMBER or VENDOR_CONFIRMATION

Enum"SOURCE_PNR""TICKET_NUMBER""VENDOR_CONFIRMATION"

Example: inputType=SOURCE_PNR

curl -i -X GET \
  'https://apis.spotnana.com/v2/pnrs/search?inputType=SOURCE_PNR&searchText=MDIB5C' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

pnrIdstringrequired

Spotnana Booking Id mapped with Source PNR or Ticket Number or Vendor Confirmation

Example: "1234567890"

tripIdstringrequired

Trip Id associated with the booking

Example: "1234567890"

Response

application/json

{
  "pnrId": "1234567890",
  "tripId": "1234567890"
}

Get tripDeprecated

Request

Retrieves trip info by ID.

Deprecation notice

The Get Trip /v2/trips/{tripId} endpoint has been deprecated. Use the new Get trip details /v3/trips/{tripId}/detail endpoint instead.

Path

tripIdstringrequired

Identifier for trip.

Example: 2398199412

curl -i -X GET \
  https://apis.spotnana.com/v2/trips/2398199412 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

tripIdstringrequired

Spotnana trip Id

Example: "6926658168"

tripNamestringrequired

Name of the trip

Example: "JFK SFO Trip"

tripDescriptionstring

Trip description

Example: "JFK SFO Business Trip"

applicationIdstring(uuid)

Application id used for the trip.

startDateobject(DateModel)

Date in ISO 8601 standard.

endDateobject(DateModel)

Date in ISO 8601 standard.

userIdobject(UserId)

The user Id of the traveler to whom the trip belongs to.

registrarUserIdobject(UserId)

The user Id of the registrar of the adhoc traveler.

tripMetadataobject(TripMetadata)

Metadata for the trip

tripDisabledInfoobject(TripDisabledInfo)

Information regarding whether the trip is disabled and if so, the reason why.

Response

application/json

{
  "tripId": "6926658168",
  "tripName": "JFK SFO Trip",
  "tripDescription": "JFK SFO Business Trip",
  "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  "startDate": {
    "iso8601": "2017-07-21"
  },
  "endDate": {
    "iso8601": "2017-07-21"
  },
  "userId": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "registrarUserId": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tripMetadata": {
    "hasTripOverride": true,
    "preferredCurrency": "USD",
    "tripContacts": [ … ]
  },
  "tripDisabledInfo": {
    "disabledReason": "MAX_BOOKINGS_EXCEEDED",
    "isDisabled": false
  }
}

PNRs

APIs to manage PNRs within trips.

Invoicing

APIs to manage invoicing.

Operations

Approval

APIs to manage approvals.

Operations