Documentation Index
Fetch the complete documentation index at: https://docs.grdd.dev/llms.txt
Use this file to discover all available pages before exploring further.
The complete reservation payload object model. Dates and times in location sections are local to the pickup location and contain no timezone, in the format YYYY-MM-DDTHH:mm:ss.
affiliateReservation
| Field | Required | Description | Type |
|---|
affiliateReservation.action | Yes | NEW, UPDATE, or CANCEL. | string |
affiliateReservation.requesterId | Yes | GRiDD ID of requester. | string |
affiliateReservation.providerId | Yes | GRiDD ID of provider. | string |
affiliateReservation.requesterResNo | Yes | Reservation number of requester. | string |
affiliateReservation.providerResNo | No | Reservation number of provider. Fills in once a reservation is successfully submitted. | string |
affiliateReservation.status | No | Status code of reservation. On a communication error, this is set to FAILED. | string |
locations.pickup
| Field | Required | Description | Type |
|---|
locations.pickup.time | Yes | Local time for pickup address. Based on local time of the pickup location. | YYYY-MM-DDTHH:mm:ss |
locations.pickup.locationType | Yes | ADDRESS or AIRPORT. | string |
locations.pickup.FBO | No | True or blank. | string |
locations.pickup.landmark | No | Landmark name for pickup address. | string |
locations.pickup.address | Yes | For airport trips, the airport CODE goes into the address field. | string |
locations.pickup.address1 | Yes | Street address of pickup. | string |
locations.pickup.address2 | Yes | Street address 2 of pickup. | string |
locations.pickup.city | Yes | City. | string |
locations.pickup.state | Yes | State. | string |
locations.pickup.zipCode | Yes | Zip / Postal Code. | string |
locations.pickup.country | Yes | Country. | string |
locations.pickup.specialInstructions | No | Pickup notes and instructions. | string |
locations.pickup.flightInfo | Yes | Flight information. Only required for an airport trip. | object |
locations.pickup.flightInfo.flightNumber | No | Flight number. | string |
locations.pickup.flightInfo.airlineCode | No | 2-character IATA airline code. | string |
locations.dropOff
| Field | Required | Description | Type |
|---|
locations.dropOff.locationType | Yes | ADDRESS or AIRPORT. | string |
locations.dropOff.FBO | No | True or blank. | string |
locations.dropOff.landmark | No | Landmark name for address. | string |
locations.dropOff.address1 | Yes | Street address of drop off. | string |
locations.dropOff.address2 | No | Street address 2 of drop off. | string |
locations.dropOff.city | Yes | City. | string |
locations.dropOff.state | Yes | State. | string |
locations.dropOff.zipCode | Yes | Zip / Postal Code. | string |
locations.dropOff.country | Yes | Country. | string |
locations.dropOff.specialInstructions | No | Drop off notes and instructions. | string |
locations.dropOff.flightInfo | Yes | Flight information. Only required for an airport trip. | object |
locations.dropOff.flightInfo.flightNumber | No | Flight number. | string |
locations.dropOff.flightInfo.airlineCode | No | 2-character IATA airline code. | string |
passengers
| Field | Required | Description | Type |
|---|
passengerCount | Yes | Number of passengers. | string |
passengers.email | No | Passenger email. | string |
passengers.firstName | Yes | Passenger’s first name. | string |
passengers.lastName | Yes | Passenger’s last name. | string |
passengers.alias | No | Passenger’s alias name. | string |
passengers.phones | Yes | Array of phone numbers for passenger. | object |
passengers.phones.number | Yes | Passenger phone number. | string |
passengers.phones.type | Yes | mobile or landline. | string |
Trip details
| Field | Required | Description | Type |
|---|
preferredVehicleType | Yes | Requested vehicle type. See Vehicle Types. | string |
reservationType | Yes | REGULAR, ONDEMAND, or QUOTE. | string |
runType | No | TRANSPORT, AIRPORT, or HOURLY. | string |
totalAmount | No | Estimated total cost of trip. | string |
specialInstructions | No | Trip notes and instructions. | string |
totalTripDuration | No | Trip duration in minutes. For an hourly trip, set the estimated minutes. | string |
namesignInstructions | No | Name sign instructions. | string |
transactionId | Yes | Required when updating a reservation. Leave blank for NEW reservations. | string |
submitMode | No | Set to WAIT to process synchronously and wait for the result. Leave blank otherwise. | string |
notes
| Field | Required | Description | Type |
|---|
notes | No | Array that holds affiliate notes. | array |
notes.user | No | Optional user ID of the person sending the message. | string |
notes.context | No | Should be set to AFFILIATE. | string |
notes.message | No | Actual notes and instructions from the affiliate. | string |
account
| Field | Required | Description | Type |
|---|
account | No | Account information of the SENDER in the RECEIVER system. | object |
account.accountNumber | No | Customer ID / Account Number of the SENDER in the RECEIVER system. If present, it is used. Otherwise the system looks at the PROVIDER setting for an account number for this relationship. | string |
account.accountName | No | Name of the SENDER. | string |
account.callerName | No | Name of the caller. | string |
account.callerEmail | No | Email of the caller. | string |
account.callerNumber | No | Phone number of the caller. | string |
