The function POST /api/v1/management/clients/{clientId}/globalShortId is used to obtain a globally unique ID of the respective client and to activate the retailForceReceiptId for the respective client.
To activate the future return of the retailForceReceiptId, the function only needs to be called once.
Note: If a client is restored on a new system (POST /api/v1/management/clients/ recovery/restoreByCloud or POST /api/v1/management/clients/ recovery/restoreByCloud/Id), the function must be called again.
Property | Description |
Example |
globalShortId | globally unique ID of the client | 0p4j |
retailForceReceiptId | Globally unique document ID assigned by the RetailForce system |
Result
A successful call of the function (200)
- eturns the globalShortId of the corresponding client as the response body and
- activates the generation of the retailForceReceiptId for the respective client.
Usage
Optional to create a globally unique ID for the client (the cash register)
Prerequisites
- Der entsprechende Client muss im System vorhanden und aktiviert sein;
- PUT /api/v1/management/cloud/connect muss vor Aufruf der Funktion ausgeführt werden.
Form fields
The following information must be provided:
Designation | Description | Example |
clientId | The uniqueClientId of the cash register (from the RetailForce system) | c1062c55-57c4-4ed2-9c53-aff1762326a4 |
Response
Possible responses:
Code | Description | Example |
200 | GlobalShortId des Clients wird im Response-Body zurückgegeben und Erstellung retailForceReceiptId aktiviert | 0p4j |
404 |
The specified ClientId could not be found in the Config Store. Troubleshooting
|
Client configuration for a55f6442-5876-4943-bba2-7a97f2730621 was not found. |
Comments
0 comments
Please sign in to leave a comment.