Gire Public API
  • Gire Public API (v3)
    • PUDs
      • Booking restrictions
      • Idempotent requests
    • Price
    • Webhooks
    • Errors
    • Test Account Setup
  • Gire Public API (v2)
Powered by GitBook
On this page
  1. Gire Public API (v3)

Errors

This section outlines the standard error responses returned by the API.

NOTE: We only guarantee that the errorType will not change. The corresponding message or optional data may change in the future.

Error type
Description

VALIDATION_ERROR

The body/query has missing fields and/or using incorrect types.

ADDRESS_NOT_FOUND

Google was unable to resolve the address.

PARTIAL_ADDRESS

Google found multiple matches for the address provided - please provide more information.

PRICE_ESTIMATE_UNAVAILABLE

We were unable to calculate a price estimate, typically due to addresses far away from transport hubs. Contact Gire support for a quote.

CANNOT_CANCEL_PUD

The PUD cannot be cancelled, likely due to it already be in progress.

BOOKING_BLOCKED

The PUD cannot be accepted due to a booking block during the specified hours (can happen in periods of insufficient driver capacity).

INVALID_BOOKING_INTERVAL

The interval provided is invalid.

BOOKING_BAN

Your account is temporarily suspended, likely due to outstanding bills. Contact support for more information.

If the error is not one specified in the list above, the errorType will simply be an error code matching the status code. 404 -> NOT_FOUND, for example.

Example error responses:

{
    errorType: "CANNOT_CANCEL_PUD",
    statusCode: 409,
    message: "This PUD cannot be cancelled because it is already in progress",
    path: "/api/v3/puds",
    timestamp: "2025-05-14T13:50:26.480Z",
    requestId: "fdd33be0-78e1-4ade-8d01-10e15f807510"
}
{
    errorType: "BOOKING_BLOCKED",
    statusCode: 409,
    message: "We are unable to accept the booking due to insufficient driver capacity.",
    path: "/api/v3/puds",
    timestamp: "2025-05-14T13:50:26.480Z",
    requestId: "fdd33be0-78e1-4ade-8d01-10e15f807510"
}

If the error is not one specified in the list above, the errorType will simply be an error code matching the status code. 404 -> NOT_FOUND, for example.

PreviousWebhooksNextTest Account Setup

Last updated 9 days ago