Integração Linx Extrator de Vendas: Chamada API GraphQl
Exemplo do objeto Json de chamada:
{ "input": { "idEstabelecimentoERP": "000010", "dataInicial": "2019-01-01", "dataFinal": "2020-03-31", "regerar": false, "sistema": 1 } }
Atenção
Abaixo são apresentados os campos, sua obrigatoriedade, os tipos do campo, tamanho máximo de cada campo, assim como uma breve descrição de cada campo.
Campo | Obrigatório | Tipo do Campo | Tamanho Máximo | Conteúdo |
IdEstabelecimentoERP | Sim | Alfanumérico | 50 | Código que identifica a loja/filial onde a venda foi registrada a ser integrado. |
DataInicial | Sim | Data | 10 | Data Inicial para Consulta em padrão SQL Americano. |
DataFinal | Não | Data | 10 | Data Final para Consulta em padrão SQL Americano. |
Regerar | Não | Booleano | True/false | Verificar se será selecionado as vendas com problemas de processamento anteriormente, e não foram conciliadas. |
Sistema | Não | Numérico | 1 | Enumerador: LINX ERP: Valor 1 |
Exemplo Chamada Banana Cake POP:
Exemplo Chamada Banana Cake Web:
Integração Linx Extrator de Vendas: Retorno API GraphQl
Exemplo do objeto Json de retorno:
mutation testeIntegration($input: AddExtratorVendasCommandInput){ addExtratorVendas(input: $input){ vendas{ nSR, iDEstabelecimentoERP, data, numeroUnicoERP, numeroUnicoNegocioLocalizado, nomeCliente, documentoCliente, observacaoVenda, informacaoAdicional1Venda, informacaoAdicional2Venda, flagCancelamento, iDTransacao, autorizacao, nSU, tID, documento, parcelas, iDAdquirente, iDBandeira, iDFormaDePagamento, iDMeioDeCaptura, observacaoTransacao, informacaoAdicional1Pagamento, informacaoAdicional2Pagamento, valor } } }
Atenção
Abaixo são apresentados os campos, os tipos do campo, seu conteúdo, assim como as observações de cada campo.
Campo | Tipo do Campo | Conteúdo | Observações |
Vendas | Array [] Vendas com os campos a seguir: | Lista de Vendas no ERP | Retorna o objeto contendo a lista de vendas do ERP a Integrar conforme a chamada |
NSR | Data | Número sequencial do registro no arquivo | Deve evoluir de 1 em 1 para cada registro (linha) dentro do arquivo |
IdEstabelecimentoERP | Alfanumérico | Código que identifica a loja/filial onde a venda foi registrada a ser integrado. |
|
Data | Data | Data da Venda |
|
NumeroUnicoERP | Alfanumérico | Identificador da venda no sistema interno | Deve ser único para cada venda |
NumeroUnicoNegocioLocalizado | Alfanumérico | Código utilizado para pesquisar facilmente a venda no Equals | Localizador: Pode se repetir entre vendas diferentes |
NomeCliente | Alfanumérico | Nome do cliente comprador |
|
DocumentoCliente | Alfanumérico | CPF ou CNPJ do cliente comprador | Pode ser utilizado para enviar algum outro código interno que identifique o comprador, caso exista |
ObservacaoVenda | Alfanumérico | Observação sobre a venda | Tamanho máximo: 200 |
InformacaoAdicional1Venda | Alfanumérico | Informação adicional da venda |
|
InformacaoAdicional2Venda | Alfanumérico | Informação adicional da venda |
|
FlagCancelamento | Alfanumérico | “C” para indicar cancelamento | Se o campo estiver vazio ou com qualquer outro caractere diferente de “C”, o registro será considerado vinculado a uma transação de pagamento |
IDTransacao | Alfanumérico | Identificador da transação no sistema interno | Se enviado, deve ser único para cada transação |
Autorizacao | Alfanumérico | Código de autorização gerado pela adquirente |
|
NSU | Numérico | NSU gerado pela adquirente ou Nosso Número gerado pelo banco para boletos |
|
TID | Alfanumérico | TID (Transaction ID) gerado pela adquirente para transações via e-commerce | Transação |
Documento | Alfanumérico | Número do Cartão | Deve demonstrar somente os 6 primeiros e 4 últimos dígitos, mascarando o restante. Ex: 123456******7890 |
Parcelas | Numérico | Total de parcelas da transação |
|
IDAdquirente | Numérico |
|
|
IDBandeira | Numérico |
|
|
IDFormaDePagamento | Alfanumérico |
|
|
IDMeioCaptura | Numérico |
|
|
ObservacaoTransacao | Alfanumérico | Observação sobre a transação |
|
InformacaoAdicional1Pagamento | Alfanumérico | Informação adicional da transação de pagamento | Não preenche para cancelamentos |
InformacaoAdicional2Pagamento | Alfanumérico | Informação adicional da transação de pagamento | Não preenche para cancelamentos |
Valor | Numérico | Valor da venda, decimal de duas casas. | Números não inteiros devem ser informados com vírgula e no máximo duas casas decimais, considerando o valor bruto da transação. Ex: 10,99 |
Exemplo Chamada Banana Cake POP:
Exemplo Chamada Banana Cake Web:
Integração Linx Extrator de Vendas: Comunicação com a API
Endereço da API de DEV
http://dev-linx-erp-extrator-vendas-api.azurewebsites.net/graphql/
Endereço da API de QA
http://qa-linx-erp-extrator-vendas-api.azurewebsites.net/graphql/
Autenticação: Para QA e DEv utilizar a autenticação do token Bearer, Chave única:
"Token": "f3413f64-3e3c-415b-a274-d417828ea2d9"
Exemplo de autenticação via Banana CakePop
Exemplo de Autenticação Web
Para produção cada cliente terá seu endereço “URL” e seus respectivos tokens para acesso à produção.