Search company trips.

Request

This endpoint is used to search trips for a company.

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier for the company whose trip summaries are requested.

Example:4974a66b-7493-4f41-908c-58ba81093947

Bodyapplication/jsonrequired

tripQueryobject(TripQuery)

Query multiple trip fields such as Trip ID, Trip name, PNR ID, etc.

paginationRequestParamsobject(OffsetBasedPaginationRequestParams)required

Pagination parameters for requests.

tripFiltersArray of objects(SearchTripFilters)

Filter for the list trip summary request.

sortOptionsArray of objects(SearchTripSortOptions)

Sort options for the list trip summary request.

includePnrSummariesboolean

Boolean flag to include PNR summaries in the response

Example:true

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": "TRIP_USER_ID_FILTER",
        "userIds": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          }
        ]
      }
    ],
    "sortOptions": [
      {
        "sortField": "START_DATE",
        "sortOrder": "DESC"
      }
    ],
    "includePnrSummaries": true
  }'

Responses

OK

Bodyapplication/json

paginationResponseParamsobject(PaginationResponseParams)required

Pagination parameters for response.

tripSummariesArray of objects(TripSummary)

List of Trip summaries.

disruptedTripsCountinteger, (int64)

Total count of upcoming disrupted trips for the company.

failedTripSummariesArray of objects(TripSummary)

List of failed Trip summaries.

Response

{
  "paginationResponseParams": {
    "totalNumResults": 0
  },
  "tripSummaries": [
    { … }
  ],
  "disruptedTripsCount": 0,
  "failedTripSummaries": [
    { … }
  ]
}