Routes, Schedules and Rates

Changed on

This document provides information about request body parameters and headers as well as example requests and responses for different search modes

post/search

Request

  • Base URL
    https://api.cargoai.co/solutions
  • URL
    https://api.cargoai.co/solutions/search
  • Auth
    API key in header x-api-key

Headers

x-api-keystring required
x-api-namestring

Set it to "Schedules" for Route & Schedule (schedules only, no rates). Leave it empty for Quote & Book.

Request body

originstring required

Origin airport code (or a city code in Search by City Code)

destinationstring required

Destination airport code (or a city code in Search by City Code)

departureDatestring required

Your earliest desired departure date

timeoutinteger

Request timeout in seconds

offsetinteger

Departure dates in the search result can be up to {offset} days in the future (max value is 5)

idstring

Search Id to add to params before repeating request to get missing results

Response

200

OR
OR

Example response

{
  "id": "e8f7d6f8-d00d-4fb5-8600-1d9e5a89677c",
  "status": "COMPLETED",
  "resultsURL": "https://app.dev.cargoai.co/forwarder/search/search-result?uuid=e8f7d6f8-d00d-4fb5-8600-1d9e5a89677c&auth={{auth_token}}",
  "flights": [
    {
      "flightUUID": "57324f94-bbed-11f0-aa57-82c5a440dd41",
      "airlineCode": "00",
      "flightNumber": "00768",
      "arrivalTime": "2025-11-10T06:00:00+08:00",
      "arrivalAirport": "SIN",
      "departureTime": "2025-11-09T18:00:00+01:00",
      "departureAirport": "CDG",
      "latestAcceptanceTime": "2025-11-09T13:00:00+01:00",
      "timeOfAvailability": "2025-11-10T11:00:00+08:00",
      "legs": [
        {
          "flightNumber": "00768",
          "arrivalTime": "2025-11-10T06:00:00+08:00",
          "arrivalAirport": "SIN",
          "departureTime": "2025-11-09T18:00:00+01:00",
          "departureAirport": "CDG",
          "bodyType": "Widebody",
          "aircraftCode": "777",
          "co2": {
            "value": 268.7270446087906
          }
        }
      ],
      "features": {
        "bookable": true,
        "awbOptional": true
      },
      "rates": [
        {
          "id": "57324f75-bbed-11f0-aa57-82c5a440dd41",
          "name": "Spot",
          "type": "live",
          "currency": "EUR",
          "netRate": 6.08,
          "allInRate": 6.23,
          "total": 1035.05,
          "charges": [
            {
              "label": "Security surcharge",
              "rate": 0.08,
              "type": "GROSS_WEIGHT",
              "code": "ssc"
            }
          ],
          "isSpotQuoteRate": true,
          "handlingCodes": [
            "GCR"
          ],
          "bookingURL": "https://app.dev.cargoai.co/shipment-details/new?flightUUID=57324f94-bbed-11f0-aa57-82c5a440dd41&rateID=57324f75-bbed-11f0-aa57-82c5a440dd41&auth={{auth_token}}"
        }
      ],
      "available": true,
      "awbPrefixes": [
        "000"
      ],
      "airlineConditions": "\n\t1- Offer subject to capacity when booking.\n\t2- Quotation reference to be imperatively mentioned when booking.\n\t3- This quotation is valid for the packaging indicated only, in the event of modification, please make a new request to the sales department.\n\t4- Taxes (IRC – MYC – etc…) subject to change without notice.\n\t5- In the event of cancellation or no show, we reserve the right to pass on all or part of the costs\n\t- Cancellation 72 hours before the departure of the truck and/or the flight (working hours): invoicing 50% of the amount of the freight\n\t- Cancellation 48 hours before the departure of the truck and/or the flight (working hours): invoicing of 75% of the amount of the freight\n\t- Cancellation 24 hours before the departure of the truck and/or the flight (working hours): invoicing of 100% of the amount of the freight\n\t- In the case of a no show (no presentation of the freight): invoicing of 100% of the amount of the freight\n\t- In the case of a low show (discount less than 50% of the reserved taxable weight): invoicing of 75% of the reserved taxable weight\n",
      "handlingInfoLink": "https://www.cargoai.co/terms",
      "ghaName": "Mocked GHA",
      "hle": "19:00",
      "ghaAddress": "Airport road, Cargo Terminal, Mocked Cargo building"
    }
  ],
  "metadata": {
    "searchErrors": [
      {
        "error": "Customer ID not found",
        "airlines": [
          "01"
        ]
      }
    ]
  }
}

Changes