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

Este ponto de extremidade devolve informações sobre um clientId específico. É utilizado para recuperar detalhes sobre um determinado cliente, incluindo:

Dados de identificação únicos do cliente
Informações sobre a licença
Dados da empresa
Dados comerciais
Informações relativas à caixa registadora
Vários parâmetros

Atenção: É importante ter em conta que o clientId deve existir no sistema local. Caso não exista, será devolvida a mensagem de erro «O cliente não existe. (Parâmetro 'clientId')». Poderá ser necessária uma análise mais aprofundada para determinar a razão pela qual o clientId não se encontra no sistema local. Caso o cliente ainda não tenha sido colocado em funcionamento, tal deve ser feito em primeiro lugar.

Resultado

Uma chamada bem-sucedida ao ponto de extremidade devolve uma resposta HTTP 200 e um objeto JSON contendo as informações solicitadas sobre o client.

Exemplo:

{
  "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
}

Utilização

Este ponto de extremidade é utilizado para recuperar informações sobre um client específico.

Requisitos

O RetailForce Middleware Fiscal deve estar instalado,
relevant client ativado e presente no sistema local.

Campos do formulário

É necessário fornecer as seguintes informações:

Rótulo	Descrição	Exemplos
clientId	O ID do client a recuperar	aa227e71-6775-45d0-ba73-85da33c34d37

Resposta

Respostas possíveis:

Código	Descrição	Exemplos
200	Pedido bem-sucedido. A informação relativa ao clientId solicitado é devolvida num objeto JSON.	FORMATO JSON
422	O clientId solicitado não existe no sistema local. Resolução de problemas: Analise a causa pela qual o client já não existe no sistema local.	«Mensagem»: «O cliente não existe. (Parâmetro 'clientId')»
404	O clientId solicitado não existe no sistema local. Resolução de problemas: Analise a causa pela qual o client já não existe no sistema local.	"Mensagem": "Não foi encontrada a configuração do client para aa227e71-6775-45d0-ba73-85da33c34d37."

Este artigo foi traduzido automaticamente.

Resultado

Campos do formulário

Resposta

Artigos relacionados