Pickups
Schedule courier pickups for prepared shipments. Creates a pickup request with the courier and returns a pickup confirmation document.
List pickups
Returns a paginated list of shipments available for pickup. When both fromDate and toDate are omitted, results are limited to the current day; provide an explicit date range to query other periods.
query Parameters
pagePage number for pagination
pageSizeNumber of items per page
fromDateFilter pickups created from this date-time (format yyyy-MM-ddTHH:mm:ss.fff). When omitted together with toDate, the range defaults to the current day.
toDateFilter pickups created until this date-time (format yyyy-MM-ddTHH:mm:ss.fff). When omitted together with fromDate, the range defaults to the current day.
courierIdFilter by courier identifier (e.g., "gls", "dhl", "dpd")
withoutPickupWhen true (default), returns only shipments not yet assigned to a pickup
Headers
Accept-LanguageLanguage code for localized responses
List pickups › Responses
List of pickup items
pageCurrent page number
pageSizeNumber of items per page
totalPagesTotal number of pages
nextPageWhether a next page exists
previousPageWhether a previous page exists
itemsCountTotal number of items across all pages
List of pickup items
Create courier pickup
Creates a pickup request for the specified courier with the given shipments. Returns a PDF pickup document.
Headers
Accept-LanguageLanguage code for localized responses
Create courier pickup › Request Body
courierIdCourier identifier for the pickup
shippingNumbersList of shipping numbers to include in pickup
Create courier pickup › Responses
Pickup created successfully
documentBase64-encoded PDF pickup document