APIs to manage trips.
Trip API (v2)
Request
This endpoint creates a trip object. A trip is a container object for all related PNRs associated with a trip.
- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v2/trips
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v2/trips
- curl
- JavaScript
- Node.js
- Python
curl -i -X POST \
https://api-ext-sboxmeta.partners.spotnana.com/v2/trips \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"tripName": "string",
"tripDescription": "string",
"userId": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"registrarId": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"startDate": {
"iso8601": "2017-07-21"
},
"endDate": {
"iso8601": "2017-07-21"
}
}'{ "id": "string" }
- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v2/trips/{tripId}
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v2/trips/{tripId}
- curl
- JavaScript
- Node.js
- Python
curl -i -X PUT \
https://api-ext-sboxmeta.partners.spotnana.com/v2/trips/2398199412 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"tripId": "6926658168",
"tripName": "JFK SFO Trip",
"tripDescription": "JFK SFO Business Trip"
}'- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v3/trips/{tripId}/detail
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v3/trips/{tripId}/detail
- curl
- JavaScript
- Node.js
- Python
curl -i -X GET \
'https://api-ext-sboxmeta.partners.spotnana.com/v3/trips/6926658168/detail?refreshType=REFRESH_TYPE_BLOCKING&fetchMappedData=false' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'OK
Basic trip info
Information regarding whether the trip is disabled and if so, the reason why.
User facing booking status
Payment info for a given trip. Fares of pending manual form and pending shell pnrs are not considered.
When true, the agent "add manual credit" action is disabled on the Trips page because the trip traveler's home legal-entity market is not in the company's supported set.
{ "basicTripInfo": { "tripId": "6926658168", "tripName": "JFK SFO Trip", "tripDescription": "JFK SFO Business Trip", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "startDate": { … }, "endDate": { … }, "userId": { … }, "registrarUserId": { … }, "tripMetadata": { … }, "tripDisabledInfo": { … }, "stealthType": "STEALTH_TYPE_1", "stealthMode": { … }, "tripLocations": [ … ] }, "pnrs": [ { … } ], "pendingShellPnrs": [ { … } ], "pendingManualFormPnrs": [ { … } ], "tripStatus": "CONFIRMED", "tripBookingStatus": "PENDING_STATUS", "eventSummary": { "id": "12345", "type": "GENERIC", "name": "My event", "description": "This is an event description", "startDateTime": { … }, "endDateTime": { … }, "location": { … }, "contacts": [ … ], "documents": [ … ], "bookingGuidelines": [ … ], "allowedBookingTypes": [ … ], "eventUserRsvp": { … }, "contactInfoList": [ … ], "companyId": { … }, "runningStatus": "UPCOMING", "status": "DRAFT", "isRemovedParticipant": true, "inviteEmailConfig": { … }, "parentEventId": "56789012", "bookingStyle": "SELF_SERVE", "allowTravelersToRsvp": "ALLOWED" }, "simplePnrs": [ { … } ], "additionalInfo": { "vpayBillBack": "B" }, "tripPaymentInfo": { "totalFare": { … }, "totalFareAmount": { … }, "serviceFeeFareAmount": { … } }, "addManualCreditDisabled": true }
- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v3/trips/{tripId}
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v3/trips/{tripId}
- curl
- JavaScript
- Node.js
- Python
curl -i -X DELETE \
https://api-ext-sboxmeta.partners.spotnana.com/v3/trips/6926658168 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"allowEmptyTripDeletionOnly": false
}'- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v3/trips/{tripId}
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v3/trips/{tripId}
- curl
- JavaScript
- Node.js
- Python
curl -i -X POST \
https://api-ext-sboxmeta.partners.spotnana.com/v3/trips/6926658168 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"tripContacts": [
{
"label": "Coordinator",
"name": "Himani Jain",
"email": "himani@spotnana.com",
"phoneNumber": {
"countryCode": 91,
"countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
"extension": "222",
"isoCountryCode": "IN",
"italianLeadingZero": true,
"nationalNumber": 8150,
"numberOfLeadingZeros": 1,
"preferredDomesticCarrierCode": "7",
"rawInput": "77777",
"type": "MOBILE"
},
"isPrimary": true,
"restrictVisibility": true
}
],
"tripCommunicationPreferences": {
"tripEmailPreferences": {
"bucketEmailPreferences": {
"bucketTypes": [
"BOOKING_CONFIRMATIONS"
],
"isEnabled": false,
"toEmails": [
"example@email.com"
],
"ccEmails": [
"example@email.com"
],
"bccEmails": [
"example@email.com"
]
}
}
}
}'- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v3/trips/users/{userId}/list
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v3/trips/users/{userId}/list
- curl
- JavaScript
- Node.js
- Python
curl -i -X POST \
https://api-ext-sboxmeta.partners.spotnana.com/v3/trips/users/4974a66b-7493-4f41-908c-58ba81093947/list \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"paginationRequestParams": {
"offset": 0,
"limit": 100
},
"includePnrSummaries": true,
"tripFilters": [
{
"filterType": "string",
"userIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
],
"sortOptions": [
{
"sortField": "START_DATE",
"sortOrder": "DESC"
}
]
}'{ "paginationResponseParams": { "totalNumResults": 0 }, "tripSummaries": [ { … } ], "failedTripSummaries": [ { … } ] }
- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v3/trips/companies/{companyId}/list
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v3/trips/companies/{companyId}/list
- curl
- JavaScript
- Node.js
- Python
curl -i -X POST \
https://api-ext-sboxmeta.partners.spotnana.com/v3/trips/companies/4974a66b-7493-4f41-908c-58ba81093947/list \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"paginationRequestParams": {
"offset": 0,
"limit": 100
},
"includePnrSummaries": true,
"tripFilters": [
{
"filterType": "string",
"userIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
],
"sortOptions": [
{
"sortField": "START_DATE",
"sortOrder": "DESC"
}
]
}'{ "paginationResponseParams": { "totalNumResults": 0 }, "tripSummaries": [ { … } ], "failedTripSummaries": [ { … } ] }
- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v3/trips/companies/{companyId}/search
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v3/trips/companies/{companyId}/search
- curl
- JavaScript
- Node.js
- Python
curl -i -X POST \
https://api-ext-sboxmeta.partners.spotnana.com/v3/trips/companies/4974a66b-7493-4f41-908c-58ba81093947/search \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"tripQuery": {
"query": "Trip"
},
"paginationRequestParams": {
"offset": 0,
"limit": 100
},
"tripFilters": [
{
"filterType": "string",
"userIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
],
"sortOptions": [
{
"sortField": "START_DATE",
"sortOrder": "DESC"
}
],
"includePnrSummaries": true
}'{ "paginationResponseParams": { "totalNumResults": 0 }, "tripSummaries": [ { … } ], "disruptedTripsCount": 0, "failedTripSummaries": [ { … } ] }
Request
Retrieves the list of trip summaries for all travelers managed by a specific arranger. This endpoint can be used for arrangers whose role types are COMPANY_TRAVEL_ARRANGER or TRAVEL_ARRANGER.
Pagination parameters for requests.
- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v3/trips/arrangers/{arrangerId}/list
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v3/trips/arrangers/{arrangerId}/list
- curl
- JavaScript
- Node.js
- Python
curl -i -X POST \
https://api-ext-sboxmeta.partners.spotnana.com/v3/trips/arrangers/4974a66b-7493-4f41-908c-58ba81093947/list \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"paginationRequestParams": {
"offset": 0,
"limit": 100
},
"includePnrSummaries": true,
"tripFilters": [
{
"filterType": "string",
"userIds": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
],
"sortOptions": [
{
"sortField": "START_DATE",
"sortOrder": "DESC"
}
]
}'{ "paginationResponseParams": { "totalNumResults": 0 }, "tripSummaries": [ { … } ], "failedTripSummaries": [ { … } ] }
- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v2/trips/{tripId}/booker-email/{bookerEmailId}/partner-info
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v2/trips/{tripId}/booker-email/{bookerEmailId}/partner-info
- curl
- JavaScript
- Node.js
- Python
curl -i -X GET \
'https://api-ext-sboxmeta.partners.spotnana.com/v2/trips/2398199412/booker-email/akanksha@spotnana.com/partner-info?revealReason=Purchase+a+Flight' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "tripId": "6926658168", "partnerInfo": { "partnerInfoType": "BUDGET", "partnerInfoDetails": { … } } }
- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v2/trips/{tripId}
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v2/trips/{tripId}
- curl
- JavaScript
- Node.js
- Python
curl -i -X GET \
https://api-ext-sboxmeta.partners.spotnana.com/v2/trips/2398199412 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "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": [ … ], "tripCommunicationPreferences": { … } }, "tripDisabledInfo": { "disabledReason": "MAX_BOOKINGS_EXCEEDED", "isDisabled": false }, "stealthType": "STEALTH_TYPE_1", "stealthMode": { "stealthType": "STEALTH_TYPE_1", "label": "string" }, "tripLocations": [ { … } ] }
Request
Retrieves the list of trips associated with an organization.
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.
Organization id for traveler.
- Sandbox URLhttps://api-ext-sboxmeta.partners.spotnana.com/v2/list-organisation-trips
- Spotnana mock serverhttps://developer.spotnana.com/_mock/openapi/tripapi/v2/list-organisation-trips
- curl
- JavaScript
- Node.js
- Python
curl -i -X POST \
https://api-ext-sboxmeta.partners.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"
}
]
}'{ "trips": [ { … } ] }