Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Einride BookingService API

The BookingService API from Einride — 7 operation(s) for bookingservice.

Einride BookingService API is one of 3 APIs that Einride publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include BookingService. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 7 paths, and defines 26 schemas. It is described by OpenAPI 2.0, at version v1beta1.

Requests are made against the base URL https://api.saga.einride.tech.

7 operations 7 paths 26 schemas 5 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v1beta1
Base URL
https://api.saga.einride.tech
Resource Areas
1

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 5 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

BookingService 7
GET
/v1beta1/{parent}/tours
List existing truck tours.
BookingService_ListTours 6 params → 200default
GET
/v1beta1/{parent}/tours:search
Search tours.
BookingService_SearchTours 7 params → 200default
POST
/v1beta1/{space}/tours
Create a truck tour booking in a space.
BookingService_CreateTour 2 params → 200default
PATCH
/v1beta1/{tour.name}
Update a tour.
BookingService_UpdateTour 2 params → 200default
GET
/v1beta1/{tour}
Get an existing truck tour booking.
BookingService_GetTour 1 param → 200default
GET
/v1beta1/{tour}:cancel
Cancel a tour.
BookingService_CancelTour 1 param → 200default
GET
/v1beta1/{tour}:confirm
Confirm a Provisional tour.
BookingService_ConfirmTour 1 param → 200default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are v1beta1Shipment (23 properties), v1beta1Tour (15 properties), v1beta1Address (12 properties), bookv1beta1Unit (9 properties). Each schema is shown below with its type and property counts.

UnitWeight
object
2 properties 2 required
TourStopType
string
Type describes the reason for the stop. E.g. a stop to deliver or pickup. - PICKUP: Stop to pick up goods. - DELIVER: Stop to deliver goods.
v1beta1TourState
string
The state of the tour. - PENDING: The tour is received. Awaiting accept/reject. - ACCEPTED: The tour is accepted. - REJECTED: The tour is rejected. - CANCELLED…
TourStop
object
A stop is an address where an event is going to happen. The event is either to pickup or deliver goods.
7 properties 5 required
UnitVolume
object
2 properties 2 required
v1beta1Vehicle
object
3 properties 1 required
v1beta1SearchToursResponse
object
Response message for TourService.SearchTours.
3 properties
bookv1beta1Unit
object
A unit is a holder of goods such as a EUR-pallet.
9 properties 2 required
TourTourType
string
The tour type. - PROVISIONAL: The tour is provisional and can be updated. - CONFIRMED: The tour is confirmed and can not be updated.
v1beta1Address
object
An Address is where goods are picked up or delivered.
12 properties 5 required
ShipmentService
string
- PALLET: Pallet - FTL: Full truck load - DRAYAGE: Drayage is the transport of goods over a short distance also known as the "The first mile."
v1beta1Shipment
object
A shipment represents a demand to deliver goods from an origin to a destination.
23 properties 3 required
protobufAny
object
1 property
ShipmentDeliveryState
string
- AWAITING: Shipment delivery hasn't started - INTRANSIT: Shipment is in transit - DELIVERED: Shipment is delivered
v1beta1ListToursResponse
object
Response message for TourService.ListTours.
3 properties
TourAutomationRule
string
The rule that is applied when a confirmed tour is accepted. - CREATESHIPMENTS: When the confirmed tour is accepted, shipments will be created automatically fro…
v1beta1Tour
object
A Tour is a preplanned definition of what groups of goods are to be picked up and delivered, where, at what times, and in what order. When a tour is accepted a…
15 properties 4 required
UnitWeightUnit
string
- KG: Kilograms - LBS: Pounds
UnitVolumeUnit
string
- CBM: Cubic meters - CBFT: Cubic feet
UnitLength
object
2 properties 2 required
v1beta1ShipmentState
string
- ACTIVE: Shipment is active (initial state). - RELEASED: Shipment is ready for pickup. - CANCELLED: Shipment is cancelled
TourPreliminaryShipment
object
Customer provided information about a shipment associated with a tour that will be added to the created shipments.
3 properties 2 required
UnitLengthUnit
string
- CM: Centimeters - IN: Inches
typeLatLng
object
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specifi…
2 properties
TourServiceType
string
The service type of the tour. - FULLTRUCKLOAD: Service type FTL. - DISTRIBUTION: Service type distribution. - SHUTTLE: Service type shuttle. - MILKRUN: Service…
rpcStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

einride-bookingservice-api-openapi.yml Raw ↑

Other APIs Einride publishes across the network.

Einride AuthenticationService API
Einride ShipmentService API