La fonction POST /api/v1/management/clients/{clientId}/GlobalShortId permet d’obtenir un ID unique au niveau mondial pour le client concerné et d’activer le retailForceReceiptId pour ce client.
Pour activer le renvoi futur du retailForceReceiptId, il suffit d’appeler cette fonction une seule fois.
Remarque :
si un client est restauré sur un nouveau système (POST /api/v1/management/clients/recovery/restoreByCloud
ou POST /api/v1/management/clients/recovery/restoreByCloud/ID
), la fonction doit être appelée à nouveau.
| Propriété | Description |
Exemple |
| GlobalShortId | ID unique au niveau mondial du client | 0p4j |
| retailForceReceiptId | Identifiant de document unique à l’échelle mondiale attribué par le système RetailForce |
Résultat
Un appel réussi de la fonction (200)
- renvoie le GlobalShortId du client correspondant dans le corps de la réponse et
- active la génération du retailForceReceiptId pour le client concerné.
Utilisation
Facultatif : permet de générer un identifiant unique à l’échelle mondiale pour le client (la caisse).
Conditions préalables
- Le client correspondant doit exister et être activé dans le système ;
- la requête PUT /api/v1/management/cloud/connect doit être exécutée avant l’appel de la fonction.
Champs du formulaire
Les informations suivantes doivent être fournies :
| Désignation | Description | Exemple |
| clientId | L'identifiant unique « uniqueClientId » de la caisse (issu du RetailForce system) | c1062c55-57c4-4ed2-9c53-aff1762326a4 |
Réponse
Réponses possibles :
| Code | Description | Exemple |
| 200 | L'identifiant GlobalShortId du client est renvoyé dans le corps de la réponse et la création du retailForceReceiptId est activée | 0p4j |
| 404 |
L'identifiant clientId spécifié est introuvable dans le magasin de configuration. Dépannage
|
La configuration du client a55f6442-5876-4943-bba2-7a97f2730621 est introuvable. |
Cet article a été traduit automatiquement.
Commentaires
0 commentaire
Vous devez vous connecter pour laisser un commentaire.