PUT /api/v1/management/clients/ byCloud – RetailForce

Ce point de terminaison crée un nouveau client dans le middleware fiscal et l’associe à un terminal dans le RetailForce Cloud. Il correspond à la première étape de la mise en service d’une nouvelle caisse.

Résultats

Un appel réussi de ce point de terminaison (200)

crée un nouveau client dans le middleware, lui attribue l’uniqueClientId du terminal (Cloud) et
télécharge l’objet de configuration depuis le système Cloud et configure le client en conséquence.

Utilisation

Cette opération ne doit être effectuée qu’une seule fois, lors de la mise en service d’une nouvelle caisse enregistreuse. Tout nouvel appel du point de terminaison pour le même client (clientId) entraînera une erreur.

ATTENTION : si un client spécifique a déjà été connecté une fois au terminal créé dans le cloud (attribution de l’uniqueClientId), un nouvel appel de ce point de terminaison entraînera l’affichage du message d’erreur : « 409 - Client déjà existant ». Si un client doit être recréé (par exemple en cas de panne de disque dur, etc.), il convient d’utiliser le point de terminaison /api/v1/management/clients/recovery/restoreByCloud.

Prérequis

La structure organisationnelle et l’objet de configuration ont été créés dans RetailForce Cloud et attribués en conséquence
Le middleware fiscal est installé

Champs du formulaire

Les informations suivantes doivent être fournies :

Intitulé	Description	Exemple
Type	Type d’identification de l’entreprise. Ce type doit également avoir été saisi et figurer dans RetailForce Cloud. Les types suivants sont disponibles : [0] = VatNumber, [1] = taxNumber, [2] = GLNNumber, [3] = BusinessIdentificationNumber, [4] = Classification statistique, [5] = Numéro d’enregistrement au registre du commerce, [6] = Bureau d’enregistrement au registre du commerce, [7] = Numéro d’enregistrement au registre des métiers Voir également : Identification de l’entreprise Nous vous recommandons d’utiliser le type [0] = VatNumber comme identifiant principal dans tous les pays de l’UE, même s’il n’est pas utilisé comme identifiant obligatoire de l’entreprise dans le pays concerné.	[0] = VatNumber
Identification	L’identifiant de l’entreprise lui-même. Doit correspondre aux informations saisies dans RetailForce Cloud.	ATU57780814
storeNumber	Numéro de la succursale ou du magasin où est installée la caisse. Doit correspondre aux informations saisies dans RetailForce Cloud. ATTENTION : en France, le SIRET (extension du SIREN par le numéro de succursale) doit être indiqué ici.	S001, 12345 etc.
terminalNumber	Numéro de caisse. Doit correspondre aux informations saisies dans RetailForce Cloud.	0010
cloudApiKey	Clé API permettant d’authentifier la communication avec le Cloud	RFC_4a2abc...
cloudApiSecret	API Secret pour l'authentification de la communication avec le Cloud	ypts7u5OU...

Réponse

Réponses possibles :

Code	Description	Exemple
200	Le client a été créé et configuré avec succès. L’identifiant unique « uniqueClientId » est renvoyé dans l’objet de réponse. L’identifiant unique du client (uniqueClientId) doit être persisté par le système de point de vente et utilisé par celui-ci tout au long du processus de communication ultérieur (concernant le client).	3fa85f64-5717-4562-b3fc-2c963f66afa6
404	Aucune organisation n’a été trouvée dans RetailForce Cloud pour l’ID d’entreprise spécifié. Dépannage : Vérifiez l’ID de l’entreprise dans RetailForce Cloud et dans le système de point de vente. Créez une société (organisation ou entreprise) dans RetailForce Cloud.	-
406	En raison du type indiqué (code d'entreprise), aucune attribution claire n'est possible (par exemple, lorsque vous utilisez [6] = CommercialRegisterNumberOffice). Dépannage : Utilisez un autre type d’identifiant (par exemple [0] = VatNumber).	-
409	Un client portant l’identifiant unique « uniqueClientId » concerné existe déjà dans le service fiscal (Fiscal Middleware). Dépannage : Utilisez le client existant.	-

Cet article a été traduit automatiquement.