latestOpenAPI 3.0.02026-08-10234193.3 KB

60e380005037

Pickups

Retrieve list of courier pickup requests

This method allows business clients to retrieve a list of all courier pickup requests they have created. Clients can filter the list using specific parameters such as pickup IDs or pickup numbers.

CourierPickupService:</br> This service allows business clients to request a paid courier pickup without pre-creating shipments.

Behavior:</br> A pickup request using the CourierPickupService service can reach the Created status without any associated shipments. Shipments can be added later after the pickup request is created.

Permissions:</br> This service is restricted and available only for authorized business accounts according to individual contract terms. The service is currently available in Moldova.

If the service is not available in your account, please contact your Nova Post account manager or Sales representative.

This method is available to business clients in EU countries where Nova Post operates.

get/pickups

Query parameters

numbers[]string

Search pickups by document number. Can accept either a single search number or an array of numbers for conducting the search.

ids[]integer

A list of pickup request IDs to search. Can accept either a single search number or an array of numbers for conducting the search.

🔹The id can be obtained from the Create a courier pickup request response or by searching for the pickup request by its document number.

serviceCodes[]string

Filter pickup requests by service code.

Allowed values:

  • CourierPickupService

Returns only pickup requests that contain the specified service.

limitinteger

Max number of items to return on page.

pageinteger

Number of page to return.

Request body

idsstring

A list of pickup request IDs to search.

Response

List of courier pickup requests retrieved successfully.

current_pageinteger

The current page of results in the paginated response.

last_pageinteger

The last available page in the paginated response.

per_pageinteger

The number of items per page.

totalinteger

Total number of pickup requests matching the filter criteria.