A função POST /api/v1/management/clients/{clientId}/GlobalShortId é utilizada para obter um ID globalmente único do respetivo cliente e para ativar o retailForceReceiptId para o respetivo cliente.
Para ativar a futura devolução do «retailForceReceiptId», basta chamar a função uma única vez.
Nota:
Se um client for restaurado em um novo sistema (POST /api/v1/management/clients/recovery/restoreByCloud
ou POST /api/v1/management/clients/recovery/restoreByCloud/ID
), a função deve ser chamada novamente.
| Propriedade | Descrição |
Exemplo |
| GlobalShortId | ID globalmente único do client | 0p4j |
| retailForceReceiptId | ID do documento, único a nível global, atribuído pelo RetailForce system |
Resultado
Uma chamada bem-sucedida da função (200)
- retorna o GlobalShortId do client correspondente como corpo da resposta e
- ativa a geração do retailForceReceiptId para o respetivo client.
Utilização
Opcional para criar um ID globalmente único para o client (a caixa registadora)
Pré-requisitos
- O client correspondente deve estar presente e ativado no sistema;
- A chamada PUT /api/v1/management/cloud/connect deve ser executada antes de chamar a função.
Campos do formulário
Devem ser fornecidas as seguintes informações:
| Designação | Descrição | Exemplo |
| clientId | O uniqueClientId da caixa registadora (do RetailForce system) | c1062c55-57c4-4ed2-9c53-aff1762326a4 |
Resposta
Respostas possíveis:
| Código | Descrição | Exemplo |
| 200 | O GlobalShortId do cliente é devolvido no corpo da resposta e a criação do retailForceReceiptId é ativada | 0p4j |
| 404 |
Não foi possível encontrar o clientId especificado no Config Store. Resolução de problemas
|
Não foi encontrada a configuração do client para a55f6442-5876-4943-bba2-7a97f2730621. |
Este artigo foi traduzido automaticamente.
Comentários
0 comentários
iniciar sessão para comentar.