Download End Client Leads
Streamline your workflow by downloading end client leads from Avinode into your system.
Overview
Avinode processes two main types of inquiries: end client leads and RFQs.
RFQs (Request for Quotes):
Inquiries from professional buyers sourcing charter options through the Avinode Marketplace. These inquiries aim to find available aircraft for their end clients. RFQs are most commonly sent by Brokers to Charter Operators but can also be from Operators sub-chartering.
End Client Leads:
Inquiries that come directly from the client, not through the Avinode Marketplace. These inquiries typically include essential information such as the client's first name, last name, email address, and specific trip details. End client leads transmitted to the Avinode Marketplace allow Brokers, and occasionally Charter Operators, to source and request (RFQ) suitable aircraft options tailored to the specifics provided by the end client leads.
Implementing this use case allows you to seamlessly import end client leads from Avinode into your external system. This use case is designed to save valuable time and streamline your charter sales process.
This use case can be effectively combined with other Avinode offers and API use cases, such as:
- End Client Trip Search
- End Client Empty Leg search
- Avinode Web App
- Search in Avinode from Your System
Pre-requisites
Before implementing this use case, it is imperative that you have a solution in place for capturing and creating leads in Avinode. This solution is typically provided by an Avinode Web App or an API-powered solution, such as the End Client Trip Search use case or the End Client Empty Leg search use case.
To ensure the successful execution of your project, it is essential to gain an understanding of our APIs and their underlying principles. To begin, we recommend that you review the introductions page, which includes essential resources linked within the "Before you start" section.
Implementation
Step 1: Setting up Webhooks
To initiate this integration, it is essential to configure webhook notifications for the "Client Leads" event. The setup involves making a call to POST /webhooks/settings. This action ensures that your solutions backend receives a webhook notification whenever a new end client lead is created in Avinode.
The payload of the webhook notification will resemble the following JSON structure:
{
"id" : "ecl-1138035",
"href" : "https://sandbox.avinode.com/api/leads/ecl-1138035",
"type" : "leads"
}
Step 2: Retrieving Lead Data
Upon receiving a webhook event notification, your solutions backend must respond with a request to GET /leads/{leadID}. The response payload will contain comprehensive lead information.
Avinode Lead API response data contains details about the End Client, itinerary, airports, cities/countries, requested aircraft categories, pricing, and more, as illustrated in the sample response below:
{
"meta": {
"errors": [],
"warnings": [],
"infos": []
},
"data": {
"id": "ecl-1138035",
"href": "https://sandbox.avinode.com/api/leads/ecl-1138035",
"type": "leads",
"actions": {
"searchInAvinode": {
"type": "searchInAvinode",
"description": "Start a search in Avinode",
"httpMethod": "GET",
"href": "https://sandbox.avinode.com/marketplace/mvc/search/load/ecl-1138035?source=api&origin=api_action"
},
"viewInAvinode": {
"type": "viewInAvinode",
"description": "View in Avinode",
"httpMethod": "GET",
"href": "https://sandbox.avinode.com/marketplace/mvc/trips/clientlead/ecl-1138035?source=api&origin=api_action"
}
},
"owningCompany": {
"id": "9661EF87-AABD-4054-A8C4-C0FDBEE47EE9",
"displayName": "Demo AirNode Europe",
"demo": true,
"contactInfo": {
"emails": [
"[email protected]"
],
"phone": "+65 90 712 50 93",
"mobilePhone": "+64 41 008 15 65",
"url": "www.avinode.com",
"office": "",
"address": "Gamlestads torg 5\n103 84 Asbglxwc\nSweden",
"detailedAddress": {
"street": "Gamlestads torg 5",
"postBox": "",
"postCode": "103 84",
"city": "Asbglxwc",
"country": {
"code": "SE",
"name": "Sweden"
}
}
},
"active": true
},
"createdOn": "2023-06-13T15:07:03.557Z",
"sellerLift": [
{
"sellerCompany": {
"id": "9661EF87-AABD-4054-A8C4-C0FDBEE47EE9",
"displayName": "Demo AirNode Europe",
"demo": true,
"contactInfo": {
"emails": [
"[email protected]"
],
"phone": "+65 90 712 50 93",
"mobilePhone": "+64 41 008 15 65",
"url": "www.avinode.com",
"office": "",
"address": "Gamlestads torg 5\n103 84 Asbglxwc\nSweden",
"detailedAddress": {
"street": "Gamlestads torg 5",
"postBox": "",
"postCode": "103 84",
"city": "Asbglxwc",
"country": {
"code": "SE",
"name": "Sweden"
}
}
},
"active": true
},
"lift": [
{
"id": "apicat-5368",
"aircraftCategory": "Light and super light jet",
"priceExpectation": {
"currency": "USD",
"price": 6350.00,
"conversionCurrency": "EUR",
"convertedPrice": 5906.56,
"priceAsString": "6350"
}
},
{
"id": "acat-220",
"aircraftCategory": "Light jet",
"priceExpectation": {
"currency": "USD",
"price": 6350.00,
"conversionCurrency": "EUR",
"convertedPrice": 5906.56,
"priceAsString": "6350"
}
},
{
"id": "acat-221",
"aircraftCategory": "Super light jet",
"priceExpectation": {
"currency": "USD",
"price": 6350.00,
"conversionCurrency": "EUR",
"convertedPrice": 5906.56,
"priceAsString": "6350"
}
}
]
}
],
"leadContactInfo": {
"name": "Avinode Tech support",
"emails": [
"[email protected]"
],
"phone": "+1546455654333",
"mobilePhone": ""
},
"segments": [
{
"startAirport": {
"id": "aport-5955",
"href": "https://sandbox.avinode.com/api/airports/aport-5955",
"type": "airports",
"name": "LANDVETTER",
"city": "GOTEBORG",
"country": {
"code": "SE",
"name": "Sweden"
},
"icao": "ESGG",
"iata": "GOT"
},
"endAirport": {
"id": "aport-5013",
"href": "https://sandbox.avinode.com/api/airports/aport-5013",
"type": "airports",
"name": "SCHIPHOL",
"city": "AMSTERDAM",
"country": {
"code": "NL",
"name": "Netherlands"
},
"icao": "EHAM",
"iata": "AMS"
},
"departureDateTime": {
"dateTimeUTC": "2023-06-21T07:00:00Z",
"dateTimeLocal": "2023-06-21T09:00:00+02:00"
},
"timeTBD": false,
"paxCount": 2,
"paxSegment": true
}
],
"message": "Testing the Client Lead API from Web App",
"locale": {
"code": "en",
"display": "English"
}
}
}
This completes the workflow, enabling the successful download of Avinode Client Leads into your external system.
Go Live!
Implementation checklist
All items on this check list must be true in order for an application of this type to be allowed to call the live Avinode Marketplace environment.
- The application must comply with the Basic Go Live requirements.
- You have a solution in place that captures and creates leads in Avinode.
- The application must have the appropriate webhook notification settings configured, i.e. the "ClientLeads" event.
- The receiving webhook server should respond with an HTTP status of 200, indicating successful acceptance of the webhook notification.
- The application's backend must successfully retrieve Client Lead data upon receiving a webhook notification, facilitated by calling GET /leads/{leadId}
Updated 7 months ago