All endpoints
Every endpoint below is generated from the OpenAPI file (OpenAPI 3.0.3, API version 1.0.0). Load that file into any OpenAPI tool to generate a client.
Base URL: https://api.horizonlogistics.eu
Authentication, errors and limits are described in the API overview.
Endpoints by area
| Area | Operations | Description |
|---|---|---|
| Orders | 10 | Orders from every connected sales channel, with their labels and documents. |
| Shipments | 5 | Shipments bought through Horizon and their tracking events. |
| Returns | 4 | Return requests and the steps that take them from request to completion. |
| Address checks | 1 | The check of an order’s delivery address and the decisions taken on it. |
| Inventory | 5 | Stock levels per product and per location. |
All endpoints
| Method | Path | Summary |
|---|---|---|
| GET | /api/address-checks/orders/{id}/ |
Retrieve an order’s address check |
| GET | /api/inventory/ |
List stock levels |
| GET | /api/inventory/location-stock/ |
Stock totals per location |
| GET | /api/inventory/{product_id}/ |
Retrieve a product’s stock |
| GET | /api/locations/ |
List locations |
| GET | /api/locations/{id}/ |
Retrieve a location |
| GET | /api/orders/ |
List orders |
| POST | /api/orders/ |
Create an order |
| POST | /api/orders/documents/ |
Download shipping documents of several orders as one PDF |
| GET | /api/orders/export/ |
Export orders as CSV |
| GET | /api/orders/facets/ |
List filter values in use |
| POST | /api/orders/labels-batch/ |
Download the labels of several orders as one PDF |
| GET | /api/orders/{id}/ |
Retrieve an order |
| GET | /api/orders/{id}/documents/ |
List the documents available for an order |
| GET | /api/orders/{id}/documents/{kind}/ |
Download one document of an order |
| POST | /api/orders/{id}/refresh-tracking/ |
Refresh an order’s tracking |
| GET | /api/returns/requests/ |
List returns |
| GET | /api/returns/requests/export/ |
Export returns as CSV |
| GET | /api/returns/requests/{id}/ |
Retrieve a return |
| GET | /api/returns/requests/{id}/label/ |
Download a return label |
| GET | /api/shipping/v1/shipments/ |
List shipments |
| GET | /api/shipping/v1/shipments/{shipment_id}/ |
Retrieve a shipment |
| GET | /api/shipping/v1/shipments/{shipment_id}/label/ |
Retrieve a shipment’s label |
| GET | /api/shipping/v1/tracking-events/ |
List tracking events |
| GET | /api/shipping/v1/tracking-events/{id}/ |
Retrieve a tracking event |