Die Funktion POST /api/v1/management/clients/{clientId}/globalShortId wird verwendet, um eine global eindeutige ID des jeweiligen Clients zu erhalten, sowie die retailForceReceiptId für den jeweiligen Client zu aktivieren.
Zur Aktivierung der künftigen Rückgabe der retailForceReceiptId muss die Funktion lediglich einmal aufgerufen werden.
Hinweis: wird ein Client auf einem neuen System wiederhergestellt (POST /api/v1/management/clients/ recovery/restoreByCloud bzw. POST /api/v1/management/clients/ recovery/restoreByCloud/Id), muss die Funktion erneut aufgerufen werden.
| Eigenschaft | Beschreibung | Beispiel |
| globalShortId | global eindeutige ID des Clients | 0p4j |
| retailForceReceiptId | vom RetailForce System vergebene global eindeutige Dokumenten-ID |
Ergebnis
Ein erfolgreicher Aufruf des Endpunktes (200)
- gibt die globalShortId des entsprechenden Clients als Response-Body zurück und
- aktiviert die Erzeugung der retailForceReceiptId für den jeweiligen Client.
Verwendung
Optional zu Erstellung einer global eindeutigen ID für den Client (die Kasse)
Voraussetzungen
- Der entsprechende Client muss im System vorhanden und aktiviert sein;
- PUT /api/v1/management/cloud/connect muss vor Aufruf der Funktion ausgeführt werden.
Formularfelder
Folgende Informationen müssen übermittelt werden:
| Bezeichnung | Beschreibung | Beispiel |
| clientId | Die uniqueClientId der Registrierkasse (aus RetailForce System) | c1062c55-57c4-4ed2-9c53-aff1762326a4 |
Antwort
Mögliche Antworten:
| Code | Beschreibung | Beispiel |
| 200 | GlobalShortId des Clients wird im Response-Body zurückgegeben und Erstellung retailForceReceiptId aktiviert | 0p4j |
| 404 |
Die angegebene ClientId konnte im Config-Store nicht gefunden werden. Fehlerbehebung:
|
Client configuration for a55f6442-5876-4943-bba2-7a97f2730621 was not found. |
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.