# HERE Shipments API

**Canonical:** https://apis.io/apis/here/here-shipments-api/  
**Provider:** HERE — https://apis.io/providers/here/  
**Base URL:** https://account.api.here.com  
**Documentation:** https://docs.here.com/identity-and-access-management/reference

HERE Shipments API is one of 139 APIs that [HERE](https://apis.io/providers/here/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Shipments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The Shipments service manages shipments. A shipment describes a structure of a multimodal logistics journey. Shipments are useful when the lifetime of an asset one is tracking spans across multiple devices. A shipment consists of segments that span from a location to another. The segments and their origins and destinations must form a continuous chain of locations, that is the origin of a segment must match the destination of a previous segment. Each segment of the shipment may be assigned a `trackingId` that can vary between segments. Devices assigned to a shipment generate traces and events for the entire shipment. The `shipmentId` of a shipment can be used in similar fashion as a `trackingId` in selected APIs. For example, one can query for shipment ***traces*** and ***events*** and associate ***aliases*** and ***metadata*** to a shipment. Each shipment has one of the following statuses: * ***pending***: The shipment has not yet started. * ***ongoing***: The shipment has started and it has one segment ongoing. * ***completed***: The shipment has ended and all of its segments are completed. * ***cancelled***: The shipment has ended and it has one or more cancelled segments. HERE Tracking progresses the shipment automatically if each segment has been assigned a `trackingId` and the origin and destination locations contain a `geofenceId`. Each segment is started upon exiting the origin location of the segment and completed upon entering the destination location of the segment. If the origin and the destination of a segment share the same location (that is, dwelling in a single location), the segment will automatically be started after the previous segment was completed. To automatically start a segment which follows a dwelling segment, both the dwelling and following segment has to have the same `trackingId` assigned to them. If a segment does not have a device assigned, the user must start and complete the segment manually. A new shipment should be instantiated for each separate logistical journey. Shipments that are still ongoing after two weeks are automatically cancelled. This time limit can be altered via `registry/v2/features` endpoint by changing `data.shipments.ongoingRetentionPeriod` configuration option. Shipments older than six months are automatically removed. Automatic shipment startup can be constrained to trigger only at time of shipment's `providedEtd` by defining an auto-start limit window via configuration options of `data.shipments.autoStartLimitBefore` and `data.shipments.autoStartLimitAfter` through `registry/v2/features` endpoint. With the auto-start limit window configured, pending shipments that have `providedEtd` set that are not started within the limit window are automatically cancelled.

## Operations (11)

| Method | Path | Summary |
|---|---|---|
| GET | `/shipments/v4/health` | Gets service health |
| GET | `/shipments/v4/version` | Gets service version |
| POST | `/shipments/v4` | Creates a shipment |
| GET | `/shipments/v4` | Gets all shipments |
| DELETE | `/shipments/v4` | Deletes all shipments |
| GET | `/shipments/v4/{shipmentId}` | Gets a shipment details |
| PATCH | `/shipments/v4/{shipmentId}` | Updates a shipment details |
| DELETE | `/shipments/v4/{shipmentId}` | Deletes a shipment |
| GET | `/shipments/v4/{shipmentId}/{segmentId}` | Gets a segment details |
| PATCH | `/shipments/v4/{shipmentId}/{segmentId}` | Updates a segment details |
| GET | `/shipments/v4/{trackingId}/segments` | Gets segments assigned to a device |

## Machine-readable artifacts (37)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-shipments-api-openapi.yml
- **Documentation** — https://docs.here.com/identity-and-access-management/docs
- **APIReference** — https://docs.here.com/identity-and-access-management/reference
- **Documentation** — https://docs.here.com/data-api/docs
- **APIReference** — https://docs.here.com/data-api/reference
- **Documentation** — https://docs.here.com/usage/docs
- **APIReference** — https://docs.here.com/usage/reference
- **Documentation** — https://docs.here.com/destination-weather/docs
- **APIReference** — https://docs.here.com/destination-weather/reference
- **Documentation** — https://docs.here.com/ev-products/docs
- **APIReference** — https://docs.here.com/ev-products/reference
- **Documentation** — https://docs.here.com/fuel-prices/docs
- **APIReference** — https://docs.here.com/fuel-prices/reference
- **Documentation** — https://docs.here.com/geocoding-and-search/docs
- **APIReference** — https://docs.here.com/geocoding-and-search/reference
- **Documentation** — https://docs.here.com/routing/docs
- **APIReference** — https://docs.here.com/routing/reference
- **Documentation** — https://docs.here.com/positioning/docs
- **APIReference** — https://docs.here.com/positioning/reference
- **Documentation** — https://docs.here.com/indoor-map/docs
- **APIReference** — https://docs.here.com/indoor-map/reference
- **Documentation** — https://docs.here.com/transit/docs
- **APIReference** — https://docs.here.com/transit/reference
- **Documentation** — https://docs.here.com/map-attributes/docs
- **APIReference** — https://docs.here.com/map-attributes/reference
- **Documentation** — https://docs.here.com/map-rendering/docs
- **APIReference** — https://docs.here.com/map-rendering/reference
- **Documentation** — https://docs.here.com/workspace/docs
- **APIReference** — https://docs.here.com/workspace/reference
- **Documentation** — https://docs.here.com/tour-planning/docs
- **APIReference** — https://docs.here.com/tour-planning/reference
- **Documentation** — https://docs.here.com/tracking/docs
- **APIReference** — https://docs.here.com/tracking/reference
- **Documentation** — https://docs.here.com/traffic-api/docs
- **APIReference** — https://docs.here.com/traffic-api/reference
- **Documentation** — https://docs.here.com/wego-pro/docs
- **APIReference** — https://docs.here.com/wego-pro/reference

## Other HERE APIs (12)

- [HERE Geocoding and Search API](https://apis.io/apis/here/geocoding-search/)
- [HERE Autosuggest API](https://apis.io/apis/here/autosuggest/)
- [HERE Tour Planning API](https://apis.io/apis/here/tour-planning/)
- [HERE Public Transit API](https://apis.io/apis/here/public-transit/)
- [HERE Destination Weather API](https://apis.io/apis/here/destination-weather/)
- [HERE Map Tile API](https://apis.io/apis/here/map-tile/)
- [HERE Map Image API](https://apis.io/apis/here/map-image/)
- [HERE Tracking API](https://apis.io/apis/here/tracking/)
- [HERE Positioning API](https://apis.io/apis/here/positioning/)
- [HERE Parking API](https://apis.io/apis/here/parking/)
- [HERE Platform Data API](https://apis.io/apis/here/platform-data/)
- [HERE HD Live Map](https://apis.io/apis/here/hd-live-map/)

## Tags

Shipments

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/here/here-shipments-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/here/.