Abholaufträge

Die Nutzung der verschiedenen Endpunkte ermöglicht die Erstellung und Abfrage von Abholaufträgen.

Servicelevel

Dieser Endpunkt beauskunftet die zwischen Ihnen und afb vereinbarten und freigegebenen Servicelevel für die Datenlöschung der übergebenen Geräte.

Es ist nicht möglich weitere Servicelevel über den Endpunkt freizugeben – hierfür sprechen Sie bitte Ihre Ansprechperson aus unserem Partnermanagement an.

Beispiel-Response:
[
  {
    "id": "519BF2D3-E44D-43B0-BEA3-xxxxxxxxxxxx",
    "key": "BSI",
    "description": "BSI Grundschutz, Blancco SSD Erasure - ATA",
    "descriptionEN": "BSI Grundschutz, Blancco SSD Erasure - ATA"
  }
]

Adresse

An dieser Stelle können Abholadressen verwaltet werden. Die Abholadressen werden von der afb bei einer Abholung angefahren.

Folgende Aktionen sind erlaubt:

  • Neu-Anlage von Abholadressen
  • Aktualisieren von Abholadressen
  • Entfernen von Abholadressen
  • Anzeige aller eingetragenen Abholadressen

Parameter

ParameterTypPflichtBeschreibung
companystringneinFirma
addressAdditionstringneinAdresszusatz 1
attnstringneinAnsprechpartner
streetstringjaStraße + Hausnummer
addressExtrastringneinAdresszusatz 2
postalCodestringjaPLZ
citystringjaStadt
countrystringjaLändercode (ISO)
glnstringneinGlobal Location Number ([0-9 ]*)
Beispiel-Response:
[
  {
    "id": "C702E782-F0FE-450B-B8F5-xxxxxxxxx",
    "company": "Musterfirma",
    "addressAddition": null,
    "attn": "Max Mustermann",
    "street": "Musterstraße 3",
    "addressExtra": "Hinterhaus",
    "postalCode": "12345",
    "city": "Musterstadt",
    "country": "DE",
    "gln": null
  }
]

Ansprechpartner

An dieser Stelle können Ansprechpartner verwaltet werden. Die Ansprechpartner werden von der afb bei einer Abholung kontaktiert.

Folgende Aktionen sind erlaubt:

  • Neu-Anlage von Ansprechpartnern
  • Aktualisieren von Ansprechpartnern
  • Entfernen von Ansprechpartnern
  • Anzeige aller eingetragenen Ansprechpartnern

Parameter

ParameterTypPflichtBeschreibung
genderstringjaGeschlecht: MALE, FEMALE, UNKNOWN
titlestringneinTitel
emailstringjaE-Mail
lastNamestringjaNachname
firstNamestringjaVorname
departmentstringneinAbteilung
phonestringjaTelefon
mobilestringneinMobilfunk
faxstringneinFax
positionstringneinPosition
Beispiel-Response:
[
  {
    "id": "90C3179F-4D64-4B4E-9E7D-xxxxxxxxx",
    "gender": "MALE",
    "title": "Dr.",
    "lastName": "Max",
    "firstName": "Mustermann",
    "department": "IT",
    "phone": "1111/3333999",
    "mobile": "2222/333333",
    "fax": "33333/44444",
    "email": "",
    "position": "Chief"
  }
]

Transportmittel

Dieser Endpunkt beauskunftet die zwischen Ihnen und der afb freigegeben Transportmittel, die bei einer Abholung verwendet werden dürfen.

Es ist nicht möglich weitere Transportmittel über den Endpunkt freizugeben – hierfür sprechen Sie bitte ihren bekannten Partnermanager an.

Beispiel-Response:
[
  {
    "id": "32BDE0C0-6F3D-4D23-8023-xxxxxxxxxx",
    "name": "Notebook-Box",
    "description": "-"
  },
  {
    "id": "ADB4082D-72D9-4816-AF15- xxxxxxxxxx",
    "name": "Notebook-Box lockable",
    "description": "-"
  },
  {
    "id": "956745C8-6FA3-4366-9EE3- xxxxxxxxxx",
    "name": "Roll grid car",
    "description": "Wheeled lattice cabinet"
  }
]

Abholaufträge abrufen

In dieser filterbaren Abfrage können alle ihrem Partner zugeordneten Aufträge abgerufen werden. Alle verfügbaren Felder sind filterbar.

Beispiele für Abfragen:

  • Alle Aufträge in einem bestimmten Zeitraum
  • Alle Aufträge an einer bestimmten Abholaderesse
  • Alle Aufträge in einem bestimmten Status
  • Alle Aufträge zu einer bestimmten definierten Referenz
Beispiel-Response:
[
  {
    "id": "PC-0401xx",
    "reference": null,
    "pickupAddressId": "C702E782-F0FE-450B-B8F5-xxxxxxxxxxx",
    "state": "precaptured",
    "stateId": 6,
    "creationDate": "2025-03-28T12:24:12.257Z"
  },
  {
    "id": "PC-0401xx",
    "reference": null,
    "pickupAddressId": "C702E782-F0FE-450B-B8F5-xxxxxxxxxxx",
    "state": "Done",
    "stateId": 4,
    "creationDate": "2025-03-28T12:26:21.073Z"
  }
]

Auftrag erzeugen

Die Erstellung eines Abholauftrags erfordert die Daten aus den vorhergehend beschriebenen Endpunkten für Servicelevel, Adressen, Ansprechpartner und Transportmittel.

Bei der Erstellung eines neuen Abholauftrags werden sowohl Ihr bekannter Partnermanager als auch hinterlegte Ansprechpartner des Partners per E-Mail über die Auftragsanlage informiert.

Eine nachträgliche Änderung von Auftragsdaten ist an der API nicht vorgesehen.

ParameterPflichtBeschreibung
serviceLevelIdjaService-Level-ID
pickupAddressIdjaAdresse-ID der Abholadresse
supplierContactIdjaKontaktperson-ID
desiredDatejaWunschdatum für die Abholung (unverbindlich)
typejaAuftragsart: Abholung (PICKUP) oder Anlieferung (DELIVERY)
referencejaReferenz
memojaHinweise für die Abholung
additionalInformation.loadIn20MinjaVoraussichtlich verladbar in 20 Minuten
additionalInformation.wareLooseAfbPackjaWare bereits verpackt
additionalInformation.assistantNeededjaWeitere Hilfskräfte für die Verladung notwendig
additionalInformation.partnerAssistantjaWeitere Hilfskräfte durch Partner gestellt
additionalInformation. notContainingLithiumIonBatteriesjaBestätigung, dass keine sicherheitskritisch defekten Lithium-Ionen-Batterien in der Abholung enthalten sind
storageTypes[] Angabe der Transportmittel für die Abholung
storageTypes[].idneinTransportmittel-ID
storageTypes[].toRemainAtPartnerneinMenge zum Verbleib beim Partner (für spätere Abholungen)
storageTypes[].toPackForPickUpneinMenge für die aktuelle Abholung notwendig
noExchangeCollisjaAngabe dazu, wenn keine Transportmittel notwendig sind