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)

Price

Curious how much a booking will cost? Use our price calculator to get an estimate.

PreviousIdempotent requestsNextWebhooks

Last updated 2 months ago

Create a test account to get started.

NOTE: For immediate return PUDs, the duration and distance is for one direction.

Test Account Setup

Price Estimation

get

Get price estimation for a PUD

Query parameters
pickupAddressstringRequired

Pickup address

Example: Møllergata 6
pickupPostalCodestringRequired

Pickup postal code

Example: 0159
deliveryAddressstringRequired

Delivery address

Example: Møllergata 6
deliveryPostalCodestringRequired

Delivery postal code

Example: 0159
immediateReturnbooleanOptional

Immediate return

Default: falseExample: false
Header parameters
x-api-tokenstringRequired

Company API key

Responses
200
Price estimation returned
application/json
400
Bad request - see error type and message
application/json
401
Unauthorized
application/json
get
GET /api/v3/price-estimate?pickupAddress=text&pickupPostalCode=text&deliveryAddress=text&deliveryPostalCode=text HTTP/1.1
Host: 
x-api-token: text
Accept: */*
{
  "price": 1234,
  "outOfArea": false,
  "durationInSeconds": 1234,
  "distanceInMeters": 1234,
  "resolvedPickup": "Møllergata 6, 0179 Oslo, Norway",
  "resolvedDelivery": "Møllergata 6, 0179 Oslo, Norway",
  "immediateReturn": false
}