---
title: "Get a list of all shipments optionally filtered by date. All parameters are optional."
method: GET
path: "/api/v1/shipment/shipments"
tags: ["Shipments"]
---

# Get a list of all shipments optionally filtered by date. All parameters are optional.

`GET /api/v1/shipment/shipments`

## Query parameters

- `page` integer
- `pageSize` integer
- `createdAtMin` string, date-time
- `createdAtMax` string, date-time
- `orderId` integer
- `minimumShipmentId` integer
- `shippingProviderId` integer

## Response `200`

OK

- RechnungsdruckWebAppControllersApiApiPagedResultOfSystemCollectionsGenericListOfBillbeeInterfacesBillbeeAPIModelShipment
  - `Paging` RechnungsdruckWebAppControllersApiApiPagedResultPagingInformationOfSystemCollectionsGenericListOfBillbeeInterfacesBillbeeAPIModelShipment
    - `Page` integer
    - `TotalPages` integer
    - `TotalRows` integer
    - `PageSize` integer
  - `ErrorMessage` string
  - `ErrorCode` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31
  - `ErrorDescription` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31
  - `Data` BillbeeInterfacesBillbeeAPIModelShipment[]
    - `BillbeeId` integer — The billbee internal id of the shipment
    - `ShippingId` string — The id of this shipment
    - `Shipper` string — The name of the shipping provider
    - `Created` string, date-time — The creation date
    - `TrackingUrl` string — The url to track this shipment
    - `ShippingProviderId` integer — The id of the used shipping provider
    - `ShippingProviderProductId` integer — The id of the used shipping provider product
    - `ShippingCarrier` integer — The carrier used to ship the parcel with
    - `ShipmentType` integer — Shipment Type, 0 if Shipment, 1 if Retoure

---

[API](https://skmtc.net/billbee/apis/billbee-api.md) · [All operations](https://skmtc.net/billbee/apis/billbee-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/billbee/billbee-api/versions/e64f07f4f526/schema)
