This endpoint allows the recovery of a client in the RetailForce Middleware, with data (including configuration information) from the RetailForce Cloud.
A recovery of a client may be necessary in case of a change in cash register hardware or hardware defects.
The function POST /api/v1/management/clients/recovery/restoreByCloud/Id is essentially identical to PUT /api/v1/management/clients/byCloud however, the latter can only be executed once during the initial commissioning of a client.
Result
A successful call to the endpoint (200):
- Recovers an existing client in the Middleware and assigns the corresponding uniqueClientId of the terminal from the RetailForce Cloud to this client.
- Downloads the configuration object from the Cloud system again and configures the client accordingly.
Usage
This endpoint is used when a client, which has already been created once and whose ClientId is known, needs to be recovered (such as in the case of a change in hardware).
Prerequisites
- The client must have been created once and the ClientId should be known.
- Organizational structure and configuration object have been created in the RetailForce Cloud and assigned accordingly.
- Fiscal Middleware installed.
Form fields
The following information must be transmitted:
| Name | Description | Examples |
| Type |
Type of the company identification. The Type must also be entered and exist in the RetailForce Cloud. Following types are available: [0] = VatNumber, See also: Company identification We recommend using Type [0] = VatNumber as the primary ID in all countries (EU), even if it is not used as a mandatory company identifier in the respective country. |
[0] = VatNumber |
| Identification |
The company identifier itself. It must match the information that was entered in the RetailForce Cloud. |
ATU57780814 |
| storeNumber |
The number of the store where the cash register is located. It must match the information that was entered in the RetailForce Cloud. NOTE: in France, the SIRET (extension of the SIREN by the store number) should be given here.
|
|
| terminalNumber |
Cash register number. It must match the information that was entered in the RetailForce Cloud. |
0010 |
| cloudApiKey | API Key to authenticate the Cloud communication | RFC_4a2abc... |
| cloudApiSecret |
API Secret for authenticating Cloud communication |
ypts7u5OU... |
Response
Possible responses:
| Code | Description | Example |
| 200 | The client was successfully restored and configured. The response object returns the uniqueClientId of the restored client. The uniqueClientId must be stored by the cash register system and used for the entire further communication process (concerning the client). | b7cf6d59-cec4-4cc2-a647-01XXXX |
| 406 |
The type of the specified company identifier is not a unique type. Error handling: Use one of the following company identifiers: [0] = VatNumber, |
- |
Comments
0 comments
Please sign in to leave a comment.