For the complete documentation index, see llms.txt. This page is also available as Markdown.

Price

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

Create a test account to get started.

Test Account Setup

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

Price Estimate V2

get

Get price estimate v2 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
companyIdstringOptional

Specify ID of company to get the price estimate for

Example: 90sdfjs09fds
addonsstring[]Optional

Addons to include in the estimate. See your available addons by using the /me endpoint

intervalTypestring · enumRequired

Interval type for the estimate

Example: pickupPossible values:
intervalStartstring · date-timeRequired

Interval start date and time

Example: 2021-08-13T12:00:00Z
intervalEndstring · date-timeRequired

Interval end date and time

Example: 2021-08-13T14:00:00Z
Header parameters
x-api-tokenstringRequired

Company API key

Responses
200

Price estimation returned

application/json
bookingProductstring · enumRequired

Booking product

Example: precisePossible values:
pricenumberRequired

Estimated price

Example: 1234
companyIdstringRequired

ID of the company

Example: 8932n8dnhsdf8sdf
currencystringRequired

Currency

Example: NOK
addonsstring[]Required

Booking addons

Example: ["temporaryPlates","electricVehicle"]
immediateReturnbooleanRequired

Immediate return

Example: true
get/api/v3/price-estimate-v2
GET /api/v3/price-estimate-v2?pickupAddress=Møllergata+6&pickupPostalCode=0159&deliveryAddress=Møllergata+6&deliveryPostalCode=0159&intervalType=pickup&intervalStart=2021-08-13T12%3A00%3A00Z&intervalEnd=2021-08-13T14%3A00%3A00Z HTTP/1.1
x-api-token: text
Accept: */*
{
  "pickup": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "interval": {
      "start": "2021-08-13T12:00:00Z",
      "end": "2021-08-13T14:00:00Z"
    }
  },
  "delivery": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "interval": {
      "start": "2021-08-13T12:00:00Z",
      "end": "2021-08-13T14:00:00Z"
    }
  },
  "bookingProduct": "precise",
  "price": 1234,
  "companyId": "8932n8dnhsdf8sdf",
  "currency": "NOK",
  "addons": [
    "temporaryPlates",
    "electricVehicle"
  ],
  "immediateReturn": true
}

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
pricenumberRequired

Price

Example: 1234
outOfAreabooleanRequired

Out of area

Example: false
durationInSecondsnumberRequired

Duration in seconds

Example: 1234
distanceInMetersnumberRequired

Distance in meters

Example: 1234
handlingTimeInSecondsstringRequired

Handling time in seconds

Example: 300
totalTimeInSecondsnumberRequired

Total time in seconds (contains both duration and handling time)

Example: 1534
minimumRequiredPickupWindowInSecondsnumberRequired

Minimum required pickup window in seconds

Example: 3600
resolvedPickupstringRequired

Resolved pickup address

Example: Møllergata 6, 0179 Oslo, Norway
resolvedDeliverystringRequired

Resolved delivery address

Example: Møllergata 6, 0179 Oslo, Norway
immediateReturnbooleanRequired

Immediate return

Example: false
get/api/v3/price-estimate
GET /api/v3/price-estimate?pickupAddress=Møllergata+6&pickupPostalCode=0159&deliveryAddress=Møllergata+6&deliveryPostalCode=0159 HTTP/1.1
x-api-token: text
Accept: */*
{
  "price": 1234,
  "outOfArea": false,
  "durationInSeconds": 1234,
  "distanceInMeters": 1234,
  "handlingTimeInSeconds": 300,
  "totalTimeInSeconds": 1534,
  "minimumRequiredPickupWindowInSeconds": 3600,
  "resolvedPickup": "Møllergata 6, 0179 Oslo, Norway",
  "resolvedDelivery": "Møllergata 6, 0179 Oslo, Norway",
  "immediateReturn": false,
  "bookingBlockingInfo": [
    {
      "start": "2021-08-13T12:00:00Z",
      "end": "2021-08-13T14:00:00Z"
    }
  ]
}

Last updated