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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Einride

Einride ShipmentService API

The ShipmentService API from Einride — 6 operation(s) for shipmentservice.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

6 operations 6 paths 19 schemas 2 GET1 PATCH3 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 6

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

ShipmentService 6
GET
/v1beta1/{parent}/shipments
List shipments in a space.
ShipmentService_ListShipments 6 params → 200default
PATCH
/v1beta1/{shipment.name}
Update a shipment in a space.
ShipmentService_UpdateShipment 2 params → 200default
GET
/v1beta1/{shipment}
Get a shipment.
ShipmentService_GetShipment 1 param → 200default
POST
/v1beta1/{shipment}:cancel
Cancel a shipment.
ShipmentService_CancelShipment 2 params → 200default
POST
/v1beta1/{shipment}:release
Release a shipment.
ShipmentService_ReleaseShipment 2 params → 200default
POST
/v1beta1/{space}/shipments
Create a shipment in a space.
ShipmentService_CreateShipment 2 params → 200default

Schemas 19

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

UnitWeight
object
2 properties 2 required
UnitVolume
object
2 properties 2 required
v1beta1Vehicle
object
3 properties 1 required
v1beta1ListShipmentsResponse
object
Response message for ShipmentService.ListShipments.
3 properties
bookv1beta1Unit
object
A unit is a holder of goods such as a EUR-pallet.
9 properties 2 required
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."
protobufAny
object
1 property
v1beta1Shipment
object
A shipment represents a demand to deliver goods from an origin to a destination.
23 properties 3 required
ShipmentDeliveryState
string
- AWAITING: Shipment delivery hasn't started - INTRANSIT: Shipment is in transit - DELIVERED: Shipment is delivered
UnitWeightUnit
string
- KG: Kilograms - LBS: Pounds
ShipmentServiceCancelShipmentBody
object
Request message for BookService.CancelShipment.
ShipmentServiceReleaseShipmentBody
object
Request message for BookService.ReleaseShipment.
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
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
rpcStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

einride-shipmentservice-api-openapi.yml Raw ↑

Other APIs Einride publishes across the network.

Einride AuthenticationService API
AE Profile APIs.io
Einride BookingService API
AE Profile APIs.io
#ShipmentService
← Back to E APIs
API Details
ID
einride:einride-shipmentservice-api
Base URL
https://api.saga.einride.tech
Docs
https://extend.saga.einride.tech
Provider
Einride
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network