GET /api/v1/management/clients/ {clientId} – RetailForce

Ce point de terminaison renvoie des informations relatives à un clientId spécifique. Il sert à récupérer des détails concernant un client particulier, notamment :

Les données d’identification unique du client
Informations de licence
Les données relatives à l’entreprise
Données commerciales
Les données relatives au point de vente
Paramètres divers

Attention : il est important de noter que l’identifiant clientId doit exister dans le système local. S’il n’existe pas, le message d’erreur « Le client n’existe pas. (Paramètre « clientId ») » s’affichera. Une analyse plus approfondie peut s’avérer nécessaire pour déterminer pourquoi l’identifiant clientId n’est pas présent dans le système local. Si le client n’a pas encore été mis en service, il convient de le faire au préalable.

Résultat

Un appel réussi vers le point de terminaison renvoie une réponse HTTP 200 et un objet JSON contenant les informations du client demandées.

Exemple :

{
  "uniqueClientId": "4ac109f5-5c7b-4173-b3b7-b403f472ac8f",
  "licenseConsumerId": "f2a72f8c-104a-4fc1-add7-8f1254bce787",
  "usedVersion": "1.7.1.0",
  "distributerId": "20b7abfc-6abb-352e-b1fe-a14b1e507482",
  "licenseKey": "xxxJhbGciOiJodHRwOi8zd3d3LmczLm7yZy8yMDAxLzA0L3htbGRzaWbtbW9zZ...",
  "fiscalCountry": "[0] = Germany",
  "fiscalRegion": null,
  "companyNumber": "003",
  "companyName": "Test Company - DE",
  "companyAddress": {
    "street": "Test Street",
    "streetNumber": "99",
    "postalCode": "10115",
    "city": "Berlin",
    "countryCode": "DEU"
  },
  "companyIdentification": [
    {
      "type": "[0] = VatNumber",
      "identification": "TEST_000000"
    }
  ],
  "companyVatNumber": "TEST_000000",
  "companyTaxNumber": null,
  "fiscalYearStartMonth": 0,
  "storeNumber": "00345",
  "storeName": "Test Store 06 - DE",
  "storeAddress": {
    "street": "Test Street",
    "streetNumber": "1",
    "postalCode": "10115",
    "city": "Berlin",
    "countryCode": "DEU"
  },
  "terminalNumber": "00345",
  "cashRegister": {
    "id": "00000001",
    "brand": "Test Model",
    "modelname": "Model A",
    "serialNumber": "123",
    "currencyIsoCode": "EUR",
    "software": {
      "brand": "Test POS Software",
      "version": "4.40.14",
      "softwareCompany": "Test POS Company"
    }
  },
  "testClient": true,
  "fiscalModulImplementationConfiguration": {
    "primaryTse": {
      "tseDriver": "[99] = xxxxx",
      "tseId": "xxxx....",
      "tseGuid": null,
      "useTseGuid": false,
      "tseParameter": [
        {
          "parameterName": "apiKey",
          "parameterValue": "test_xxx_test"
        },
        {
          "parameterName": "apiSecret",
          "parameterValue": "test_xyz_test"
        },
        {
          "parameterName": "tseAdminPin",
          "parameterValue": "123456"
        },
        {
          "parameterName": "tseAdminPuk",
          "parameterValue": "4099817164"
        },
        {
          "parameterName": "tseMaxClients",
          "parameterValue": ""
        }
      ]
    },
    "fiscalCountry": "[0] = Germany",
    "taxonomyFileStoreConfiguration": {
      "localStorePath": "C:\\ProgramData\\RetailForce\\Fiscal Webservice",
      "compress": true
    },
    "taxonomyCloudStoreConfiguration": null
  },
  "simpleCashPointClosing": true
}

Utilisation

Ce point de terminaison sert à récupérer des informations sur un client spécifique.

Prérequis

RetailForce Middleware doit être installé,
le client concerné doit être activé et présent dans le système local.

Champs du formulaire

Les informations suivantes doivent être fournies :

Libellé	Description	Exemples
clientId	L'ID du client à récupérer	aa227e71-6775-45d0-ba73-85da33c34d37

Réponse

Réponses possibles :

Code	Description	Exemples
200	Requête réussie. Les informations relatives à l'identifiant clientId demandé sont renvoyées dans un objet JSON.	FORMAT JSON
422	Le ClientId demandé n'existe pas dans le système local. Dépannage : Analysez la cause pour laquelle le client n'existe pas (ou plus) dans le système local.	« Message » : « Le client n'existe pas. (Paramètre « clientId ») »
404	Le ClientId demandé n'existe pas dans le système local. Dépannage : Analysez la cause pour laquelle le client n'existe pas (ou plus) dans le système local.	« Message » : « La configuration du client aa227e71-6775-45d0-ba73-85da33c34d37 est introuvable. »

Cet article a été traduit automatiquement.

Résultat

Champs du formulaire

Réponse

Articles associés