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
| Parameter | Typ | Pflicht | Beschreibung |
| company | string | nein | Firma |
| addressAddition | string | nein | Adresszusatz 1 |
| attn | string | nein | Ansprechpartner |
| street | string | ja | Straße + Hausnummer |
| addressExtra | string | nein | Adresszusatz 2 |
| postalCode | string | ja | PLZ |
| city | string | ja | Stadt |
| country | string | ja | Ländercode (ISO) |
| gln | string | nein | Global 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
| Parameter | Typ | Pflicht | Beschreibung |
| gender | string | ja | Geschlecht: MALE, FEMALE, UNKNOWN |
| title | string | nein | Titel |
| string | ja | ||
| lastName | string | ja | Nachname |
| firstName | string | ja | Vorname |
| department | string | nein | Abteilung |
| phone | string | ja | Telefon |
| mobile | string | nein | Mobilfunk |
| fax | string | nein | Fax |
| position | string | nein | Position |
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.
| Parameter | Pflicht | Beschreibung |
| serviceLevelId | ja | Service-Level-ID |
| pickupAddressId | ja | Adresse-ID der Abholadresse |
| supplierContactId | ja | Kontaktperson-ID |
| desiredDate | ja | Wunschdatum für die Abholung (unverbindlich) |
| type | ja | Auftragsart: Abholung (PICKUP) oder Anlieferung (DELIVERY) |
| reference | ja | Referenz |
| memo | ja | Hinweise für die Abholung |
| additionalInformation.loadIn20Min | ja | Voraussichtlich verladbar in 20 Minuten |
| additionalInformation.wareLooseAfbPack | ja | Ware bereits verpackt |
| additionalInformation.assistantNeeded | ja | Weitere Hilfskräfte für die Verladung notwendig |
| additionalInformation.partnerAssistant | ja | Weitere Hilfskräfte durch Partner gestellt |
| additionalInformation. notContainingLithiumIonBatteries | ja | Bestätigung, dass keine sicherheitskritisch defekten Lithium-Ionen-Batterien in der Abholung enthalten sind |
| storageTypes[] | Angabe der Transportmittel für die Abholung | |
| storageTypes[].id | nein | Transportmittel-ID |
| storageTypes[].toRemainAtPartner | nein | Menge zum Verbleib beim Partner (für spätere Abholungen) |
| storageTypes[].toPackForPickUp | nein | Menge für die aktuelle Abholung notwendig |
| noExchangeCollis | ja | Angabe dazu, wenn keine Transportmittel notwendig sind |

