Quote & Booking Payload
Payload Overview
{
"aircraft": "string",
"aircraftObj":{...},
"autoCreatePosFlights": true,
"avinodeQuoteId": "string",
"bookingIdentifier": "string",
"bookingid": 0,
"comment": "string",
"createdDate": "2023-04-26T19:13:59.295Z",
"customer": {...},
"externalReference": "string",
"internalId": 0,
"legs": [...],
"links": [...],
"origin": "AVINODE",
"price": {...},
"quoteNumber": "string",
"quotePrice": {...},
"rootBookingid": 0,
"salesPerson": {...},
"sourcingBookingId": 0,
"sourcingBookingReference": "string",
"status": "string",
"tripNumber": 0,
"workflow": "COMMERCIAL",
"workflowCustomName": "string"
}
"aircraft": "string" Uses the plane tail number as a reference [Mandatory Field]
"aircraftObj":{...} Payload with aircraft data, see reference below
"autoCreatePosFlights": true, To enable the automatic creation of positioning leg
"avinodeQuoteId": "string", Id received if quote is created via Avinode
"bookingIdentifier": "string", Sales Booking identifier
"bookingIdentifier": "POIMO",
"bookingid": 0, Internal booking id
"comment": "string", Related to the Internal Comments in the booking, under Notes section
"createdDate": "2023-04-26T19:13:59.295Z", Gets automatically generated after creating the booking for the first time
"customer": {...}, Payload with the Customer ( FL3XX Person) and the Account related to it, see reference [Mandatory Field]
"externalReference": "string", Reference can be provided and/or automatically generated when booking is created via External API
"internalId": 0, Not available for booking, same as bookingId
"legs": [...], Payload with the legs in the booking, see below for reference [Mandatory Field]
"origin": "AVINODE", The origin of the booking can be set in one of the following parameters
"price": {...}, Payload with the quote pricing, see below for reference
"quoteNumber": "string", Optional if using the bookingID and bookingIdentifier
"quotePrice": {...}, Payload with the quote pricing, see below for reference
"rootBookingid": 0,
"salesPerson": {...}, Sales person data related to the quote
"sourcingBookingId": 0, Available if multiple bookings options are generated, this reference the Original booking
"sourcingBookingReference": "string", Available if multiple bookings options are generated, this reference the Original booking
"status": "string", FL3XX Booking Status
"tripNumber": 0, Not Yet Available
"workflow": "COMMERCIAL", List of Workflow types [Mandatory Field] -> Default: CHARTER
"workflowCustomName": "string"
AircraftObject
"aircraftObj": {
"aircraftName": "string",
"ambulance": true,
"aocNumber": "string",
"bedsN": 0,
"beltedToilet": true,
"cabinCrew": 0,
"cabinHeight": 0,
"cabinLength": 0,
"cabinWidth": 0,
"cargo": true,
"category": "PISTON",
"equipment": {
"baggageVolume": 0,
"cd_dvd": true,
"coffeePot": true,
"enclosedLavatory": true,
"entertainmentSystem": true,
"espresso": true,
"golfBags": true,
"headsets": true,
"iceBin": true,
"lavatory": true,
"maxWeight": 0,
"microwaveOven": true,
"petsAllowed": true,
"satPhone": true,
"satTV": true,
"skiTube": true,
"smokingAllowed": true,
"standardSuitcases": 0,
"tv": true,
"v110": true,
"v230": true,
"warmingOven": true,
"wifi": true
},
"externalHeight": 0,
"externalLength": 0,
"flightNumberToken": "string",
"homebase": "string",
"id": 0,
"keyAccountManager": {
"account": {
"accountNumber": "string",
"accountid": 0,
"address": {
"buildingDetails": "string",
"city": "string",
"country": "string",
"externalReference": "string",
"internalId": 0,
"latitude": 0,
"links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": {},
"title": "string",
"type": "string"
}
],
"longitude": 0,
"recipient": "string",
"street": "string",
"type": "WORK",
"zip": "string"
},
"email": "string",
"externalReference": "string",
"internalId": 0,
"links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": {},
"title": "string",
"type": "string"
}
],
"mobile": "string",
"name": "string",
"notes": "string",
"phone": "string",
"vatNumber": "string"
},
"acronym": "string",
"address": {
"buildingDetails": "string",
"city": "string",
"country": "string",
"externalReference": "string",
"internalId": 0,
"latitude": 0,
"links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": {},
"title": "string",
"type": "string"
}
],
"longitude": 0,
"recipient": "string",
"street": "string",
"type": "WORK",
"zip": "string"
},
"birthDate": "2023-04-21",
"birthPlace": "string",
"documentExpiration": "2023-04-21",
"documentExternalReference": 0,
"documentNumber": "string",
"documentType": "PASSPORT",
"email": "string",
"externalReference": "string",
"firstName": "string",
"gender": "FEMALE",
"internalId": 0,
"issueCountry": "string",
"issueDate": "2023-04-21",
"lastName": "string",
"links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": {},
"title": "string",
"type": "string"
}
],
"logName": "string",
"mobile": "string",
"nationality": "string",
"personnelNumber": "string",
"phone": "string",
"salutation": "Mr",
"siflType": "CONTROL",
"status": "ACTIVE",
"weight": 0
},
"manufacturingDate": 0,
"maxFuel": 0,
"model": "string",
"numberOfSeats": 0,
"ownersApprovalRequired": true,
"refurbished": 0,
"refurbishedInt": 0,
"status": "ACTIVE",
"subcharter": true,
"tailNumber": "string",
"type": "string",
"typeName": "string",
"wingSpan": 0
}
Customer & Sales Person
"customer": {
"account": {
"accountNumber": "string",
"accountid": 0,
"address": {...},
"email": "string",
"externalReference": "string",
"internalId": 0,
"mobile": "string",
"name": "string",
"notes": "string",
"phone": "string",
"vatNumber": "string"
},
"acronym": "string",
"address": {...},
"birthDate": "2023-04-17",
"birthPlace": "string",
"documentExpiration": "2023-04-17",
"documentExternalReference": 0,
"documentNumber": "string",
"documentType": "PASSPORT",
"email": "string",
"externalReference": "string",
"firstName": "string",
"gender": "FEMALE",
"internalId": 0,
"issueCountry": "string",
"issueDate": "2023-04-17",
"lastName": "string",
"logName": "string",
"mobile": "string",
"nationality": "string",
"personnelNumber": "string",
"phone": "string",
"salutation": "Mr",
"siflType": "CONTROL",
"status": "ACTIVE",
"weight": 0
},
"customer" All customer information (FL3XX Person) related to the booking
"account" Information of the account reference for the customer
Legs
"legs": [
{
"aircraft": "string",
"arrivalAirport": "string",
"arrivalAirportObj": {...},
"arrivalDate": "string",
"arrivalDateUTC": "string",
"blockTime": 0,
"comments": "string",
"crew": [,.,.],
"departureAirport": "string",
"departureAirportObj": {...},
"departureDate": "string",
"departureDateUTC": "string",
"distance": 0,
"flightInfo": {
"dossierNumber": "string",
"flightId": 0,
"flightType": "CARGO",
"referenceNumber": "string"
},
"flightTime": 0,
"fplType": "N",
"fuelStop": true,
"id": "string",
"notes": "string",
"pax": 0,
"planningNotes": "string",
"postFlightClosed": true,
"requestedAircraftType": "CJ3",
"seatsAfter": 0,
"status": "OK",
"taskType": "MAINTENANCE",
"techStop": true,
"tripNumber": 0,
"warnings": [.,.],
"workflow": "COMMERCIAL",
"workflowCustomName": "string"
}
],
"aircraft": "string", tail is automatically taken from Quote chosen Tail, or can select different tail for each leg
"departureAirport": "string", ICAO or FAA [Mandatory Field]
"arrivalAirport": "string", ICAO or FAA [Mandatory Field]
"departureDate": "string", use the normal time or the UTC, FL3XX automatically convert and calculate the arrival times [Mandatory Field]
Crew
"crew": [
{
"email": "string",
"externalReference": "string",
"firstName": "string",
"isPilotLanding": true,
"isPilotTakeoff": true,
"lastName": "string",
"logName": "string",
"luggageUnit": "KILOGRAM",
"luggageWeight": 0,
"middleName": "string",
"mobile": "string",
"personnelNumber": "string",
"phone": "string",
"pilotId": 0,
"role": "string",
"trigram": "string",
"weight": 0,
"weightUnit": "KILOGRAM"
}
],
"pilotId": 0, InternalId used to identify the person, if this person has pilot role, internalID is the same as pilotID
"role": "string", Roles types Legend
Updated 2 months ago