Pickup
Manage pickup requests
List of Shipping Orders
Returns a list of created shipping orders that are eligible for pickup creation.
query Parameters
fromDateStart of date range, format yyyy-MM-ddTHH:mm:ss
toDateEnd of date range, format yyyy-MM-ddTHH:mm:ss
stateFilter to return shipments based on pickup status (0 - without pickup, 1 - with and without pickup)
courierID of courier
pagePage number, cannot be less than 1
pageSizeNumber of items per page, cannot be less than 1 and greater than 50
List of Shipping Orders › Responses
Successful response
pageCurrent page number
pageSizeNumber of items per page
totalPagesTotal number of pages
nextPageIndicates if there is a next page
previousPageIndicates if there is a previous page
itemsCountTotal number of items
Array of result items
Create Pickup
This request is used to create pickup shipping orders in the courier system.
The response may include a shipment manifest if the target courier supports it.
To determine if a courier supports manifest printing, check the "printManifest" parameter in the /v1/couriers request.
path Parameters
courier_idID of courier
Create Pickup › Request Body
ShippingNumbersList of shipping numbers, all of which must belong to the same courier
Create Pickup › Responses
Pickup successfully created
documentBase64 encoded manifest document (if courier supports it)