API reference · Getting around

Locations

The airports where cars are collected and returned, and the terms to show your customers.

get/locations

List hand-over points

The airports where cars are collected and returned. Any pick-up may be any drop-off (a one-way fee applies).

Response 200

A list in data. Each item:

  • codestringrequired

    Short code, e.g. ABV or LOS.

  • namestringrequired
  • citystringrequired
  • addressstring · nullable
  • instructionsstring · nullable

    Where our agent meets the customer.

  • openFromstring

    Opening time, HH:MM (Nigerian time).

  • openTostring

Errors

  • 401unauthorized: the API key is missing, wrong or revoked.
curl "https://engine-production-0004.up.railway.app/api/v1/locations" \
  -H "Authorization: Bearer wc_test_YOUR_KEY"
Response · 200
{
  "data": [
    {
      "code": "ABV",
      "name": "Nnamdi Azikiwe International Airport, Abuja",
      "city": "abuja",
      "address": "Airport Road, Abuja",
      "instructions": "Meet our agent at the arrivals hall.",
      "openFrom": "00:00",
      "openTo": "23:59"
    }
  ]
}
get/locations/{code}

Get a hand-over point

Path parameters

  • codestringrequired

    The airport code.

    Example: ABV

Response 200

In data:

  • codestringrequired

    Short code, e.g. ABV or LOS.

  • namestringrequired
  • citystringrequired
  • addressstring · nullable
  • instructionsstring · nullable

    Where our agent meets the customer.

  • openFromstring

    Opening time, HH:MM (Nigerian time).

  • openTostring

Errors

  • 401unauthorized: the API key is missing, wrong or revoked.
  • 404not_found: no such thing, or it is not yours.
curl "https://engine-production-0004.up.railway.app/api/v1/locations/ABV" \
  -H "Authorization: Bearer wc_test_YOUR_KEY"
get/terms

The rental and sale terms

Plain text to show the customer before they pay.

Response 200

In data:

  • rentalstring
  • salestring
  • privacystring
  • policyobject
    Show 2 fields
    • cancellationobject
      Show 4 fields
      • fullRefundHoursinteger

        Cancelling this many hours or more before pick-up refunds 100% of the rental price.

      • midRefundHoursinteger

        From here down to that many hours: midPercent.

      • midPercentinteger
      • latePercentinteger

        Under midRefundHours (or a no-show): this percent of the rental price is refunded.

    • lateReturnobject
      Show 2 fields
      • percentinteger

        The late-return hourly rate is the daily price ÷ 24 times this percent.

      • graceMinutesinteger

        Free minutes after the return time.

Errors

  • 401unauthorized: the API key is missing, wrong or revoked.
curl "https://engine-production-0004.up.railway.app/api/v1/terms" \
  -H "Authorization: Bearer wc_test_YOUR_KEY"