Pickups
Overview
The One-Time Pickups API lets you schedule on-demand courier pickups directly from your warehouse or other address location. Use it to create one time pickup orders and cancel orders when needed.
What can you do with the One-Time Pickups API
| Method | Endpoint | Description |
|---|---|---|
POST | /pickups/v1/organizations/{organizationId}/one-time-pickups | Create a new pickup order |
GET | /pickups/v1/organizations/{organizationId}/one-time-pickups | List pickup orders (paged) |
GET | /pickups/v1/organizations/{organizationId}/one-time-pickups/{orderId} | Retrieve details of a specific pickup order |
PUT | /pickups/v1/organizations/{organizationId}/one-time-pickups/{orderId}/cancel | Cancel a pickup order |
GET | /pickups/v1/cutoff-time | Get the latest pickup cutoff time for a postcode |
All endpoints require OAuth 2.1 authentication.
Availability
Currently, ordering via API is supported only in Poland from merchants with an active logistics contract.
Eligibility
One-time pickups are available exclusively to merchants with a signed logistics contract.
Scheduling
- Pickups can be scheduled up to 7 days in advance.
- For merchants who require recurring pickups, these must be arranged directly with an account manager. Recurring pickup setup is not available via API.
Same-day Pickups
Merchants can request a same-day pickup if the following conditions are met:
Cut-off time
- Each pickup location (down to postal code level) has its own cut-off time.
- Requests must be submitted before the cut-off time for same-day execution.
- The cut-off time can be retrieved using the
/cutoff-timemethod.
Pickup window
- The pickup window must fall within the same day, typically 09:00–18:00 (local time).
pickup_frommust be at or before the cut-off time.pickup_tomust be at least 120 minutes later thanpickup_from.pickup_tomust also be at least 120 minutes later than the current time at the moment the request is created.
Deduplication Rules
- Multiple pickups from the same address and time are not allowed.
- Exception: In commercial centers or logistics complexes, multiple pickups may be scheduled from the same address if a distinct
location_descriptionis provided (e.g., “Building A – Dock 3”).
One-time Pickup Statuses
Each pickup order progresses through a defined lifecycle.
Statuses are divided into non‑terminal (the order may still change) and terminal (the order is closed and will not transition further).
| Status | Type | Description |
|---|---|---|
| CREATED | non-terminal | Pickup order has been successfully created in the system and awaits further processing. |
| PENDING | non-terminal | Pickup order has been accepted for execution and is pending courier assignment or pickup. |
| RESCHEDULED | non-terminal | Pickup date was changed and the order remains active with an updated pickup schedule. |
| COLLECTED | terminal | Pickup was successfully completed and at least one shipment was physically collected by the courier. |
| CANCELLED | terminal | Pickup order was cancelled by the customer before execution. |
| DUPLICATED | terminal | Pickup order was identified as a duplicate of an existing order and therefore closed. |
| NONCOMPLIANT | terminal | Pickup order was closed because the actual shipment(s) did not comply with the declared order data or operational requirements. |
| INVALIDATED | terminal | Pickup order was rejected due to invalid, incomplete, or incorrect order data. |
| INFEASIBLE | terminal | Pickup could not be executed due to operational constraints (e.g. location, time window, or capacity limitations). |
| UNLABELLED | terminal | Pickup was attempted but shipment(s) had no valid shipping labels available at pickup time. |
| EMPTY | terminal | Pickup was attempted but no shipment was available at the pickup location. |
Important Notes
- Terminal statuses indicate that the pickup order is finished and will not change further.
- Statuses such as NONCOMPLIANT, INVALIDATED, UNLABELLED, and EMPTY represent operational rejection reasons, not customer‑initiated cancellations.
- CANCELLED is used exclusively when the pickup is explicitly cancelled by the merchant.
- A pickup may be rescheduled multiple times before reaching a terminal status.
API Documentation
Loading...