Pickups
Authorization JWT-token with a lifetime of 1 hour in header
Search pickups by document number. Can accept either a single search number or an array of numbers for conducting the search.
PUCZ0000002671A list of pickup request IDs to search. Can accept either a single search number or an array of numbers for conducting the search.
28813Max number of items to return on page.
15Example: 1Number of page to return.
1List of courier pickup requests retrieved successfully.
The current page of results in the paginated response.
The last available page in the paginated response.
The number of items per page.
Total number of pickup requests matching the filter criteria.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
Optional notes or instructions for the courier.
List of additional services that can be included in the pickup request. This functionality is currently under development.
The contact phone number of the sender, required to allow the courier to reach out if necessary.
While not mandatory, providing an email is recommended as a backup contact method in case the phone number is incorrect or for additional notifications regarding the pickup.
Full name of the client sending the parcel, essential for identifying the sender and ensuring accurate handling of the pickup.
The tax identification number (TIN) of a legal entity.
Name of the company requesting the pickup.
ISO Alpha-2 code for the pickup location.
^[A-Z]{2}$Start of the pickup time window, selected from available time intervals provided by the method that returns available time slots. If no time slot is specified, the courier will schedule the pickup at their discretion.
^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$End of the pickup time window, selected from available time intervals provided by the method that returns available time slots. If no time slot is specified, the courier will schedule the pickup at their discretion.
^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$Pickup request created successfully
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
Unique identifier of the pickup request to be updated.
Optional notes or instructions for the courier.
List of additional services that can be included in the pickup request. This functionality is currently under development.
The contact phone number of the sender, required to allow the courier to reach out if necessary.
While not mandatory, providing an email is recommended as a backup contact method in case the phone number is incorrect or for additional notifications regarding the pickup.
Full name of the client sending the parcel, essential for identifying the sender and ensuring accurate handling of the pickup.
The tax identification number (TIN) of a legal entity.
Name of the company requesting the pickup.
Version number for concurrency control to avoid conflicting updates. When using this method and making updates, the value of this parameter must be incremented by 1 for each subsequent change.
ISO Alpha-2 code for the pickup location.
^[A-Z]{2}$Start of the pickup time window, selected from available time intervals provided by the method that returns available time slots.
^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$End of the pickup time window, selected from available time intervals provided by the method that returns available time slots.
^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$Pickup request updated successfully.
Unique identifier for the updated pickup request.
Reference number for the pickup request.
^[A-Z]{4}\d{10}$Current pickup status, representing the different stages in the pickup process.
Possible values include:
- Draft: Initial stage where the pickup request is created but not yet finalized.
- Created: The pickup request has been created and is ready for processing.
- AppointedCourier: A courier has been assigned to the pickup request.
- InProgress: The pickup process is underway.
- Done: The pickup has been successfully completed.
- ClientCanceled: The pickup was canceled by the client.
- NotCompleted: The pickup process could not be completed.
- Deleted: The pickup request has been removed from the system.
- ReceivedByCourier: The parcel has been received by the courier.
Updated version number for concurrency control.
Updated notes for the courier.
Updated start of the pickup time window.
^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$Updated end of the pickup time window.
^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$Array of updated status objects tracking pickup status changes.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
The unique identifier of the pickup request.
This field is used to update the status of a pickup request to indicate that the pickup request is finalized and ready for processing by the shipment management system.
Version number for concurrency control to avoid conflicting updates. When using this method and making updates, the value of this parameter must be incremented by 1 for each subsequent change.
A required note or comment providing additional information about the reason for the status update. This field must be filled when changing the status to ensure proper tracking and context.
Status updated successfully
Indicates whether the status update was successful.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
Unique identifier of the pickup request to be deleted.
Pickup request deleted successfully.
The date-time when the pickup request was marked as deleted.
^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
The unique identifier of the pickup request.
Shipments removed successfully
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
Unique identifier of the pickup request to which shipments are being added.
Shipments successfully added to the pickup request.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Last updated