Skip to main content
POST
Send reservation (sendTrip)
The differences between NEW and UPDATE reservations are:
  1. affiliateReservation.action is set to NEW or UPDATE.
  2. A transactionId must be supplied with every UPDATE payload. NEW reservations leave this field blank.
  3. If submitMode = "WAIT", the API call is synchronous and the response time is longer. A transactionId is always provided; when submitMode = "WAIT", a reservationId is also provided.
This is an asynchronous service call by default. The response can be a valid Transaction ID or an error caught by the rules engine; other responses are provided via a webhook callback at a later time. For NEW, the action is NEW and the status begins at BOOKING_REQUEST.

Payload field reference

See the Object Model for a complete, field-by-field description of the reservation payload.

Authorizations

token
string
header
required

Security token obtained from getToken2.

Path Parameters

version
enum<string>
required

API version. Must be set to V1.

Available options:
V1

Body

application/json

The GNet reservation payload. See the Object Model reference for full field-by-field documentation. Dates/times in location sections are local to the pickup location, format YYYY-MM-DDTHH:mm:ss.

affiliateReservation
object
required

Header section of the payload: GNet member IDs of the sender and receiver, their reservation numbers, and the command field.

locations
object
required
passengerCount
string
required

Number of passengers.

Example:

"1"

passengers
object[]
required
preferredVehicleType
string
required

Requested vehicle type. See the Vehicle Types reference.

Example:

"SEDAN"

reservationType
enum<string>
required

Reservation type. QUOTE requests return pricing without creating a reservation.

Available options:
REGULAR,
ONDEMAND,
QUOTE
preferredChauffeurNo
string

ID of preferred chauffeur.

runType
enum<string>

Run type.

Available options:
TRANSPORT,
AIRPORT,
HOURLY
status
string

Status code of the reservation.

Example:

"BOOKING_REQUEST"

reservationDate
string

Date the reservation was created, local time, YYYY-MM-DDTHH:mm:ss.

specialInstructions
string

Trip notes and instructions.

totalAmount
string

Estimated total cost of trip.

totalTripDuration
string

Trip duration in minutes. For hourly trips, the estimated minutes.

totalTripDist
string

Total trip distance.

namesignInstructions
string

Name sign instructions.

namesignURL
string

URL for the name sign.

luggageCount
string

Number of pieces of luggage.

meetAndGreet
string

Meet and greet instructions.

operatorId
string

Operator ID.

origination
string

Trip origination code or identifier.

submissionTarget
string

Target for submission.

transactionId
string

Required when updating a reservation. Leave blank for NEW reservations.

submitMode
string

Set to WAIT to process synchronously and wait for the result. Leave blank otherwise.

Example:

"WAIT"

fees
object[]

Charge line items.

notes
object[]

Affiliate notes.

account
object

Account information of the SENDER in the RECEIVER system.

Response

Submission accepted

transactionId
string

Unique Transaction ID within the GRiDD Platform.

Example:

"4b15e13d-419f-4903-8c24-70445bd97c87"

reservationId
string

Provider reservation ID. Provided when submitMode = WAIT.

Example:

"10122"

fees
object[]
totalAmount
string
Example:

"218.23"