v2

latestSwagger 2.02026-08-0187117271.9 KB
Shipments

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

get/api/v1/shipment/shipments

Query parameters

pageinteger

Specifies the page to request.

pageSizeinteger

Specifies the pagesize. Defaults to 50, max value is 250

createdAtMinstring date-time

Specifies the oldest shipment date to include in the response

createdAtMaxstring date-time

Specifies the newest shipment date to include in the response

orderIdinteger

Get shipments for this order only.

minimumShipmentIdinteger

Get Shipments with a shipment greater or equal than this id. New shipments have a greater id than older shipments.

shippingProviderIdinteger

Get Shippings for the specified shipping provider only. <seealso cref="M:Rechnungsdruck.WebApp.Controllers.Api.ShipmentController.GetShippingproviders" />

Response

OK

ErrorMessagestring
ErrorCode0 | 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
ErrorDescription0 | 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