Abholbestellungen

Erstellen Sie wiederkehrende geplante Abholbestellungen. DPD holt Pakete von Ihrem Standort an bestimmten Tagen und in bestimmten Zeitfenstern ab.

Endpunkt	Authentifizierung
`POST /api/v1/pickup-orders`	Bearer JWT-Token erforderlich

Anfrage

Abfrageparameter: lang (optional) — z.B. de_CH, en_US, fr_CH, it_CH

Body: List<PickupOrderDTO>

Felder

Feld	Typ	Länge	Pflichtfeld	Beschreibung
`invoicingNumber`	String	1–20	Ja	Kundenrechnungsnummer
`pickupDate`	String	10	Ja	Geplantes Abholdatum (`yyyy-MM-dd`), muss in der Zukunft liegen
`weekDay`	Integer	—	Nein	Wochentag (1=Mo … 7=So). Wird aus `pickupDate` berechnet, wenn nicht angegeben
`fromTime1`	String	5	Nein	Beginn des morgendlichen Zeitfensters (`HH:mm`)
`toTime1`	String	5	Nein	Ende des morgendlichen Zeitfensters (`HH:mm`)
`fromTime2`	String	5	Nein	Beginn des nachmittäglichen Zeitfensters (`HH:mm`)
`toTime2`	String	5	Nein	Ende des nachmittäglichen Zeitfensters (`HH:mm`)
`address`	AddressDTO	—	Ja	Adresse des Abholorts
`numberOfParcels`	Integer	—	Ja	Erwartete Paketanzahl (1–99)
`tour`	String	0–50	Nein	Tour-/Routenkennung
`clientSoftware`	String	1–30	Ja	Name der Client-Anwendung. Fehlt der Wert oder ist er leer, wird die Anfrage abgelehnt
`clientVersion`	String	1–10	Ja	Version der Client-Anwendung. Fehlt der Wert oder ist er leer, wird die Anfrage abgelehnt

Zeitfenster

Sie können bis zu zwei Zeitfenster angeben (morgens und nachmittags). Lassen Sie die Nachmittagsfelder leer für ein einziges durchgehendes Fenster.

Fenster	Felder	Beispiel
Morgens	`fromTime1` / `toTime1`	`08:00` / `12:00`
Nachmittags	`fromTime2` / `toTime2`	`13:00` / `17:00`

Beispiel

curl -X POST "https://label-print-shipments.dpd.ch/api/v1/pickup-orders?lang=de_CH" \
  -H "Authorization: Bearer <jwt_token>" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "invoicingNumber": "12345678",
      "pickupDate": "<next working day, yyyy-MM-dd>",
      "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"
    }
  ]'

Antwort

201 Created — alle Bestellungen erstellt:

{
  "tracingId": "TRACE-321",
  "success": [
    { "tracingId": "123456789" }
  ],
  "failed": []
}

Jeder success[]-Eintrag enthält die dem erstellten Auftrag zugewiesene tracingId sowie identificationNumber, sofern der Anfrage-Eintrag einen Wert mitgeliefert hat. Ein id-Feld gibt es in einem Erfolgseintrag nicht — id erscheint nur in failed[]-Einträgen.

Null-Felder werden in Antworten weggelassen, daher enthält ein Erfolgseintrag häufig nur tracingId.

207 Multi-Status — Teilerfolg mit feldbezogenen Fehlern. Jeder Eintrag in failed[] enthält eine identificationNumber (spiegelt den vom Client übergebenen Wert, sofern der Eingabe-Eintrag einen hatte) und einen errorCode; Feldfehler erscheinen als flaches fieldErrors[]-Array, wobei jeder Eintrag seinen eigenen path trägt:

{
  "tracingId": "TRACE-322",
  "success": [],
  "failed": [
    {
      "identificationNumber": "client-supplied-id-5",
      "errorCode": "SYS-VALIDATION-FAILURE",
      "fieldErrors": [
        {
          "path": "numberOfParcels",
          "code": "SHP-VAL-NUMBEROFPARCELS-MAX-CHARACTERS",
          "message": "Number of parcels exceeds the maximum allowed length."
        },
        {
          "path": "address.countryCode",
          "code": "SHP-VAL-COUNTRYCODE-REQUIRED",
          "message": "Country code is required."
        }
      ]
    }
  ]
}

Ein vorübergehender Fehler (ohne fieldErrors – ein Ausfall ist kein Feldproblem) sieht dagegen so aus:

{
  "identificationNumber": "client-supplied-id-7",
  "errorCode": "SHP-ROUTING-ENGINE-UNAVAILABLE",
  "reason": "SHP-ROUTING-ENGINE-UNAVAILABLE: Routing engine is temporarily unavailable. Please try again."
}

Statuscodes:

Code	Beschreibung
`201 Created`	Alle Abholbestellungen erstellt
`207 Multi-Status`	Teilerfolg
`400 Bad Request`	Validierungsfehler, oder alle Positionen der Sammelanfrage sind fehlgeschlagen — unabhängig von der Ursache, auch bei einem Ausfall der Routing-Engine
`401 Unauthorized`	Token fehlt oder ungültig

Unterschied zu Abholaufträgen

	Abholbestellungen	Abholaufträge
Häufigkeit	Wiederkehrend (Wochenplan)	Einmalig
Zeitfenster	Bis zu 2 (morgens + nachmittags)	Von DPD festgelegt
Paketlimit	99	999
Gewichtsfeld	Nicht erforderlich	Optional (Gramm)

Anfrage​

Felder​

Zeitfenster​

Beispiel​

Antwort​

Unterschied zu Abholaufträgen​