API-Referenz
Der Warehouse Client kommuniziert mit Business Central ausschließlich über eine OData-v4-API.
Diese Referenz richtet sich an Integratoren und Administratoren, die die Schnittstelle verstehen
oder erweitern möchten. Für die normale Nutzung der App ist sie nicht erforderlich.
| Eigenschaft |
Wert |
| Publisher |
altenbrand |
| API-Gruppe |
mcWarehouse |
| Version |
v1.0 |
| Basis-Pfad |
/api/altenbrand/mcWarehouse/v1.0/companies({id})/… |
| Authentifizierung |
OAuth2 (Microsoft Entra ID), siehe App-Überblick |
| Berechtigung |
Permission Set ALN MCWC API User (lesend) |
Lese-Endpunkte vs. Aktionen
Lesende Zugriffe (GET) laufen über OData-Entitäten. Schreibende Vorgänge (Buchen,
Sperren, Etiketten) laufen über gebundene Aktionen (POST), die jeweils Lizenz und
Terminal-Modul-Zugriff prüfen.
Lese-Endpunkte (Entitäten)
| Entity Set |
Quelle |
Zweck |
setup |
MC Warehouse Setup |
Effektive Konfiguration/Defaults |
terminals |
MC Warehouse Terminal |
Terminal-Registrierung & Metadaten (RIMD) |
termShipAgs |
Terminal Ship. Agent |
Erlaubte Versandagenten je Terminal |
packages |
MC Warehouse Package |
Pakete je Sendung (Multi-Paket) |
pickDocuments / pickLines |
Pick Document / Pick Line |
Picklisten und Positionen |
scanLogEntries |
Scan Log |
Audit-Protokoll der Scans |
openOrders |
Sales Header |
Freigegebene Aufträge für Picklisten |
purchaseOrders / purchaseLines |
Purchase Header / Line |
Bestellungen für den Wareneingang |
salesLines |
Sales Line |
Auftragspositionen |
salesShipments |
Sales Shipment Header |
Gebuchte Lieferungen |
itemLookups |
Item |
Artikelsuche (EAN/Barcode) |
itemLedgers |
Item Ledger Entry |
Lagerbuchungen |
postedInvoices / postedInvLines |
Sales Invoice Header / Line |
Gebuchte Rechnungen (Retoure/Reklamation) |
whseActivities / whseActLines |
Warehouse Activity Header / Line |
BC-Lagerbelege |
shipmentLabels / shipmentLines |
MC Shipment Label / Line |
Versandetiketten (Hub) |
complaints |
MC Warehouse Complaint |
Reklamationen |
assignmentLocks |
MC Warehouse Assignment Lock |
Beleg-Sperren |
Aktionen (POST)
Alle schreibenden Vorgänge laufen über gebundene Aktionen. Schreibaktionen prüfen vor der
Ausführung Lizenz und Terminal-Modul-Zugriff.
Sperren & Zuweisung
| Aktion |
Zweck |
AcquireLock / ReleaseLock |
Beleg für ein Terminal sperren/freigeben |
GetNextShipment |
Nächste Sendung dem Terminal zuweisen |
Wareneingang
| Aktion |
Zweck |
PostLineReceipt |
Eingang einer Bestellzeile buchen |
PostOrderReceipt |
Gesamte Bestellung als empfangen buchen |
Warenausgang & Versand
| Aktion |
Zweck |
CalculateShipWeight |
Versandgewicht eines Auftrags berechnen |
AddPackage / GetPackageCount |
Paket hinzufügen / Paketanzahl je Sendung |
PostShipment |
Lieferung (optional mit Rechnung) buchen |
CreateShipmentLabel |
Versandetikett über den Versandconnector erstellen |
GetShipmentLabelData / GetShipmentLabelByShipmentNo |
Etikettendaten (Base64) abrufen |
GetPackingListPdf |
Packliste als PDF abrufen |
GetShipmentNotifications / GetShipmentConfirmations |
Versandmeldungen/-bestätigungen |
GetShippingAgents |
Erlaubte Versandagenten des Terminals |
Kommissionierung
| Aktion |
Zweck |
ReleaseOrder |
Auftrag für die Kommissionierung freigeben |
RegisterPick |
BC-Lagerbeleg registrieren |
FindActivityByBarcode / GetOpenActivityCount |
Lagerbeleg per Barcode finden / offene zählen |
Artikel, Serien & Lagerplatz
| Aktion |
Zweck |
LookupBarcode / LookupBarcodeWithUOM |
Artikel per Barcode auflösen (inkl. Einheit) |
ValidateSerialNo / ValidateSerialNoForShipment |
Seriennummer prüfen |
AssignShelf / ValidateShelfCode |
Einlagern / Lagerplatzcode prüfen |
GetPendingPutawayItems / GetItemShelfInfo / GetItemBinContents |
Einlagerungs- und Lagerplatzinfos |
Etiketten, Foto & Verwiegung
| Aktion |
Zweck |
PrintItemLabel / GetLabelItemInfo |
Artikel-/Lagerplatzetikett (ZPL) |
UploadPhoto / GetPhotos / GetPhotoCount / DeletePhoto |
Belegfotos verwalten |
GetItemWeightInfo / SaveItemWeight |
Artikelgewichte lesen/speichern |
Retoure & Reklamation
| Aktion |
Zweck |
PostReturn |
Retoure als Gutschrift buchen |
PostServiceReturn |
Retoure als Retourenauftrag buchen |
PostComplaint / UpdateComplaintStatus |
Reklamation erfassen / Status ändern |
Konfiguration & Sonstiges
| Aktion |
Zweck |
GetEffectiveConfig |
Effektive Konfiguration inkl. Terminal-Overrides |
GetModuleCounts |
Badge-Zähler je Modul für das Hauptmenü |
ValidateSettingsPin |
Settings-PIN prüfen |
GetCompanyInfo |
Firmenname und Logo (für den App-Kopf) |
Nächste Schritte