Skip to content

Trip API (v2)

Download OpenAPI description
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/tripapi

Trips

APIs to manage trips.

Operations

PNRs

APIs to manage PNRs within trips.

Operations

Invoicing

APIs to manage invoicing.

Operations

Approval

APIs to manage approvals.

Operations

Trip Notes

Operations

Create a note for agents

Request

Creates a note addressed to the agents assigned for a specific trip. Agent notes are used to communicate trip-related information to agents handling the trip, such as special instructions, updates made on the booking, or any unresolved issues reported by the traveler.

Use this endpoint to:

  • Add a note to a trip so the agents working on it will have all the latest information about the trip.
  • Use the optional pnrId field in the request body to link a note to a specific PNR within a trip.
Security
Bearer
Path
tripIdstringrequired

Trip Id

Example: 6926658168
Bodyapplication/json
pnrIdstring

Pnr ID (optional)

Example: "6789533589"
notestringrequired

Note message

Example: "An agent task has been created."
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/trips/6926658168/agent-notes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pnrId": "6789533589",
    "note": "An agent task has been created."
  }'

Responses

Created

Response
No content

Read all agent notes for a trip

Request

Retrieves all agent notes associated with a specific trip. Each note in the response includes the message, the sender's basic information, and timestamps.

Use this endpoint to:

  • Review the full history of agent notes added to a trip.
  • Identify who created each note and when, using the senderInfo, createdAt, and updatedAt fields.

Note: The response may contain a pnrId if it was added during the note creation. Otherwise, the pnrId field is omitted in the response.

Security
Bearer
Path
tripIdstringrequired

Trip Id

Example: 6926658168
curl -i -X GET \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/trips/6926658168/agent-notes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
agentNotesArray of objects(AgentNote)required

Array of agent notes.

agentNotes[].​noteIdobject(NoteId)required

Note ID.

agentNotes[].​noteId.​idstring(uuid)required

ID

Example: "601e8a5b-3d1d-46bf-9ff6-5441097da8af"
agentNotes[].​pnrIdstring

Pnr ID

Example: "6789533589"
agentNotes[].​notestringrequired

Note message

Example: "An agent task has been created."
agentNotes[].​senderInfoobject(UserBasicInfo)required

Basic user information.

agentNotes[].​senderInfo.​userOrgIdobject(UserOrgId)

User and user's organization information.

agentNotes[].​senderInfo.​personastring(Persona)

Persona of the user

Enum"UNKNOWN_PERSONA""EMPLOYEE""GUEST""PERSONAL""RELATIVE""ADHOC"
agentNotes[].​senderInfo.​emailstring(email)
Example: "example@email.com"
agentNotes[].​senderInfo.​nameobject(Name)

Full name containing first, middle, last (family) names, and suffix.

agentNotes[].​senderInfo.​profilePictureobject(Image)

An image with meta data. Either the data or url property must be supplied to load the image.

agentNotes[].​senderInfo.​tierstring(Tier)

Tier of User. Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP.

Enum"BASIC""SEAT1A"
agentNotes[].​senderInfo.​phoneNumberobject(PhoneNumber)

Properly formatted phone number.

agentNotes[].​senderInfo.​employeeIdstring

Employee id of the user

agentNotes[].​senderInfo.​isActiveboolean

Whether user profile is active or not.

Example: true
agentNotes[].​createdAtobject(DateTimeOffset)required

ISO8601 UTC Date Time

agentNotes[].​createdAt.​iso8601string^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01...required
Example: "2017-07-21T17:32Z"
agentNotes[].​updatedAtobject(DateTimeOffset)required

ISO8601 UTC Date Time

agentNotes[].​updatedAt.​iso8601string^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01...required
Example: "2017-07-21T17:32Z"
Response
application/json
{ "agentNotes": [ {} ] }

Delete an agent note

Request

Deletes an existing agent note from a trip. Once deleted, the note cannot be retrieved later.

Use this endpoint to:

  • Remove an agent note that is no longer relevant or was added by mistake.
Security
Bearer
Path
tripIdstringrequired

Trip Id

Example: 6926658168
noteIdstringrequired

Note Id

Example: fc68b68a-ed0a-4aa3-9099-bc7c1211acf1
curl -i -X DELETE \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/trips/6926658168/agent-notes/fc68b68a-ed0a-4aa3-9099-bc7c1211acf1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

No Content

Response
No content