TOTVS Distribuição e Varejo - linha Winthor

Páginas filhas
  • DDLEGFIN-2313 - API Varejo - Dados do Cupom Fiscal / Operador de Caixa - DT - Inovação


01. DADOS GERAIS

Produto:

TOTVS Distribuição e Varejo

Linha de Produto:

Linha Winthor

Segmento:

Varejo

Módulo:20 - Auto Serviço
País:Brasil
Ticket:DDLEGFIN-2727
DDLEGFIN-2475
DDLEGFIN-2474
Requisito/Story/Issue:DDLEGFIN-2727
DDLEGFIN-2475
DDLEGFIN-2474


02. SITUAÇÃO/REQUISITO

Criar API do Varejo, para expor dados de vendas do caixa e informações do caixa.

03. SOLUÇÃO

Criada a API do Varejo que retorna os dados do cupom fiscal, juntamente os itens e o pagamento da venda realizada, dados do operador de caixa. de acordo com o modelo da Mercafácil. A API disponibilizada utiliza o formato JSON para a comunicação, portanto sugerimos que você utilize Content-Type: application/json nos headers das requisições. 

Endpoints disponíveis:

Listagem: GET /operators/ - Será listado os operadores de caixa e supervisores de caixa ativos;
Listagem: GET /coupons&date=(dd/mm/yyyy) - Será listado os dados de cupons emitidos na data selecionada;

Requisitos:

Para utilizar os endpoints disponíveis é necessário que esteja autenticado e com sessão ativa e local no WTA;


Atualize as rotinas abaixo a partir da versões indicadas ou versões superiores:

  • Rotina 2000- Atualizar Procedure do Auto-Serviço 30.4.0.185;
  • Rotina WTA - 801 - Atualização de Serviços Web:
    • PCBANDEIRASITEF - Versão 1.3.01.00 ou superior;
    • WINTHOR-VAREJO  - Versão 1.0.1.3 ou superior;

Passo a passo:

  • Acesse no WTA - a rotina 801 - Atualização de Serviços Web
  • Pesquise por Varejo e instale o serviço que possui como dependência de banco a tabela PCBANDEIRASITEF;
  • Pesquise e atualize o serviço WINTHOR-VAREJO;


  • Abra a rotina 2000 -Atualizar Procedure do Auto-Serviço  e selecione a opção Ajustar códigos e nomes de bandeiras do SiTef (Bandeira SiTef Padrão versão 2.59) ”;
  • Após selecionar, clique no botão Atualizar e após a execução, feche a rotina para que atualização do banco seja efetuada;


API Varejo - Dados do Cupom Fiscal e Operador/Fiscal de Caixa


Endpoint /operators/

GET - Consulta Operadores de Caixa e Supervisores de Caixa

http://localhost:85/api/retail/v1/mercafacil/operators/


Nesta requisição são listados todos os funcionários ativos com acesso ao PDV, operadores de caixa e fiscais de caixa.

Exemplo da Requisição

curl --location --request GET 'http://localhost:85/api/retail/v1/mercafacil/operators/'
 
GET/api/retail/v1/mercafacil/operators/
Host exemplo: https://localhost:85

Reposta da requisição 

Caso esteja autenticado no WTA, a resposta será retornada no seguinte formato:

Status 200 OK

{
    "id": "8889",
    "name": "SILVIO SANTOS FARIA LIMA",
    "document_no": "001.000.005-00",
    "birth_date": "1998-05-29 00:00:00.0",
    "gender": "F"
}


Endpoint /coupons/

GET - Cupons Fiscais


http://localhost:83/api/retail/v1/mercafacil/coupons?date=dd/mm/yyyy


Nesta requisição são listados todos os cupons fiscais emitidos na data informada.

curl --location --request GET 'http://localhost:85/api/retail/v1/mercafacil/coupons?date=10/09/2021'
 
GET/api/retail/v1/mercafacil/operators/
Host exemplo: https://localhost:85
Query Params: date={dd/mm/yyyy}


Reposta da requisição 

Caso esteja autenticado no WTA, a resposta será retornada no seguinte formato:

Status 200 OK


 {
        "origin": "pdv",
        "transaction_id": "10001064",
        "client_id": "11111111111",
        "operator_id": "1",
        "pdv_code": "1",
        "coupon": "110092021103011204",
        "total_value": 9.5,
        "total_value_with_discount": 9.5,
        "date": "2021-09-10",
        "time": "10:30",
        "items": [
            {
                "product_name": "CIGARRO DUNHILL CARLTON BLEND",
                "sku": "100",
                "ean": "100",
                "departament": "CIGARRO DUNHILL CARLTON BLEND",
                "group": "BAZAR",
                "family": "CIGARRO/ISQUEIRO",
                "unit_value": 9.5,
                "quantity": 1,
                "total_value": 9.5,
                "total_value_with_discount": 9.5
            }
        ],
        "payments": [
            {
                "payment_form": "other",
                "amount": 9.5,
                "acquirer_id": "05",
                "acquirer_name": "",
                "authorizer_id": "00002",
                "authorizer_name": "MASTERCARD",
                "instalments": 1
            }
        ]
    }


Exemplos das requisições feitas via Postman:

/operators/



/coupons?date=10/09/2021



 

Observações:

  • Para utilizar os recursos da API, o usuário deverá estar autenticado. Caso essa autenticação seja via API, siga os passos seguintes:

    Endpoint /login/

    POST - Login Winthor/WTA

    http://localhost:85/winthor/autenticacao/v1/login

    curl --location --request POST 'http://localhost:85/winthor/autenticacao/v1/login' 

     
    POST/winthor/autenticacao/v1/login
    Host exemplo: https://localhost:85

    Nesta requisição é feito o login no ambiente Winthor /  WTA. 

    Body -JSON

    {
      "login": "{{Usuário}}",
      "senha": "{{Senha}}"
    }


    No campo senha, utilize a senha do Winthor / WTA codificado no padrão MD5 (pode ser feito com ferramentas on-line, por exemplo MD5 Hash Generator ) e com letras em caixa alta. 

    Exemplo:

    Usuário: admin
    Senha: 1

    Senha após codificar para MD5 = C4CA4238A0B923820DCC509A6F75849B



    Reposta da requisição 

    Caso o login seja efetuado com sucesso retornará Status 200 OK .

04. DEMAIS INFORMAÇÕES


Importante!

As versões estarão disponíveis para download no CCW. 

https://centraldecontrole.pcinformatica.com.br/


Mantenha suas rotinas sempre atualizadas!



05. ASSUNTOS RELACIONADOS