Pull API Documentation

With the Pull AXUS API, registered partners can export itineraries. The following documentation will detail how to register for an API key, create a successful response, and view an expected response.

Client ID

To register for a Client ID, contact us at support@axustravelapp.com. You will be given a Client ID that should be sent in a header when making the API request.

ClientId:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Basic Authentication

Currently, all API requests are authorized using basic authentication. The username and password must match a current travel advisor's account in AXUS which has been authorized to use the pull on behalf of the organization.

JSON Format

Our JSON format is modeled off of the work done by schema.org and Google Schemas. While they don't currently support every booking type that AXUS does, we have done our best to use their conventions.

Request URLs

Send a GET request with the appropriate headers to retrieve a time limited token. With that time limited token as a param, send GET request with appropriate headers and and any optional params to our push endpoints.

Headers

clientIdXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
AuthorizationBasic XXXXXXXXxXXXxXXxxxXXXXXXXxXxxXxxXXXxXXX=

Headers are included in every GET request

GET Token

Returns a temporary token for use in further Pull AXUS API requests

https://axustravelapp.com/api/v1/pull/token

Example Request

curl --location --request GET "http://axustravelapp.com/api/v1/pull/token" --header "clientId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --header "Authorization: Basic XXXXXXXXxXXXxXXxxxXXXXXXXxXxxXxxXXXxXXX="

Example Response

{
  "errors":[],
  "token":"a262e628-9fc2-484e-8358-710e6f8b4f2c"
}

GET Itineraries

Returns all itineraries associated with clientId and an optional date range. The optional created-at-start and created-at-end can be used with any of the itineraries calls along with advisorId and travelerId

http://axustravelapp.com/api/v1/pull/itineraries?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&created-at-start=2024-10-22&created-at-end=2025-02-11

Params

tokena262e628-9fc2-484e-8358-710e6f8b4f2c
created-at-start2024-10-22
created-at-end2025-02-11

Example Request

curl --location --request GET "http://axustravelapp.com/api/v1/pull/itineraries?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&created-at-start=2024-10-22&created-at-end=2025-02-11" --header "clientId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --header "Authorization: Basic XXXXXXXXxXXXxXXxxxXXXXXXXxXxxXxxXXXxXXX="

Example Response

{
  "errors":[],
  "itineraries":
  [
    {
      "guid":"3418dad3-2508-4b9c-90ba-a113d066c4cd",
      "createdAt":"2018-12-03T18:17:02.820Z",
      "name":"Chicago in Winter",
      "itineraryId":8916,
      "updatedAt":"2019-01-08T22:57:28.868Z"
    },
    {
      "guid":"7e00c343-0558-42ab-a1b3-dc755ba1b60a",
      "createdAt":"2018-12-13T13:45:34.410Z",
      "name":"The Best of Ethiopia",
      "itineraryId":8923,
      "updatedAt":"2018-12-13T13:45:36.720Z"
    },
   {
     "guid":"86e17a4d-7136-415e-9fec-59b35268fa1d",
      "createdAt":"2018-11-05T20:19:42.622Z",
      "name":"New York Weekend",
      "itineraryId":8896,
      "updatedAt":"2018-11-05T20:19:42.662Z"
   },
   {
     "guid":"412e4a56-95ba-49a5-a89a-a72cc9b786f9",
      "createdAt":"2018-11-05T20:14:31.296Z",
      "name":"Family Reunion in St. John",
      "itineraryId":8895,
      "updatedAt":"2019-01-08T22:29:05.165Z"
   }
  ]
}

GET Itineraries advisorId

Returns itineraries for a particular advisor by the advisorId

http://axustravelapp.com/api/v1/pull/itineraries?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&advisorId=486

Params

tokena262e628-9fc2-484e-8358-710e6f8b4f2c
advisorId486

Example Request

curl --location --request GET "http://axustravelapp.com/api/v1/pull/itineraries?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&advisorId=486" --header "clientId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --header "Authorization: Basic XXXXXXXXxXXXxXXxxxXXXXXXXxXxxXxxXXXxXXX="

Example Response

{
  "errors":[],
  "itineraries":
  [
    {
      "guid":"3418dad3-2508-4b9c-90ba-a113d066c4cd",
      "createdAt":"2018-12-03T18:17:02.820Z",
      "name":"Chicago in Winter",
      "itineraryId":8916,
      "updatedAt":"2019-01-08T22:57:28.868Z"
    },
    {
      "guid":"412e4a56-95ba-49a5-a89a-a72cc9b786f9",
      "createdAt":"2018-11-05T20:14:31.296Z",
      "name":"Family Reunion in St. John",
      "itineraryId":8895,
      "updatedAt":"2019-01-08T22:29:05.165Z"
    }
  ]
}

GET Itineraries travelerId

Returns itineraries for a particular traveler by the travelerId

http://axustravelapp.com/api/v1/pull/itineraries?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&travelerId=352

Params

tokena262e628-9fc2-484e-8358-710e6f8b4f2c
travelerId352

Example Request

curl --location --request GET "http://axustravelapp.com/api/v1/pull/itineraries?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&travelerId=352" --header "clientId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --header "Authorization: Basic XXXXXXXXxXXXxXXxxxXXXXXXXxXxxXxxXXXxXXX="

Example Response

{
  "errors":[],
  "itineraries":
  [
    {
      "guid":"3418dad3-2508-4b9c-90ba-a113d066c4cd",
      "createdAt":"2018-12-03T18:17:02.820Z",
      "name":"Chicago in Winter",
      "itineraryId":8916,
      "updatedAt":"2019-01-08T22:57:28.868Z"
    }
  ]
}

GET Itineraries advisorId travelerId

Returns itineraries for a particular advisor and traveler by the advisorId and travelerId

http://axustravelapp.com/api/v1/pull/itineraries?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&advisorId=486&travelerId=352

Params

tokena262e628-9fc2-484e-8358-710e6f8b4f2c
adivosrId486
travelerId352

Example Request

curl --location --request GET "http://axustravelapp.com/api/v1/pull/itineraries?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&advisorId=100%travelerId=352" --header "clientId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --header "Authorization: Basic XXXXXXXXxXXXxXXxxxXXXXXXXxXxxXxxXXXxXXX="

Example Response

{
  "errors":[],
  "itineraries":
  [
    {
      "guid":"3418dad3-2508-4b9c-90ba-a113d066c4cd",
      "createdAt":"2018-12-03T18:17:02.820Z",
      "name":"Chicago in Winter",
      "itineraryId":8916,
      "updatedAt":"2019-01-08T22:57:28.868Z"
    }
  ]
}

GET Itinerary

Returns itinerary detail by itineraryId

http://axustravelapp.com/api/v1/pull/itinerary?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&itineraryId=8916

Params

tokena262e628-9fc2-484e-8358-710e6f8b4f2c
itineraryId8916

Example Request

curl --location --request GET "http://axustravelapp.com/api/v1/pull/itinerary?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&itineraryId=8916" --header "clientId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --header "Authorization: Basic XXXXXXXXxXXXxXXxxxXXXXXXXxXxxXxxXXXxXXX="

Example Response

{
    "errors": [],
    "itinerary": {
        "bookings": [
            {
                "paymentDescription": "Paid in Full",
                "lastReviewedBy": "Sandy Smith",
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "daySortSlot": 0,
                "lastReviewedByDate": "2013-05-01",
                "reservationFor": {
                    "url": "http://www.example.com",
                    "telephone": "415-771-1400",
                    "address": {
                        "@type": "PostalAddress",
                        "fullAddress": "476 Village Run Cir\nSnowmass Village, CO 81615\nUS"
                    },
                    "name": "Bills Delivery Service",
                    "@type": "LocalBusiness"
                },
                "reservationId": "448725",
                "internalNotes": "Notes...",
                "@context": "http://schema.org",
                "reservationNumber": "735324",
                "cancellationPolicy": "24 Hours for 80% refund",
                "additionalText": "<p>Notes for the traveler ...</p>",
                "image": "http://example.com/image.png",
                "vehicle": "Box Van",
                "collaboratorNotes": "Notes for Collaborators...",
                "@type": "OtherTransportation",
                "price": "$10",
                "supplierConfirmationStatus": "confirmed"
            },
            {
                "paymentDescription": "Paid in Full",
                "lastReviewedBy": "Sandy Smith",
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "daySortSlot": 0,
                "lastReviewedByDate": "2021-05-01",
                "reservationFor": {
                    "url": "http://www.example.com",
                    "telephone": "415-771-1400",
                    "address": {
                        "@type": "PostalAddress",
                        "fullAddress": "45 Village Run Cir\nSnowmass Village, CO 81615\nUS"
                    },
                    "name": "Bills Limo",
                    "@type": "LocalBusiness"
                },
                "pickupTime": "2022-01-09T16:00:00.000Z",
                "reservationId": "44242567",
                "internalNotes": "Notes...",
                "@context": "http://schema.org",
                "reservationNumber": "546324",
                "serviceProvider": "Bills Limo",
                "pickupLocation": {
                    "name": "Hertz San Diego Airport",
                    "@type": "Place"
                },
                "numAdults": "2",
                "cancellationPolicy": "24 Hours for 80% refund",
                "additionalText": "<p>Notes for the traveler ...</p>",
                "image": "http://example.com/image.png",
                "vehicle": "Black Towncar",
                "collaboratorNotes": "Notes for Collaborators...",
                "@type": "TransferReservation",
                "dropoffLocation": {
                    "name": "Hertz LAX",
                    "@type": "Place"
                },
                "dropoffTime": "2022-01-09",
                "price": "$10",
                "supplierConfirmationStatus": "confirmed"
            },
            {
                "lastReviewedBy": "Sandy Smith",
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "daySortSlot": 0,
                "lastReviewedByDate": "2021-05-01",
                "reservationFor": {
                    "departureTime": "2022-01-08T10:30:00.000Z",
                    "arrivalTime": "2022-01-08T16:10:00.000Z",
                    "trainName": "Orient Express",
                    "arrivalStation": {
                        "@type": "TrainStation",
                        "name": "Paris Gare De Lyon"
                    },
                    "trainNumber": "9203",
                    "trainCode": "iGTV",
                    "@type": "TrainTrip",
                    "departureStation": {
                        "@type": "TrainStation",
                        "name": "Munich Central"
                    },
                    "trainCompany": {
                        "@type": "Organization"
                    }
                },
                "reservationId": "556677",
                "internalNotes": "Notes...",
                "@context": "http://schema.org",
                "reservationNumber": "AB3XY2",
                "bookingTime": "2024-02-22T17:25:43.584Z",
                "cancellationPolicy": "24 Hours",
                "reservedTicket": {
                    "@type": "Ticket",
                    "additionalTicketText": "27A",
                    "underName": {
                        "@type": "Person",
                        "name": "Mary Smith"
                    },
                    "ticketedSeat": {
                        "@type": "Seat",
                        "seatingType": "1st Class"
                    }
                },
                "additionalText": "<p>?</p>",
                "image": "http://example.com/image.png",
                "collaboratorNotes": "Notes for Collaborators...",
                "@type": "TrainReservation",
                "price": "$10",
                "supplierConfirmationStatus": "confirmed"
            },
            {
                "lastReviewedBy": "Sandy Smith",
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "daySortSlot": 0,
                "tourDescription": "<p>A 3 hour walking tour ...</p>",
                "lastReviewedByDate": "2021-05-01",
                "reservationFor": {
                    "url": "http://www.example.com",
                    "telephone": "415-555-5555",
                    "address": {
                        "@type": "PostalAddress",
                        "fullAddress": "45 Village Run Cir\nSnowmass Village, CO 81615\nUS"
                    },
                    "name": "Nancy Drew",
                    "@type": "LocalBusiness"
                },
                "reservationId": "442321",
                "name": "Aspen Snow Tour",
                "internalNotes": "Notes...",
                "@context": "http://schema.org",
                "reservationNumber": "abc456",
                "startDate": "2022-01-07T16:00:00.000Z",
                "meetingPoint": "Town Square",
                "endDate": "2022-01-07T11:00:00.000Z",
                "cancellationPolicy": "24 Hours",
                "confirmedBy": {
                    "@type": "Person",
                    "name": "Nancy Drew"
                },
                "additionalText": "<p>Notes go here</p>",
                "image": "http://example.com/image.png",
                "collaboratorNotes": "Notes for Collaborators...",
                "@type": "TourReservation",
                "price": "$10",
                "supplierConfirmationStatus": "confirmed"
            },
            {
                "paymentDescription": "Paid in Full",
                "lastReviewedBy": "Sandy Lu",
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "daySortSlot": 0,
                "lastReviewedByDate": "2021-05-01",
                "reservationFor": {
                    "url": "http://www.example.com",
                    "telephone": "415-555-1212",
                    "address": {
                        "@type": "PostalAddress",
                        "fullAddress": "215 WI-42\nEllison Bay, WI 54210\nUS"
                    },
                    "name": "Washington Island Ferry",
                    "@type": "LocalBusiness"
                },
                "reservationId": "442425",
                "internalNotes": "Notes...",
                "@context": "http://schema.org",
                "reservationNumber": "546324",
                "cancellationPolicy": "24 Hours for 80% refund",
                "additionalText": "<p>Notes for the traveler ...</p>",
                "image": "http://example.com/image.png",
                "collaboratorNotes": "Notes for Collaborators...",
                "@type": "FerryReservation",
                "price": "$10",
                "supplierConfirmationStatus": "confirmed"
            },
            {
                "paymentDescription": "Paid in Full",
                "lastReviewedBy": "Sandy Smith",
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "daySortSlot": 0,
                "underName": {
                    "@type": "Person",
                    "name": "John Smith"
                },
                "lastReviewedByDate": "2021-05-01",
                "reservationFor": {
                    "telephone": "+1-800-123-4567",
                    "address": {
                        "@type": "PostalAddress",
                        "fullAddress": "1500 Orange Avenue"
                    },
                    "name": "Hertz",
                    "@type": "LocalBusiness"
                },
                "pickupTime": "2022-01-02T16:00:00.000Z",
                "reservationId": "442211",
                "internalNotes": "Notes...",
                "@context": "http://schema.org",
                "reservationNumber": "546323",
                "pickupLocation": {
                    "telephone": "+1-800-123-4567",
                    "address": {
                        "@type": "PostalAddress",
                        "fullAddress": "1500 Orange Avenue"
                    },
                    "name": "Hertz San Diego Airport",
                    "@type": "Place"
                },
                "cancellationPolicy": "24 Hours for 80% refund",
                "additionalText": "<p>Notes for the traveler ...</p>",
                "image": "http://example.com/image.png",
                "vehicle": "Economy Class Car",
                "collaboratorNotes": "Notes for Collaborators...",
                "@type": "RentalCarReservation",
                "dropoffLocation": {
                    "telephone": "+1-800-123-4567",
                    "address": {
                        "@type": "PostalAddress",
                        "fullAddress": "1234 First Street"
                    },
                    "name": "Hertz LAX",
                    "@type": "Place"
                },
                "dropoffTime": "2022-01-03T20:00:00.000Z",
                "price": "$10",
                "supplierConfirmationStatus": "confirmed"
            },
            {
                "lastReviewedBy": "Sandy Smith",
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "daySortSlot": 0,
                "lastReviewedByDate": "2022-01-01",
                "reservationFor": {
                    "url": "http://www.example.com",
                    "telephone": "415-771-1400",
                    "address": {
                        "@type": "PostalAddress",
                        "fullAddress": "333 O'Farrell St\nSan Francisco, CA 94102\nUS"
                    },
                    "name": "Generic Reservation Title",
                    "@type": "LodgingBusiness"
                },
                "reservationId": "442321",
                "internalNotes": "Notes...",
                "@context": "http://schema.org",
                "startDate": "2022-01-05T11:00:00.000Z",
                "priorityLevel": "high",
                "additionalText": "<p>Notes for the traveler ...</p>",
                "image": "http://example.com/image.png",
                "collaboratorNotes": "Notes for Collaborators...",
                "@type": "Reservation",
                "price": "$10",
                "supplierConfirmationStatus": "confirmed"
            },
            {
                "rooms": [
                    {
                        "numGuests": 2,
                        "lodgingUnitDescription": "Bay View with balcony ...",
                        "priceCurrency": "USD",
                        "underName": {
                            "@type": "Person",
                            "name": "John Smith"
                        },
                        "beddingDescription": "Double Queen",
                        "totalPrice": 100,
                        "reservationNumber": "abc456",
                        "internalReference": "Internal Reference",
                        "additionalText": "Notes about room ...",
                        "roomCategory": "Deluxe"
                    },
                    {
                        "numGuests": 2,
                        "lodgingUnitDescription": "Bay View with balcony ...",
                        "priceCurrency": "USD",
                        "underName": {
                            "@type": "Person",
                            "name": "John Smith"
                        },
                        "beddingDescription": "King",
                        "totalPrice": 200,
                        "reservationNumber": "abc457",
                        "internalReference": "Internal Reference",
                        "additionalText": "Notes about room ...",
                        "roomCategory": "Deluxe"
                    }
                ],
                "paymentDescription": "Paid in Full",
                "lastReviewedBy": "Sandy Smith",
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "lodgingUnitDescription": "Bay View",
                "checkoutDate": "2022-01-06T11:00:00.000Z",
                "daySortSlot": 0,
                "checkinDate": "2022-01-04T16:00:00.000Z",
                "underName": {
                    "@type": "Person",
                    "name": "John Smith"
                },
                "beddingDescription": "Double Queen",
                "lastReviewedByDate": "2021-05-01",
                "reservationFor": {
                    "url": "http://www.example.com",
                    "telephone": "415-771-1400",
                    "address": {
                        "@type": "PostalAddress",
                        "fullAddress": "333 O'Farrell St\nSan Francisco, CA 94102\nUS"
                    },
                    "name": "Hilton San Francisco Union Square",
                    "@type": "LodgingBusiness"
                },
                "reservationId": "442321",
                "internalNotes": "Notes...",
                "@context": "http://schema.org",
                "reservationNumber": "abc456",
                "numAdults": 2,
                "cancellationPolicy": "24 Hours for 80% refund",
                "url": "http://example.com/ExpandedHotelProfile.html",
                "additionalText": "<p>Notes for the traveler ...</p>",
                "amenities": "<p>Complementary Breakfast</p><p>Free Wifi</p>",
                "image": "http://example.com/image.png",
                "collaboratorNotes": "Notes for Collaborators...",
                "nightsStayed": 2,
                "@type": "LodgingReservation",
                "price": "$10",
                "guestName": "John Smith",
                "lodgingDescription": "<p>Description of lodging ...</p>",
                "supplierConfirmationStatus": "confirmed"
            },
            {
                "lastReviewedBy": "Sandy Smith",
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "daySortSlot": 0,
                "lastReviewedByDate": "2021-05-01",
                "reservationFor": {
                    "policyType": "Standard",
                    "company": {
                        "@type": "LocalBusiness",
                        "name": "Travelex",
                        "telephone": "415-555-5555",
                        "url": "http://www.example.com"
                    },
                    "name": "Gold Travel Plan",
                    "@type": "LocalBusiness"
                },
                "reservationId": "442321",
                "name": "Travel Insurance by Travelex",
                "internalNotes": "Notes...",
                "@context": "http://schema.org",
                "reservationNumber": "abc456",
                "effectiveDate": "2017-04-10",
                "additionalText": "<p>Notes go here</p>",
                "image": "http://example.com/image.png",
                "@type": "InsuranceReservation",
                "price": "$10",
                "supplierConfirmationStatus": "confirmed"
            },
            {
                "passengers": [
                    {
                        "@type": "Person",
                        "name": "Eva Green",
                        "ticketNumber": "123XYZ",
                        "airplaneSeat": "9A",
                        "airplaneSeatClass": {
                            "@type": "AirplaneSeatClass",
                            "name": "Business"
                        },
                        "programMembership": {
                            "@type": "ProgramMembership",
                            "memberNumber": "4BY123111"
                        }
                    }
                ],
                "lastReviewedBy": "Sandy Smith",
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "daySortSlot": 0,
                "lastReviewedByDate": "2021-05-01",
                "reservationFor": {
                    "operatedBy": {
                        "@type": "Airline",
                        "name": "United"
                    },
                    "airline": {
                        "@type": "Airline",
                        "name": "United",
                        "iataCode": "UA",
                        "telephone": "(800) 555-5555"
                    },
                    "departureTime": "2022-01-03T20:15:00.000Z",
                    "arrivalTime": "2022-01-03T06:03:00.000Z",
                    "arrivalTerminal": "A",
                    "arrivalAirport": {
                        "@type": "Airport",
                        "name": "New York",
                        "iataCode": "JFK",
                        "address": {
                            "@type": "PostalAddress",
                            "addressLocality": "New York"
                        }
                    },
                    "flightNumber": "110",
                    "departureAirport": {
                        "@type": "Airport",
                        "name": "San Francisco",
                        "iataCode": "SFO",
                        "address": {
                            "@type": "PostalAddress",
                            "addressLocality": "San Francisco"
                        }
                    },
                    "departureTerminal": "B",
                    "@type": "Flight"
                },
                "reservationId": "55231",
                "internalNotes": "Notes...",
                "@context": "http://schema.org",
                "reservationNumber": "RXJ34P",
                "duration": "8 hr,20 mins",
                "additionalTicketText": "<p>Some ticket details, terms and conditions...</p>",
                "checkinUrl": "http://united.com/onlinecheckin.html",
                "image": "http://example.com/image.png",
                "collaboratorNotes": "Notes for Collaborators...",
                "@type": "FlightReservation",
                "price": "$10",
                "supplierConfirmationStatus": "confirmed"
            },
            {
                "paymentDescription": "Paid in Full",
                "lastReviewedBy": "Sandy Smith",
                "portsOfCall": [
                    {
                        "@type": "SeaPort",
                        "name": "Anchorage",
                        "arrivalDate": "2022-01-12T10:00:00.000Z"
                    },
                    {
                        "@type": "SeaPort",
                        "name": "Vancouver",
                        "departureDate": "2022-01-10T10:00:00.000Z"
                    },
                    {
                        "@type": "SeaPort",
                        "name": "Akron",
                        "image": "http://example.com/image.png",
                        "daySortSlot": 1,
                        "arrivalDate": "2022-01-11T10:00:00.000Z",
                        "departureDate": "2022-01-11T16:00:00.000Z",
                        "additionalText": "<p>Notes...</p>"
                    }
                ],
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "daySortSlot": 0,
                "underName": {
                    "@type": "Person",
                    "name": "John Smith"
                },
                "beddingDescription": "Double Queen",
                "lastReviewedByDate": "2013-05-01",
                "reservationFor": {
                    "telephone": "415-771-1400",
                    "name": "Princess Cruises",
                    "@type": "CruiseBusiness"
                },
                "reservationId": "442321",
                "name": "Inside Passage Cruise",
                "@context": "http://schema.org",
                "reservationNumber": "abc456",
                "ship": {
                    "@type": "CruiseShip",
                    "name": "Concordia"
                },
                "numAdults": 2,
                "cabinCategory": "Balcony",
                "cancellationPolicy": "24 Hours for 80% refund",
                "additionalText": "<p>Notes for the traveler ...</p>",
                "image": "http://example.com/image.png",
                "cabin": [
                    {
                        "underName": {
                            "@type": "Person",
                            "name": "John Smith"
                        },
                        "cabinCategory": "Balcony",
                        "internalReference": "Internal Reference",
                        "cabinNumber": "1253",
                        "confirmationNumber": "abc456",
                        "numberOfGuests": 2,
                        "bedding": "Double Queen"
                    }
                ],
                "@type": "CruiseReservation",
                "supplierConfirmationStatus": "confirmed",
                "cabinNumber": "1253"
            },
            {
                "conciergeDescription": "<p>Describe concierge service ...</p>",
                "paymentDescription": "Paid in Full",
                "lastReviewedBy": "Sandy Smith",
                "salability": "level 1",
                "modifiedTime": "2024-02-22T17:25:43.584Z",
                "daySortSlot": 0,
                "underName": {
                    "@type": "Person",
                    "name": "John Smith"
                },
                "lastReviewedByDate": "2013-05-01",
                "reservationFor": {
                    "url": "http://www.example.com",
                    "telephone": "415-771-1400",
                    "address": {
                        "@type": "PostalAddress",
                        "fullAddress": "45 Village Run Cir\nSnowmass Village, CO 81615\nUS"
                    },
                    "name": "Aspen Snowmass",
                    "@type": "LocalBusiness"
                },
                "reservationId": "442321",
                "internalNotes": "Notes...",
                "@context": "http://schema.org",
                "reservationNumber": "abc456",
                "serviceProvider": "Aspen Snowmass",
                "startDate": "2022-01-01T16:00:00.000Z",
                "serviceType": "4 of 5 day Lift Ticket",
                "endDate": "2022-01-01T11:00:00.000Z",
                "cancellationPolicy": "24 Hours for 80% refund",
                "confirmedBy": {
                    "@type": "Person",
                    "name": "Nancy Drew"
                },
                "additionalText": "<p>Pick up tickets at ...</p>",
                "image": "http://example.com/image.png",
                "collaboratorNotes": "Notes for Collaborators...",
                "@type": "ConciergeReservation",
                "confirmedFor": "John Smith",
                "price": "$10",
                "supplierConfirmationStatus": "confirmed"
            }
        ],
        "travelers": [
            {
                "email": "tanya@example.com",
                "telephone": "333-333-3333",
                "name": "Tanya Traveler",
                "travelerCrm": "123",
                "@context": "http://schema.org",
                "travelerId": 27171,
                "firstName": "Tanya",
                "lastName": "Traveler",
                "@type": "Person"
            },
            {
                "email": "tim@example.com",
                "telephone": "444-333-3333",
                "name": "Tim Traveler",
                "travelerCrm": "456",
                "@context": "http://schema.org",
                "travelerId": 21504,
                "firstName": "Tim",
                "lastName": "Traveler",
                "@type": "Person"
            }
        ],
        "internalNotes": "Notes...",
        "startDate": "2022-01-01",
        "title": "Excellent Adventure",
        "endDate": "2022-01-12",
        "collaborators": [
            {
                "name": "Tommy Operator",
                "email": "username@example.com"
            },
            {
                "name": "Suzy Agent",
                "email": "suzy@example.com"
            }
        ],
        "status": "In Progress",
        "id": "11234891",
        "misc": "misc",
        "itineraryFor": "John Doe",
        "collaboratorNotes": "Notes for Collaborators...",
        "price": "$100",
        "guid": "bd6010ab-00c7-47be-85dd-bf16d135b894"
    }
}

GET Advisors

Returns all advisors associated with clientId

http://axustravelapp.com/api/v1/pull/advisors?token=a262e628-9fc2-484e-8358-710e6f8b4f2c

Params

tokena262e628-9fc2-484e-8358-710e6f8b4f2c

Example Request

curl --location --request GET "http://axustravelapp.com/api/v1/pull/advisors?token=a262e628-9fc2-484e-8358-710e6f8b4f2c" --header "clientId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --header "Authorization: Basic XXXXXXXXxXXXxXXxxxXXXXXXXxXxxXxxXXXxXXX="

Example Response

{
  "errors":[],
  "advisors":
  [
    {
      "advisorId":486
    },
    {
      "advisorId":487
    }
  ]
}

GET Advisor advisorId

Returns advisor detail by advisorId

http://axustravelapp.com/api/v1/pull/advisor?token=a262e628-9fc2-484e-8358-710e6f8b4f2c?advisorId=486

Params

tokena262e628-9fc2-484e-8358-710e6f8b4f2c
advisorId486

Example Request

curl --location --request GET "http://axustravelapp.com/api/v1/pull/advisor?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&advisorId=486" --header "clientId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --header "Authorization: Basic XXXXXXXXxXXXxXXxxxXXXXXXXxXxxXxxXXXxXXX="

Example Response

{
  "errors":[],
  "advisor":
  {
    "@context":"http://schema.org",
    "@type":"Person",
    "name":"Amy Smith",
    "advisorId":486,
    "email":"amysmith@test.com"
  }
}

GET Travelers

Returns all travelers associated with clientId

http://axustravelapp.com/api/v1/pull/travelers?token=a262e628-9fc2-484e-8358-710e6f8b4f2c

Params

tokena262e628-9fc2-484e-8358-710e6f8b4f2c

Example Request

curl --location --request GET "http://axustravelapp.com/api/v1/pull/travelers?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&advisorId=486" --header "clientId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --header "Authorization: Basic XXXXXXXXxXXXxXXxxxXXXXXXXxXxxXxxXXXxXXX="

Example Response

{
  "errors":[],
  "travelers":
  [
    {"travelerId":351},
    {"travelerId":352},
    {"travelerId":353}
  ]
}

GET Traveler travelerId

Returns traveler detail by travelerId

http://axustravelapp.com/api/v1/pull/traveler?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&travelerId=352

Params

tokena262e628-9fc2-484e-8358-710e6f8b4f2c
travelerId352

Example Request

curl --location --request GET "http://axustravelapp.com/api/v1/pull/traveler?token=a262e628-9fc2-484e-8358-710e6f8b4f2c&travelerId=352" --header "clientId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --header "Authorization: Basic XXXXXXXXxXXXxXXxxxXXXXXXXxXxxXxxXXXxXXX="

Example Response

{
  "errors":[],
  "traveler":
  {
    "@context":"http://schema.org",
    "@type":"Person",
    "name":"John Johnson",
    "travelerCrm":"abc123",
    "firstName":"John",
    "travelerId":352,
    "email": "john@example.com",
    "lastName":"Johnson"
  }
}