Trip API (v2)

Download OpenAPI description
Languages
Servers
Staging URL
https://apis.spotnana.com/
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/tripapi/

Trips

APIs to manage trips.

Operations

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

OK

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

List tripsDeprecated

Request

Retrieves the list of trips associated with an organization.

Deprecation notice

The List Trips /v2/list-organisation-trips endpoint has been deprecated. Use the new List trip summaries for a company /v3/trips/companies/{companyId}/list endpoint instead.

Bodyapplication/json
organizationIdobject(OrganizationId)required

Organization id for traveler.

organizationId.​idstringrequired
updatedAtobject(DateTimeOffset)

ISO8601 UTC Date Time

pnrTypestringrequired

Type of PNR

Enum"AIR""CAR""RAIL""HOTEL""LIMO""ALL"
customFieldIdsArray of objects(CustomFieldId)Deprecated

List of custom field IDs to filter. This field is not in use and has been deprecated.

curl -i -X POST \
  https://apis.spotnana.com/v2/list-organisation-trips \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organizationId": {
      "id": "string"
    },
    "updatedAt": {
      "iso8601": "2017-07-21T17:32Z"
    },
    "pnrType": "AIR",
    "customFieldIds": [
      {
        "type": "QUESTION",
        "externalId": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
tripsArray of objects(OrgTripInfo)
Response
application/json
{ "trips": [ {} ] }

PNRs

APIs to manage PNRs within trips.

Invoicing

APIs to manage invoicing.

Operations

Approval

APIs to manage approvals.

Operations