Pickup Orders
Create scheduled recurring pickup orders. DPD will collect parcels from your location on specified days and time windows.
Endpoint: POST /api/v1/pickup-orders
Auth: Bearer JWT token required
Request
Query parameter: locale (optional) — e.g., de_CH, en_US, fr_CH, it_CH
Body: List<PickupOrderDTO>
Fields
| Field | Type | Length | Required | Description |
|---|---|---|---|---|
invoicingNumber | String | 1–20 | Mandatory | Customer billing number |
pickupDate | String | 10 | Mandatory | Scheduled pickup date (yyyy-MM-dd), must be future |
weekDay | Integer | — | Optional | Day of week (1=Mon … 7=Sun). Auto-calculated from pickupDate if omitted |
fromTime1 | String | 5 | Optional | Morning time window start (HH:mm) |
toTime1 | String | 5 | Optional | Morning time window end (HH:mm) |
fromTime2 | String | 5 | Optional | Afternoon time window start (HH:mm) |
toTime2 | String | 5 | Optional | Afternoon time window end (HH:mm) |
address | AddressDTO | — | Mandatory | Pickup location address |
numberOfParcels | Integer | — | Mandatory | Expected number of parcels (1–99) |
tour | String | 0–50 | Optional | Tour/route identifier |
clientSoftware | String | 0–50 | Optional | Client application name |
clientVersion | String | 0–20 | Optional | Client application version |
Time windows
You can specify up to two time windows (morning and afternoon). Leave afternoon fields empty for a single continuous window.
| Window | Fields | Example |
|---|---|---|
| Morning | fromTime1 / toTime1 | 08:00 / 12:00 |
| Afternoon | fromTime2 / toTime2 | 13:00 / 17:00 |
Example
curl -X POST "https://label-print-shipments.dpd.ch/api/v1/pickup-orders?locale=de_CH" \
-H "Authorization: Bearer <jwt_token>" \
-H "Content-Type: application/json" \
-d '[
{
"invoicingNumber": "12345678",
"pickupDate": "2025-10-31",
"weekDay": 5,
"fromTime1": "08:00",
"toTime1": "12:00",
"fromTime2": "13:00",
"toTime2": "17:00",
"numberOfParcels": 15,
"address": {
"name": "Warehouse Location A",
"countryCode": "CH",
"zipCode": "8000",
"city": "Zürich",
"street": "Industriestrasse 45",
"phone": "+41441234567",
"email": "warehouse@company.ch",
"reference": "WAREHOUSE-A"
},
"tour": "TOUR-ZH-WEST",
"clientSoftware": "Customer App",
"clientVersion": "4.0.0"
}
]'
Response
201 Created — all orders created:
{
"tracingId": "TRACE-321",
"success": [
{ "id": 1, "tracingId": "123456789" }
],
"failed": []
}
207 Multi-Status — partial success with field-level errors:
{
"tracingId": "TRACE-322",
"success": [],
"failed": [
{
"id": 1,
"fieldErrors": {
"numberOfParcels": ["MAX_99"],
"address.countryCode": ["REQUIRED"]
}
}
]
}
Status codes:
| Code | Description |
|---|---|
201 Created | All pickup orders created |
207 Multi-Status | Some succeeded, some failed |
400 Bad Request | Validation error |
401 Unauthorized | Missing or invalid token |
Difference from Collection Requests
| Pickup Orders | Collection Requests | |
|---|---|---|
| Frequency | Recurring (weekly schedule) | One-time |
| Time windows | Up to 2 (morning + afternoon) | Defined by DPD |
| Parcels limit | 99 | 999 |
| Weight field | Not required | Optional (grams) |