GuidesAPI ReferenceSwagger
Guides

Working with Partnerships

Suggest Edits

Introduction

As a broker, you may have agreements and partnerships with certain charter operators concerning fleet availability, pricing, and more. Establishing a partnership in the Avinode Marketplace not only helps you filter search results but also allows you to curate specific operators, parts of a fleet, or even multiple fleets for an End Client Trip Search application. Partnerships are powerful tools that can further enhance and customize your charter sourcing experience.

Access to partnership features requires a certain membership level and incurs additional costs. For more details regarding requirements and pricing, it is advisable to contact your Avinode account manager.

Partnership Management

Partnership Management in the Avinode Marketplace Web UI

Partnerships can be managed directly within the Avinode Marketplace web UI. The UI provides several options for partnership management, including:

  • Selecting which charter operators should be included in the partnership
  • Determining whether the partnership should be classified as "preferred"
  • Requiring that all aircraft within the partnership be listed on an AOC
  • Deciding whether the entire fleet or only specific aircraft from an operator should be included in the partnership

Partnership Management via API

Avinode also allows partnership management via a REST API. To use this functionality, your specific API connection must be granted permission to access the Partnership API.

The Partnership API allows for:

Partnership Creation

When initially creating a partnership via the API, you must provide a name for the partnership. Additional settings, such as whether the partnership should be active and whether the entire fleet of partner companies should be automatically added, can also be configured.

To create a partnership, call the POST /partnership endpoint with a payload similar to the following:

{
  "displayName": "My Partnership",
  "active": true,
  "autoSyncFleet": true
}

Partnership Update

Any of the above partnership settings can be modified by calling PUT /partnership/{partnershipId} with a payload like the one below:

{
  "displayName": "My Updated Partnership",
  "active": true,
  "autoSyncFleet": false
}

Adding Aircraft to an Existing Partnership

Depending on the partnership settings, aircraft can be added individually or as part of an entire fleet. If the partnership is set to "autoSyncFleet": true, the entire fleet of an operator will be included when one of its aircraft is added to the partnership. If the setting is "autoSyncFleet": false, only the specific aircraft specified in the API call will be added.

To add aircraft to a partnership the following POST /partnership/{partnershipId}/aircraft/add endpoint can be used with the following payload:

{
  "aircraftTail": "AB-X9472",
  "certificateNumber": "ZX-99999",
  "aircraftId": "3DA85B64-5397-4216-B3AE-4C963E66BAF6"
}

The certificateNumber can be omitted, as can either the aircraftTail or aircraftId, as long as one of the two is provided (e.g., if only the aircraftTail is known).

Removing Aircraft from an Existing Partnership

A specific aircraft can be removed from an existing partnership by calling the POST /partnership/{partnershipId}/aircraft/remove endpoint with the following payload:

{
  "aircraftTail": "AB-X9472",
  "certificateNumber": "ZX-99999",
  "aircraftId": "3DA85B64-5397-4216-B3AE-4C963E66BAF6"
}

Similarly to when adding an aircraft, the certificate number can be omitted as well as either the aircraftTail or aircraftId, as long as one of the two is provided.

Please note: Once an aircraft tail has been removed from a partnership, adding the same or another aircraft will not automatically re-add the entire fleet, even if the partnership setting is "autoSyncFleet": true.

Application of Partnerships

To apply a specific partnership within the Avinode Marketplace Search, you can use a partnership filter. This can be done from the "Filter" menu on the left side of the interface. You can select one or multiple partnerships to be applied.

Applying a partnership filter within the Avinode Marketplace

Applying a partnership filter within the Avinode Marketplace

When using the Avinode API, a required partnership filter can be applied to perform sourcing actions only on a particular partnership or multiple partnerships.

The partnership can be included as an array, within the criteria object, as "requiredPartnerships": [ "My partnership" ], as shown below:

{
    "criteria": {
        "requiredLift": [
            {
                "aircraftCategory": "Heavy jet"
            }
        ],
        "requiredPartnerships": ["My partnership"],
        "maxFuelStopsPerSegment": 0,
        "includeLiftUpgrades": true,
        "maxInitialPositioningTimeMinutes": 0,
        "minimumYearOfMake": 2010
    },
    "segments": [
        {
            "startAirport": {
                "icao": "KMIA"
            }
... snip ...

For more information on the Partnership API, see our Partnership API reference or our Swagger documentation.

Updated 8 days ago