GW Serviços

Versão 2.6.6
 Histórico das alterações

Versão Alterações Responsável Data

2.0 Criação do Layout na nova plataforma Anderson Espana 02-10-2018

2.0.1 ● Criação da tabela de código de retornos; Deivid 09-10-2018

● Adicionado ao método “solicitarToken” o
campo “codigo” no objeto de retorno;
● Adicionado ao método “recuperarSenha” o
campo “codigo” no objeto de retorno;
● Adicionado ao método “listaCargas” o “modal”
para ser informado o modal do CT-e;
● Os parâmetros do método “listaCargas”
passaram a ser enviados via POST;

2.0.2 ● Adicionado o campo “qtdAnexos” no método Deivid 22-10-2018

“listaCargas”;
● Correção no item 2.4.1, objeto de retorno,
pois as informações estavam diferentes do
exemplo;
● No exemplo do item 2.6 (carregarArquivo)
dava a impressão que o retorno seria de
apenas um objeto e na verdade poderá ter
vários objetos;
● Adicionado os filtros “Número do CT-e”, “UF
de Origem” e “UF de Destino” no método
“listaCargas”;

2.1 ● Adicionado método consultarCte Leandro 22-11-2018

● No retorno do método listaOcorrencias foi Deivid 27-11-2018

adicionado o campo “qtdAnexos”
● No retorno do método listaCargas foi
adicionado os campos “codUltimaOcorrencia”
e “descricaoUltimaOcorrencia”
● Criação do método “solicitarEmailsUsuario”

2.1.1 ● No retorno do método listaCargas foi Deivid 04-01-2019

adicionado o campo “dataEntrega”

2.1.2 ● No retorno do método listaCargas foi Deivid 09-01-2019

adicionado o campo “serieCte”;
● Foi adicionado o parametro “cidadeDestino”
no método listaCargas;
● Foi adicionado o parametro “serieCte” no
método listaCargas;
2.1.3 ● No retorno do método “solicitarToken” foi Deivid 22/03/2019
criado um novo campo chamado “channel”;

2.1.4 ● No método “solicitarEmailsUsuario” foi criado Anderson 15/04/2019

um novo campo chamado “channel”;

2.2 ● Foi criado um novo caminho API para José Olívio M. 01/07/2019
métodos específicos do chatbot. Pedrosa
● Foi criado um método “criarConta” para
solicitar uma nova criação de conta e senha.

2.3 ● Foi criado um método “obterContasReceber” José Olívio M. 08/08/2019

para obter as contas a receber do cliente. Pedrosa

2.3.1 ● Foi removido o campo “numero_recibo” e Ricardo Henrique 16/09/2019

adicionado o campo “com_verificacao_nfse” Rodrigues de
no método “obterContasReceber”. Castro

2.3.2 ● Foi adicionado no método "listaCargas" os Deivid 25/09/2019

campos:
○ volumes
○ emissaoCte
○ cnpjDestinatario
○ enderecoDestinatario
○ numeroLogDestinatario
○ bairroDestinatario
○ cepDestinatario
○ complementoDestinatario
○ cidadeDestinatario
○ ufDestinatario
○ telefoneDestinatario
○ celularesDestinatario
○ emailsDestinatario

2.3.3 ● Foram adicionados no método José Olívio M. 18/10/2019

“obterContasReceber” os seguintes campos: Pedrosa
○ cnpj_cliente
○ cnpj_filial_emissor
○ razao_social_filial_emissor
○ valor_boleto
○ codigo_barras_boleto
○ inscricao_municipal_filial_emissor
● Foram renomeados no método
“obterContasReceber” os seguintes campos:
○ razao_social para razao_social_cliente
○ com_verificacao_nfse para
cod_verificacao_nfse
2.3.4 ● Foi adicionado ao método listaCargas o Paulo 02/12/2019
parâmetro "cpfCnpjDestinatario"
● Foi adicionado ao método solicitarColeta os
campos "nomeDestinatário", "valorNota" e
"Conteúdo"
● Foi adicionado ao objeto de retorno do
método solicitarColeta o campo
"numeroColeta"

2.4 ● Foi adicionado o método incluiNotaFiscal Marcos Paulo 30/04/2020

2.4.1 ● Foi adicionado no objeto de envio do método Deivid 27/08/2020

listaCargas o filtro "Número Pedido da NF"
no atributo "Tipo"
● Foi adicionado no objeto de retorno do
método listaCargas o campo "idCte"

2.4.2 ● No método listaOcorrencias: Deivid 17/11/2020

○ Foi retirado o campo qtdAnexos;
○ Foi alterado o nome do campo
"observacaoOcorrencia" para
"comentarioMotorista"

2.4.3 ● No método listaCargas, foi adicionado os Deivid 10/11/2021

seguintes campos de retorno:
○ numeroRomaneio;
○ dataRomaneio;
○ horaRomaneio;
○ filialRomaneio;
○ numeroManifesto;
○ filialManifesto;
○ filialDestinoManifesto;
○ cpfMotorista;
○ nomeMotorista;
○ dataNota;
○ placa;
○ expedidor;
○ recebedor;
○ cnpjRemetente;
○ codigoIbgeDestinatario;
○ cnpjFIlialCte;
○ filialCte;

2.4.4 ● No método 2.11 – IncluiNotaFiscal Deivid 17/01/2022

○ Foi criado o retorno "ID_NOTA" e
"STATUS_IMPORTACAO"
● No método 2.3 - listaCargas
○ Foi criado o filtro para mostrar as
cargas do mesmo grupo de clientes do
 cliente consultado;
● No método 2.3 - listaCargas foram criados os
campos:
○ ​cidadeFilialCte;
○ ufFilialCte;
○ dataOcorrencia;
○ horaOcorrencia;
○ razaoFilialCte;
○ consignatario;
○ cnpjConsignatario;
○ redespacho;
○ cnpjRedespacho;
○ representante;
○ cnpjRepresentante;
● No método 2.5 - solicitarColeta foram criados
os campos:
○ cnpjFilial
○ cnpjRemetente
○ nomeRemetente
○ bairroRemetente
○ cidadeRemetente
○ ufRemetente
○ cepRemetente
○ cnpjDestinatario
○ enderecoDestinatario
○ bairroDestinatario
○ cidadeDestinatario
○ ufDestinatario
○ cepDestinatario
○ metroCubico
○ embalagem
○ tipoPagador
● No método 2.5 - solicitarColeta foram
retirados os campos:
○ horaRomaneio
● No método 2.5 - solicitarColeta foram
alterados os campos:
○ dataRomaneio, passou a mostrar a
hora também
○ dataEmbarque, passou a mostrar a
hora também

2.5 ● Foi criado o método "2.12 - Gabriel Ferreira 27/05/2022

incluiManifestoRomaneio"
2.6 ● No método 2.3 - listaCargas foram criados os
campos:
○ ObservacaoEntrega

2.6.1 ● No Método 2.3 - listaCargas foram criados os Deivid 26-05-2022

campos:
○ cpfMotoristaRomaneio
○ nomeMotoristaRomaneio

2.6.2 ● No Método 2.3 - listaCargas foram criados Deivid 30-09-2022

novos parâmetros de consulta chamados:
○ "Data alteração CT-e"
○ "Data Entrega"
○ "Número Manifesto"
○ "Número Romaneio"
● No Método 2.3 - listaCargas foram criados os
campos:
○ dataAtu

2.6.3 ● No método 2.3 - listaCargas foram criados os Deivid 29-12-2022

campos:
○ Número da Coleta
○ Origem (Endereço do remetente)
○ Valor do CT-e
○ CLA (Comprimento x Largura x Altura)
● Foi criado um novo código de erro: 990 - O
limite máximo de conexões foi atingido!

2.6.4 ● No método 2.4 - listaOcorrencias: Deivid 06-04-2023

○ Foram criados os campos:
■ idNota
■ idCte
■ cnpjRemetente
■ chaveAcesso
■ dataEntrega
■ caminhoAnexo
○ Foi criado uma nova URL de consulta
para que possa ser consultado os
resultados por data de ocorrencia, data
de inclusão de ocorrência, Data da
entrega ou Chave de acesso da NF-e

2.6.5 ● Realizamos uma atualização em nossa URL. Marcos Loureiro 03-07-2023

Anterior: http://gwfiscal.gwcloud.com.br/
Novo: https://api.saas.gwsistemas.com.br/

2.6.6 ● No Método 2.4 - listaOcorrencia: Deivid Oliveira 19-09-2023

 ○ Foram criados os campos:
■ Latitude
■ Longitude
■ Motorista
● No método 2.3 - listaCargas:
○ Foi criado o campo tipo que irá mostrar
os tipos de conhecimentos, segue
abaixo o que significa cada tipo:
■ n = Normal
■ b = Cortesia
■ c = Complementar
■ d = Devolução
■ r = Reentrega
■ s = Substituição
■ t = Substituido
■ a = Anulação
■ i = Diária
■ p = Pallet

1. Resumo
O Webservice REST da GW será um conjunto de serviços para consulta de
CTe, Ocorrências e Notas fiscais de forma rápida e fácil. Para a integração,
precisará de um GUID fornecido pela GW e um contato com login(senha e email
cadastrado). O formato de dados será sempre JSON com datas no formato
“ddMMyyyy”.

2. Serviços
2.1 - solicitarToken
2.2 - recuperarSenha
2.3 - listaCargas
2.4 - listaOcorrencias
2.5 - solicitarColeta
2.6 - carregarArquivo
2.7 - solicitarEmailsUsuario
2.8 - consultarCte
2.9 - chatbot/criarConta
2.10 - chatbot/obterContasReceber
2.11 - incluiNotaFiscal
2.12 - incluiManifestoRomaneio

2.1 - solicitarToken
A autenticação será feita através do envio de um login, senha e um GUID
único, onde será criado e retornado na requisição um TOKEN que poderá ser
utilizado por todos os outros serviços, com a validade máxima até às 23:59 do dia
que foi feita a solicitação. Após ser solicitado o TOKEN basta enviá-lo como
HEADER em todos os serviços.

O caminho será:
https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/solicitarToken
Headers: Login(String), senha(String) e GUID(String)
Método: GET

2.1.1 - Objeto de retorno

Atributo Tipo dados Descrição

codigo String Código da mensagem de

retorno.

mensagem String Mensagem de retorno.

token String Token de uso diário.

channel String Canal de comunicação para

notificações push

Exemplo:
● {“codigo”:”000”, “mensagem”:”Acesso autorizado.”, “token”: “<Token de
acesso>”}
● {“codigo”:”001”, “mensagem”:”Acesso não autorizado.”}

2.2 - recuperarSenha
Para recuperar a senha o usuário deverá informar o seu GUID e seu e-mail.
Será consultado no sistema a qual contato o usuário faz parte e seus dados serão
enviados em seu e-mail.

O caminho será:
https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/recuperarSenha/{Emailca
dastrado}
Headers: GUID
Método: GET

2.2.1 - Objeto de retorno

 Atributo Tipo dados Descrição

codigo String Código da mensagem de

retorno

mensagem String Mensagem de retorno

Exemplo:
● {“codigo”:”050”,“mensagem”:”E-mail enviado com sucesso.”}
● {“codigo”:”051”,“mensagem”:”E-mail informado não cadastrado.”}
● {“codigo”:”052”,“mensagem”:”E-mail de recuperação de senha não foi
enviado, tente novamente mais tarde.”}

2.3 - listaCargas
Para recuperar os dados da carga.

O caminho será:
https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/listarCargas/
Headers: TOKEN
Método: POST

2.3.1 - Objeto de envio

Atributo Tipo dados Descrição

tipo int Tipo do filtro que podera ser:

○ 0 = Data de emissão da nota
fiscal;
○ 1 = Data de emissão do CT-e
○ 2 = Número da nota fiscal;
○ 3 = Chave de acesso da nota
fiscal;
○ 4 = Número do CT-e;
○ 5 = Número do Pedido da NF
○ 6 = Data de alteração do CT-e
○ 7 = Data de Entrega
○ 8 = Número Manifesto
○ 9 = Número Romaneio
 parametro1 String ○ Se o tipo for 1 então deverá informar a
data inicial da pesquisa no formato
ddMMyyyy;
○ Se o tipo for 2 então deverá informar o
número da nota fiscal;
○ Se o tipo for 3 então deverá informar a
chave de acesso da nota fiscal;
○ Se o tipo for 4 então deverá informar o
número do CT-e;
○ Se o tipo for 5 então deverá informar o
número do pedido da NF
○ Se o tipo for 6 então deverá informar a
data inicial da pesquisa no formato
ddMMyyyy
○ Se o tipo for 7 então deverá informar a
data inicial da pesquisa no formato
ddMMyyyy
○ Se o tipo for 8 então deverá informar o
número do Manifesto
○ Se o tipo for 9 então deverá informar o
número do Romaneio

parametro2 String Só deverá ser utilizado se o tipo for 0, 1, 6

ou 7 deverá ser informado a data final da
pesquisa no formato ddMMyyyy;

modal String Só deverá ser utilizado se o tipo for 1, 6 ou

7, e deverá ser informado o modal do CT-e
que poderá ser:
○ R = Rodoviário;
○ A = Aéreo;
○ Q = Aquaviário;
○ T = Todos;

ufOrigem String Só deverá ser utilizado se o tipo for 1, 6 ou

7, e deverá ser informado a UF de Origem
se quiser acrescentar esse campo no filtro.

ufDestino String Só deverá ser utilizado se o tipo for 1, 6 ou

7, e deverá ser informado a UF de Destino
se quiser acrescentar esse campo no filtro.

cidadeDestino String Só deverá ser utilizado se o tipo for 1, 6 ou

7, e deverá ser informado a cidade de
destino se quiser acrescentar esse campo
no filtro.
 serieCte String Só deverá ser utilizado se o tipo for 1, 6 ou
7, e deverá ser informado a série do CT-e
se quiser acrescentar esse campo no filtro.

cpfCnpjDestinatario String Poderá ser utilizado para todos os tipos de

pesquisas. Deverá ser enviado apenas
números.

Exemplo:
{
"tipo":1,
"parametro1":"01122018",
"parametro2":"30122018",
"modal":"R",
"cpfCnpjDestinatario":"00868522290"
}

2.3.2 - Objeto de retorno

Atributo Tipo dados Descrição

idNota int Id da Nota

notas String Número nota

valorNotas String Valor da nota

pesoCarga Double Deverá ser informado o peso da nota.

volumes Double Quantidade total de volumes do CT-e

idCte String Número identificador do CT-e

cte String Número do CT-e

filialCte String Filial que emitiu o CT-e

razaoFilialCte String Razão Social da filial que emitiu o CT-e

cnpjFIlialCte String CNPJ da filial que emitiu o CT-e

cidadeFilialCte String Cidade da filial que emitiu o CT-e

ufFilialCte String UF da filial que emitiu o CT-e

serieCte String Série do CT-e

emissaoCte date Data de emissão do CT-e

 chaveAcessoCte String Chave de acesso do CT-e

consignatario String Consignatario do CT-e

cnpjConsignatario String CNPJ Consignatario do CT-e

destinatario String Nome do destinatário

cnpjDestinatario String CPF / CNPJ do destinatário

enderecoDestinatario String Endereço do destinatário

numeroLogDestinatario String Número do logradouro do endereço do

destinatário

bairroDestinatário String Bairro do destinatário

cepDestinatario String CEP do destinatário

complementoDestinatario String Complemento do endereço do

destinatário

cidadeDestinatario String Cidade do destinatário

ufDestinatario String UF do destinatário

codigoIbgeDestinatario String Código IBGE da cidade do destinatário

telefoneDestinatario String Telefone do destinatário

celularesDestinatario String Celulares do destinatário

emailsDestinatario String E-mails do destinatário

remetente String Nome do remetente

cnpjRemetente String CNPJ do Remetente

redespacho String Redespacho CT-e

representante String Representante de entrega do CT-e

cnpjRepresentante String CNPJ do representante do CT-e

cnpjRedespacho String CNPJ do Redespacho do CT-e

destino String Endereço que será entregue a carga

tipoModal String Valores aceitos: 'aereo' ou 'rodoviario'

dataColeta Date A data em que a carga foi coletada

 dataEmbarque String A data/hora do manifesto da carga

previsaoEntrega Date A data de previsão de entrega será

considerada como data de entrega
quando o status for 5(cinco)

chaveAcesso String Chave de acesso da nota fiscal

status String Status atual da carga

qtdAnexos Int Quantidade de anexos da carga

codUltimaOcorrencia String Código da última ocorrência vinculada

ao CT-e

descricaoUltimaOcorrencia String Descrição da última ocorrência

vinculada ao CT-e

dataOcorrencia Date Data da última ocorrência

horaOcorrencia String Hora da última ocorrência

dataEntrega Date Data de Entrega do CT-e

observacaoEntrega String Observação da Entrega

numeroRomaneio String Número do Romaneio

dataRomaneio String Data/Hora do Romaneio

filialRomaneio String Filial de emissão do romaneio

cpfMotoristaRomaneio String CPF do motorista do romaneio

motoristaRomaneio String Nome do motorista do romaneio

numeroManifesto String Número do manifesto

filialManifesto String Filial Emissão Manifesto

filialDestinoManifesto String Filial de destino do manifesto

cpfMotorista String CPF do motorista vinculado ao CT-e

nomeMotorista String Nome do motorista vinculado ao CT-e

dataNota String Data de emissão da nota fiscal

placa String Placa vinculada ao CT-e

expedidor String Nome do expedidor da carga

 recebedor String Nome do recebedor da carga

cla String Comprimento x Largura x Altura

Exemplo se a consulta der certo:

[
{
“idNota”: 23444,
"notas": "000200",
"valorNotas": "100",
"pesoCarga": 100,
"volumes":3,
"idCte": "123333",
"cte": "000100",
"filialCte": "MATRIZ",
"razaoFilialCte" "Transportadora Fonseca Ltda",
"cnpjFilialCte": "89999000002367",
"cidadeFilialCte": "Recife",
"ufFilialCte": "PE",
"serieCte": "1",
"emissaoCte", "30072018",
"chaveAcessoCte":
"23211106135590000146570060009613821002701727",
"consignatario", "João Distribuidora",
"cnpjConsignatario", "09888444002234",
"destinatario": "Destinatário 1",
"cnpjDestinatario": "08365879000102",
"enderecoDestinatario": "Rua da Guia",
"numeroLogDestinatario": "142",
"bairroDestinatario": "Rosarinho",
"cepDestinatario": "53042359",
"complementoDestinatario": "Por tras da igreja",
"cidadeDestinatario": "Recife",
"ufDestinatario": "PE",
"codigoIbgeDestinatario": "2301000",
"telefoneDestinatario": "8134345566",
"celularesDestinatario": "81999990000,81967675467",
"emailsDestinatario": "deivid@blol.com.br;diretoria@blol.com.br",
"razaoRemetente": "Remetente 1",
"cnpjRemetente": "09000333000123",
"enderecoRem": "Rua da Guia",
"bairroRem": "Rosarinho",
 "cepRem": "53042359",
"complementoRem": "Por tras da igreja",
"cidadeRem": "Recife",
"ufRem": "PE",
"redespacho": "Transportadora Abreu",
"cnpjRedespacho": "09000333000123",
"representante": "Transportadora Alice",
"cnpjRepresentante": "09000333000144",
"destino": "Destino 1",
"tipoModal": "Rodoviario",
"dataColeta": "01112018",
"dataEmbarque": "01112018 1209",
"previsaoEntrega": "01112018",
“chaveAcesso”:”12345678901234567890123456789012345678901234”,
"status": “Depósito de Origem”,
"qtdAnexos": 0,
“codUltimaOcorrencia”:”001”,
“descricaoUltimaOcorrencia”:”Entrega Realizada Normalmente”,
“dataOcorrencia”:”02112018”,
“horaOcorrencia”:”1409”,
“dataEntrega”:”02112018”,
"observacaoEntrega":"Recebido por Jose",
"numeroRomaneio”:”100989”,
“dataRomaneio”:”10122018 1408”,
“filialRomaneio”:”MATRIZ”,
"cpfMotoristaRomaneio":"00868521444",
"motoristaRomaneio":"Deivid José Oliveira",
“numeroManifesto”:”344567”,
“filialManifesto”:”MATRIZ”,
“filialDestinoManifesto”:”JPA”,
“cpfMotorista”:”00878945400”,
“nomeMotorista”:”ANTONIO FRANCISCO DE OLIVEIRA”,
“dataNota”:”01112018”,
“placa”:”HJK0989”,
“expedidor”:”Industrias Falcao LTDA”,
“recebedor”:””,
“dataAtu”:”01112018”,
"coleta":"098765",
"valorCte":1000.00,
"cla":"2.56x2x0.55",
"tipo":"n"
},
 {
“idNota”: 56777,
"notas": "000333",
"valorNotas": "100",
"pesoCarga": 100,
"volumes":3,
"idCte": "123333",
"cte": "000100",
"filialCte": "MATRIZ",
"razaoFilialCte" "Transportadora Fonseca Ltda",
"cnpjFilialCte": "89999000002367",
"cidadeFilialCte": "Recife",
"ufFilialCte": "PE",
"serieCte": "1",
"emissaoCte", "30072018",
"chaveAcessoCte":
"23211106135590000146570060009613821002701727",
"consignatario", "João Distribuidora",
"cnpjConsignatario", "09888444002234",
"destinatario": "Destinatário 1",
"cnpjDestinatario": "08365879000102",
"enderecoDestinatario": "Rua da Guia",
"numeroLogDestinatario": "142",
"bairroDestinatario": "Rosarinho",
"cepDestinatario": "53042359",
"complementoDestinatario": "Por tras da igreja",
"cidadeDestinatario": "Recife",
"ufDestinatario": "PE",
"codigoIbgeDestinatario": "2301000",
"telefoneDestinatario": "8134345566",
"celularesDestinatario": "81999990000,81967675467",
"emailsDestinatario": "deivid@blol.com.br;diretoria@blol.com.br",
"razaoRemetente": "Remetente 1",
"cnpjRemetente": "09000333000123",
"enderecoRem": "Rua da Guia",
"bairroRem": "Rosarinho",
"cepRem": "53042359",
"complementoRem": "Por tras da igreja",
"cidadeRem": "Recife",
"ufRem": "PE",
"redespacho": "Transportadora Abreu",
"cnpjRedespacho": "09000333000123",
 "representante": "Transportadora Alice",
"cnpjRepresentante": "09000333000144",
"destino": "Destino 1",
"tipoModal": "Rodoviario",
"dataColeta": "01112018",
"dataEmbarque": "01112018 1209",
"previsaoEntrega": "01112018",
“chaveAcesso”:”12345678901234567890234555789012345678901234”,
"status": “Depósito de Origem”,
"qtdAnexos": 0,
“codUltimaOcorrencia”:”001”,
“descricaoUltimaOcorrencia”:”Entrega Realizada Normalmente”,
“dataOcorrencia”:”02112018”,
“horaOcorrencia”:”1409”,
“dataEntrega”:”02112018”,
"observacaoEntrega":"Recebido por Jose",
"numeroRomaneio”:”100989”,
“dataRomaneio”:”10122018 1408”,
“filialRomaneio”:”MATRIZ”,
"cpfMotoristaRomaneio":"00868521444",
"motoristaRomaneio":"Deivid José Oliveira",
“numeroManifesto”:”344567”,
“filialManifesto”:”MATRIZ”,
“filialDestinoManifesto”:”JPA”,
“cpfMotorista”:”00878945400”,
“nomeMotorista”:”ANTONIO FRANCISCO DE OLIVEIRA”,
“dataNota”:”01112018”,
“placa”:”HJK0989”,
“expedidor”:”Industrias Falcao LTDA”,
“recebedor”:””,
“dataAtu”:”01112018”,
"coleta":"098765",
"valorCte":1000.00,
"cla":"2.56x2x0.55",
"tipo":"n"
}
]

Exemplo se a consulta der errado:

{“codigo”:”100”, “mensagem”:”A consulta não foi executada.”}

2.4 - listaOcorrencias
 O serviço de ocorrência, deverá ser passado o id da Nota Fiscal por
parâmetro e deverá ser retornadas as ocorrências relacionadas ao CT-e vinculado a
nota fiscal.

O caminho poderá ser:

https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/ocorrencias/{idNota} se
quiser pesquisar pelo id da nota fiscal; ou
https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/ocorrenciasPorTipo/{tipo}/
{param1/geraAnexo} caso queira filtrar pelos campos abaixo:
1. tipo = 1 o sistema irá pesquisar pela data da ocorrência e no campo param1 deverá
ir uma data no formato ddMMyyyy
2. tipo = 2 o sistema irá pesquisar pela data de inclusão da ocorrência e no campo
param1 deverá ir uma data no formato ddMMyyyy
3. tipo = 3 o sistema irá pesquisar pela data da entrega do CT-e e no campo param1
deverá ir uma data no formato ddMMyyyy
4. tipo = 4 o sistema irá pesquisar pela chave de acesso da NF-e e no campo param1
deverá ir uma chave de acesso
Nessa nova URL, tbm foi criado o campo geraAnexo que poderá ser preenchido com S ou
N onde:
1. S = O sistema irá mandar a URL dos comprovantes de entrega
2. N = O sistema não irá mandar a URL dos comprovantes de entrega

Headers: TOKEN
Método: GET

2.4.1 - Objeto de retorno

Atributo Tipo dados Descrição

codigoOcorrência String Código da ocorrência

descricaoOcorrencia String Descrição da ocorrência

dataOcorrencia Date Data(ddMMyyyy) da ocorrência

horaOcorrencia Time Hora(HHmm) da ocorrência

comentarioMotorista String Descrição da ocorrência

idNota Int Id da nota fiscal

idCTe Int Id do conhecimento que a nota está

vinculada

cnpjRemetente String CNPJ do remetente da nota

chaveAcesso String Chave de acesso da nota fiscal

 dataEntrega Date Data de entrega do Conhecimento

caminhoAnexo String Caminho da web onde está o anexo

2.4.2 - exemplo
[
{ "codigoOcorrencia": “001”,
"descricaoOcorrencia": “Entrega realizada normalmente”
"dataOcorrencia": "01092018",
"horaOcorrencia": "1209",
"comentarioMotorista": "Recebido pelo dono do mercadinho",
"idNota": 4455,
"idCte": 33334,
"cnpjRemetente": "08363455000355",
"chaveAcesso": "12345678901234567890234555789012345678901234",
"dataEntrega": "01092018",
"caminhoAnexo":
"https://d1qxbrsfuzn7o5.cloudfront.net/JCLOGISTICA/conhecimento/1286375/
9cbf5145-f237-4f2e-8544-a4ff6d5babf8.png?Expires=1717461161&Signature
=NptjFU5UDM9hCPvEXa4NS5~Cz3z4gX0-X5mtuKKMqxESl1BUbf3Ug6uiFu
2vTc9TmNNBYcPgMTRPj~pFrh6HoM9w2F5rWGisrrGNYbC7mR1jm2poAo4r
yFw3FJEhy-1HxWjXBQ34F3F2y-io68dRGNXMC19GPAk4dDZZxENjitPpi-xB5
6Sq6cvw6rGcXcNiTaxT13EDC2YciJ1bEpb7kzQoAISajf7Vpitnsbjd65ev~6apm
q~ld7HWAMoxzF59L4Za3zqZd88FPgvXpzI6IqyV-tQdVcALTQAnKU4xCUszie
JN1LvH2GwaEqRPDXSkuo3fk7CRqGoF2frkdcUrPw__&Key-Pair-Id=K3FNG
8C55YMZKX
",
"Latitude": "-21.0675546",
"Longitude": "-45.6657666",
"Motorista": "José da Silva"
},
{ "codigoOcorrencia": “005”,
"descricaoOcorrencia": “FALTA DE ESPACO FISICO NO DEPOSITO DO
CLIENTE DESTINO”
"dataOcorrencia": "01092018",
"horaOcorrencia": "0800",
"observacaoOcorrencia": "Cliente Pediu que retornasse ao meio dia",
"idNota": 4455,
"idCte": 33334,
"cnpjRemetente": "08363455000355",
"chaveAcesso": "12345678901234567890234555789012345678901234",
"dataEntrega": "01092018",
 "caminhoAnexo": "",
"Latitude": "-21.0675546",
"Longitude": "-45.6657666",
"Motorista": "José da Silva"
}
]
Exemplo se a consulta der errado:
{“codigo”:”100”, “mensagem”:”A consulta não foi executada.”}

2.5 - solicitarColeta
O serviço de solicitação de coletas será feito via POST e deverá ser enviado
o objeto Coleta no formato json, como corpo da requisição.

O caminho é:
https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/solicitarColeta/
Headers: TOKEN
Método: POST

2.5.1 - Objeto de envio

Atributo Tipo dados Descrição

cnpjFilial String CNPJ da filial que a Coleta será

cadastrada. Caso essa tag não seja
informada o padrão será a filial com
om id 1

cnpjRemetente String CNPJ do remetente, se essa tag não

for informada o sistema irá utilizar o
cliente logado na API

nomeRemetente String Nome do Remetente

endereco String Endereço que será realizada a

coleta

bairroRemetente String Bairro do remetente

cidadeRemetente String Bairro do Remetente

ufRemetente String UF do remetente

cepRemetente String CEP do remetente

contato String Contato de quem será responsável

em auxiliar a coletar
 setor String Setor que está solicitando a coleta

telefone String Telefone do contato

qtdVolumes String Quantidade de volumes a serem

coletados (formato: 10.2)

pesoVolume String Peso total a ser coletado

(formato: 10.2)

informacoesComplementares String Mais informações da coleta

foto File Imagem do que deve ser coletado

cnpjDestinatario String CNPJ do destinatário

nomeDestinatário String Nome do destinatário da coleta

enderecoDestinatario String Endereço do destinatário

bairroDestinatario String Bairro do destinatário

cidadeDestinatario String Cidade do destinatário

ufDestinatario String UF do destinatário

cepDestinatario String CEP do destinatário

valorNota String Valor da mercadoria da coleta

(formato: 10.2)

conteudo String Conteúdo da coleta

metroCubico String Metro cúbico da carga que será

coletada (formato: 10.4)

embalagem String Embalagem da carga que será

coletada

tipoPagador String Preencher C para CIF, F para FOB

ou T para Terceiro

Exemplo:
{
"cnpjFilial": "09.989.998.0001-34",
"cnpjRemetente": "98.999.888-0032-00",
"nomeRemetente": "Comercial Soares Ltda",
"endereco":"Rua João de barros, 250, centro, recife - pe",
"bairroRemetente": "Rosarinho",
"cidadeRemetente": "Recife",
 "ufRemetente": "PE",
"cepRemetente": "54.890-888"
"contato":"Teste",
"setor":"Almoxarifado",
"telefone":"988992525",
"informacoesComplementares":"teste solicitar coleta",
"foto":null,
"cnpjDestinatario": "34.456.432/0001-33",
"nomeDestinatario":"Fernando Serverino da Silva",
"enderecoDestinatario":"Rua João de barros, 250, centro, recife - pe",
"bairroDestinatario": "Rosarinho",
"cidadeDestinatario": "Recife",
"ufDestinatario": "PE",
"cepDestinatario": "54.890-888"
"valorNota":1000.00,
"qtdVolumes":"100",
"pesoVolume":"200",
"metroCubico": "0,345",
"embalagem": "Caixa",
"conteudo":"Teste Conteudo",
"tipoPagador":"C"
}

2.5.2 - Objeto de retorno

Atributo Tipo dados Descrição

mensagem String Mensagem de retorno

numeroColeta String Mostrar o número da coleta

2.5.3 - Exemplo
{“mensagem” : “Coleta cadastrada com sucesso.”, “numero_coleta”,
“0001,0002”}

2.6 - carregarArquivo
O serviço de carregar arquivos será utilizado para recuperar os arquivos do
CT-e ou da ocorrência. Deverá ser informado o tipo do documento(1 - CTe ou 2 -
Ocorrência) no parâmetro.
O caminho é:
https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/carregarArquivo/{tipo}/{id
Nota}
Headers: Token
Método: GET

2.6.1 Objeto de retorno

Atributo Tipo dados Descrição

foto File Arquivo solicitado

2.6.2 - Exemplo
[
{“foto”:”Array de bytes”},
{“foto”:”Array de bytes”}
]

2.7 - solicitarEmailsUsuario
Método que disponibilizará os e-mails relacionados ao cadastro de clientes
do usuário.

O caminho será:
https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/solicitarEmailsUsuario
Headers: Login(String), TOKEN
Método: POST

2.7.1 - Objeto de retorno

Atributo Tipo dados Descrição

CNPJ String CNPJ do

emailRespComercial String E-mail do responsável

comercial do cliente.

emailUsuario String Token de uso diário.

channel String Canal de comunicação para

notificações push

Exemplo:
 ● {“CNPJ”:”08353897000102”,
“emailRespComercial”:”responsavel@transportadora.com.br”,
“emailUsuario”: “usuario@embarcador.com.br”}

2.8 - consultarCte
O serviço de consulta irá carregar as informações do CT-e / DAMDFe
referente a chave da nota fiscal informada.

O caminho é:
https://api.saas.gwsistemas.com.br/CteControlador
Método: GET

2.8.1 Objeto de envio

Atributo Tipo dados Descrição

chave String Chave de acesso

2.8.2 Objeto de retorno

Atributo Tipo dados Descrição

mensagem Json Mensagem de retorno

Exemplo:

mensagem : {
"cte":{
"cfop":"5.932 - prest. serv trans.p iniciada em unidade da Federatpo diversa daquela o",
"icms":{
"cod_st":"41",
"aliquota":0.00,
"valor_icms":"0.00",
"base_calculo":39.51,
"valor_icms_pobreza":"0.00",
"tributos_lei_transparencia":"3.65"
},
"serie":"1",
"filial":{
"uf":"PE",
"cep":"51021130",
"cnpj":"07.199.061/0001-79",
"fone":"8132270455",
"bairro":"Boa Viagem",
"numero":"464",
"municipio":"RECIFE",
"logradouro":"Rua Coronel Anizio Rodrigues Coelho",
"abreviatura":"MATRIZ",
"complemento":"",
"numero_rntrc":11995398,
"razao_social":"TRANSAGIL TRANSPORTES LTDA- MATRIZ",
"inscricao_estadual":"032160399"
},
"modelo":"57",
"numero":"072348",
"seguro":{
"numero_apolice":"87372017010654000323",
"nome_seguradora":"AIG SEGUROS BRASIL S.A.",
"responsabilidade_seguro_carga":"EMITENTE DO CT-e"
},
"tomador":{
"cep":"21557010",
"cnpj":"60.869.336/0004-60",
"fone":"02133694900",
"pais":"BRASIL",
"cidade":"RIO DE JANEIRO",
"endereco":"RUA SARAVATA",
"razaosocial":"LAFARGEHOLCIM BRASIL SA",
"inscricao_estadual":"82143858"
},
"valores":{
"itr":"0.00",
"tde":"0.00",
"gris":"0.00",
"peso":"0.00",
"ademe":"0.00",
"frete":"39.51",
"outros":"0.00",
"pedagio":"0.00",
"receber":"39.51",
 "sec_cat":"0.00",
"desconto":"0.00",
"despacho":"0.00",
"taxa_fixa":"0.00",
"total_servico":"0.00"
},
"tipo_cte":"NORMAL",
"expedidor":null,
"recebedor":null,
"remetente":{
"cep":"21557010",
"cnpj":"60.869.336/0004-60",
"fone":"02133694900",
"pais":"BRASIL",
"cidade":"RIO DE JANEIRO",
"endereco":"RUA SARAVATA",
"razaosocial":"LAFARGEHOLCIM BRASIL SA",
"inscricao_estadual":"82143858"
},
"is_lotacao":"NÃO",
"destinatario":{
"cep":"26285330",
"cnpj":"29.424.389/0001-84",
"fone":"0000000000",
"pais":"BRASIL",
"cidade":"NOVA IGUACU",
"endereco":"Rua Aimores",
"razaosocial":"ALENCAR SOARES DA SILVA",
"inscricao_estadual":"80341172"
},
"tipo_servico":"NORMAL",
"notas_fiscais":[
{
"serie":"1",
"numero":"202260",
"chave_acesso":"33190160869336000460550010002022601949079292"
}
],
"placa_veiculo":[
"KSI-0697",
null,
null
 ],
"forma_pagamento":"A PAGAR",
"tipo_transporte":"RODOVIÁRIO",
"tomador_servico":"REMETENTE",
"chave_acesso_cte":"26190107199061000179570010000723481011002082",
"numero_averbacao":"",
"origem_prestacao":"RIO DE JANEIRO - RJ",
"valor_mercadoria":"R$ 577,93",
"data_hora_emissao":"02/01/2019 - 08:05",
"destino_prestacao":"NOVA IGUACU - RJ",
"previsao_entrega_em":"02/01/2019",
"produto_predominante":"DIVERSOS",
"protocolo_autorizacao":526190068612267,
"outras_caracteristicas_carga":""
},
"mdfe":{
"ciot":"17017978207",
"serie":"1",
"filial":{
"uf":"PE",
"cep":"51021130",
"cnpj":"07.199.061/0001-79",
"fone":"8132270455",
"bairro":"Boa Viagem",
"numero":"464",
"municipio":"RECIFE",
"logradouro":"Rua Coronel Anizio Rodrigues Coelho",
"abreviatura":"MATRIZ",
"complemento":"",
"numero_rntrc":11995398,
"razao_social":"TRANSAGIL TRANSPORTES LTDA- MATRIZ",
"inscricao_estadual":"032160399"
},
"modelo":"1",
"numero":"061990",
"veiculos":[
{
"placa":"KSI-0697",
"rntrc":45697811
}
],
"protocolo":{
 "numero":926190000001572,
"data_hora_autorizacao":"02/01/2019 - 08:11"
},
"dados_nota":{
"qtd_cte":1,
"qtd_nfe":1,
"peso_nfe":1603.000
},
"motoristas":[
{
"cpf":"019.755.157-22",
"nome":"FABIO NOE"
}
],
"observacao":"-Transporte subcontratado com proprietário do veículo marca FIAT, placa
número KSI-0697, UF -",
"chave_acesso":"26190107199061000179580010000619901001901523",
"vale_pedagio":{
"fornecedora_cnpj":"",
"responsavel_cnpj":"019.755.157-22",
"numero_comprovante":""
},
"uf_carregamento":"RJ",
"data_hora_emissao":"02/01/2019 - 08:10",
"uf_descarregamento":"RJ"
}
}

Exemplo se a consulta der errado

[
● {"mensagem":"A chave de acesso precisa ter 44 caracteres!"}
● {"mensagem":"{\"erro\": \"O CT-e não foi encontrado!\"}"}
]
2.9 - chatbot/criarConta
Método que irá criar uma conta para um responsável financeiro, de acordo com o
e-mail passado por parâmetro. Se for encontrado, e se for um responsável financeiro, irá ser
gerado um novo login e senha, e enviado um e-mail para o responsável financeiro com os
novos dados de acesso.

O caminho será:
https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/chatbot/criarConta
Headers: guid (o GUID do cliente)
Corpo de requisição: um JSON com os seguintes atributos: “email”
Método: POST

2.9.1 - Objeto JSON de envio

Atributo Tipo dados Descrição

email String O e-mail do responsável

financeiro.

2.9.2 - Objeto JSON de retorno

Atributo Tipo dados Descrição

codigo String Código da mensagem de

retorno.

mensagem String Mensagem de retorno.

2.10 - chatbot/obterContasReceber
Método que irá retornar todas as contas a receber do cliente.

O caminho será:
https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/chatbot/obterCont
asReceber
Headers: TOKEN (o token gerado pelo método “2.1 - solicitarToken”)
Corpo de requisição: um JSON com os seguintes atributos na tabela abaixo
Método: POST

2.10.1 - Objeto JSON de envio

Atributo Tipo dados Descrição

data_inicial String A data de vencimento inicial.

Formato: yyyy-MM-dd

data_final String A data de vencimento final

Formato: yyyy-MM-dd

numero_boleto String O número do boleto, se não

for preenchido a data inicial
e final de vencimento.

quitada Boolean Se vai buscar as faturas

quitadas ou em aberto

tipo_situacao Int Qual a situação da conta a

receber a ser buscado.

Pode ser:
● 0 - Todas
● 1 - Sem Fatura
● 2 - Normal
● 3 - Cartório
● 4 - Descontada
● 5 - Devedora

tipo_parcels Int O tipo de parcels a ser

buscado.

Pode ser:
● 0 - Todas
● 1 - Vencidas
● 2 - A vencer
● 3 - Quitadas
 Exemplo de envio:
{
"data_inicial": "2019-01-01",
"data_final": "2019-10-30",
"quitada": true,
"tipo_situacao": 0,
"tipo_parcels": 1
}
-----
{
"numero_boleto": "49",
"quitada": true,
"tipo_situacao": 0,
"tipo_parcels": 1
}

2.10.2 - Objeto de retorno

Atributo Tipo dados Descrição

numero String Número da Sales vinculada

a parcels.

razao_social_cliente String Nome do cliente.

cnpj_cliente String CNPJ do cliente.

razao_social_filial_emissor String Nome da filial emissora da

fatura.

cnpj_filial_emissor String CNPJ da filial emissora da

fatura.

data_emissao String Data de emissão de sales.

data_vencimento String Data de vencimento.

data_pagamento String Data de pagamento.

baixado String Baixado, poderá ser “Sim”

ou “Não”.

numero_fatura String Número da fatura.

numero_nosso_boleto String Nosso número do Boleto.

numero_banco String Número do Banco, apenas

se na fatura tiver boleto
gerado.
 cod_verificacao_nfse String Código de verificação da
NFS-e caso exista.

valor_boleto String O valor do boleto.

codigo_barras_boleto String O código de barras do

boleto.

inscricao_municipal_filial_e String Inscrição municipal da filial

missor emissora da fatura.

Exemplo de retorno:
[
{
"numero":"271137",
"baixado":"Sim",
"data_emissao":"07/03/2019",
"numero_banco":"",
"razao_social":"SEB do Brasil Prods.Dom.LTDA",
"numero_fatura":"003869",
"com_verificacao_nfse":"CCCC-DDDD",
"data_pagamento":"07/03/2019",
"data_vencimento":"07/07/2019",
"numero_nosso_boleto":""
},
{
"numero":"271138",
"baixado":"Sim",
"data_emissao":"07/03/2019",
"numero_banco":"",
"razao_social":"SEB do Brasil Prods.Dom.LTDA",
"numero_fatura":"003869",
"com_verificacao_nfse":"AAAA-BBBB",
"data_pagamento":"07/03/2019",
"data_vencimento":"07/07/2019",
"numero_nosso_boleto":""
}
]
2.11 – IncluiNotaFiscal

Através dessa operação a GW Sistema disponibilizará junto à transportadora, ações de

recebimento de Nota Fiscal diretamente do emitente, facilitando a importação da mesma
pelo Cliente.

O caminho será:
https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/incluiNotaFiscal

2.11.1 – Cabeçalho da Requisição {Header}

Método: POST

Parâmetro Descrição Tipo de Dado Obrigatório

Authorization Token para Alfanumérico SIM

autenticação

Content-type Tipo de Conteúdo Alfanumérico SIM

2.11.2 – Corpo da Requisção {body}:

Parâmetro Descrição Tipo de Dado Obrigatório

Carga 𝐶𝑎𝑟𝑔𝑎 𝑒𝑛𝑣𝑖𝑎𝑑𝑎 Objeto ou Array 𝑆𝐼𝑀

NUMERO_CARGA 𝑁𝑢𝑚𝑒𝑟𝑎çã𝑜 𝑑𝑎 𝑐𝑎𝑟𝑔𝑎 𝑒𝑛𝑣𝑖𝑎𝑑𝑎 Alfanumérico 𝑆𝐼𝑀

VALOR_FRETE Valor do Frete Decimal (2) NAO

Array<NotaFiscal
CARGA_NOTAS 𝑁𝑜𝑡𝑎𝑠 𝑓𝑖𝑐𝑎𝑖𝑠 𝑒𝑛𝑣𝑖𝑎𝑑𝑎𝑠 𝑛𝑎 𝐶𝑎𝑟𝑔 𝑆𝐼𝑀
>

NotaFiscal 𝑁𝑜𝑡𝑎 𝐹𝑖𝑠𝑐𝑎𝑙 Objeto 𝑆𝐼𝑀

CHAVE_NOTA 𝐶ℎ𝑎𝑣𝑒 𝑑𝑒 𝑎𝑐𝑒𝑠𝑠𝑜 𝑑𝑎 𝑁𝑜𝑡𝑎 Numérico 𝑆𝐼𝑀

NUMERO_NOTA 𝑁𝑢𝑚𝑒𝑟𝑜 𝑑𝑎 𝑁𝑜𝑡𝑎 Numérico 𝑆𝐼𝑀

SERIE_NOTA 𝑆é𝑟𝑖𝑒 𝑑𝑎 𝑁𝑜𝑡𝑎 Numérico 𝑆𝐼𝑀

 Data
DATA_NOTA 𝐷𝑎𝑡𝑎 𝑑𝑒 𝐸𝑚𝑖𝑠𝑠𝑎𝑜 𝑑𝑎 𝑁𝑜𝑡𝑎 𝑆𝐼𝑀
(dd/MM/yyyy)

VALOR_NOTA 𝑉𝑎𝑙𝑜𝑟 𝑑𝑎 𝑁𝑜𝑡𝑎 Decimal (2) 𝑁𝐴𝑂

VOLUMES_NOTA 𝑉𝑜𝑙𝑢𝑚𝑒 𝑑𝑎 𝑁𝑜𝑡𝑎 Decimal (2) 𝑁𝐴𝑂

PESO_NOTA Peso da nota Decimal (2) NAO

CUBAGEM_NOTA 𝐶𝑢𝑏𝑎𝑔𝑒𝑚 𝑑𝑎 𝑁𝑜𝑡𝑎 Decimal (2) 𝑁𝐴𝑂

REMETENTE_NOTA 𝑃𝑒𝑠𝑜 𝑑𝑎 𝑁𝑜𝑡𝑎 ClienteNota 𝑆𝐼𝑀

DESTINATARIO_NOTA 𝐷𝑒𝑠𝑡𝑖𝑛𝑎𝑡𝑎𝑟𝑖𝑜 𝑑𝑎 𝑁𝑜𝑡𝑎 ClienteNota 𝑆𝐼𝑀

ClienteNota Cliente Objeto SIM

CNPJ 𝐶𝑁𝑃𝐽 𝑑𝑜 𝐶𝑙𝑖𝑒𝑛𝑡𝑒 Numérico 𝑆𝐼𝑀

NOME 𝑁𝑜𝑚𝑒 𝑑𝑜 𝐶𝑙𝑖𝑒𝑛𝑡𝑒 Alfanumérico 𝑆𝐼𝑀

LOGRADOURO 𝐸𝑛𝑑𝑒𝑟𝑒ç𝑜 𝑑𝑜 𝐶𝑙𝑖𝑒𝑛𝑡𝑒 Alfanumérico 𝑆𝐼𝑀

Numero do Endereço do
NUMERO Numérico NAO
Ciente

BAIRRO 𝐵𝑎𝑖𝑟𝑟𝑜 𝑑𝑜 𝐶𝑙𝑖𝑒𝑛𝑡𝑒 Alfanumérico 𝑁𝐴𝑂

Código IBGE da Cidade do

CODIGO_IBGE Numérico SIM
Cliente

CEP 𝐶𝐸𝑃 𝑑𝑜 𝐶𝑙𝑖𝑒𝑛𝑡𝑒 Numérico 𝑆𝐼𝑀

Exemplo do Body:

[
{
"NUMERO_CARGA": 14245,
"VALOR_FRETE": 156.85,
"CARGA_NOTAS": [
{
"CHAVE_NOTA": "27200489746287000107550010002717251011001313",
"NUMERO_NOTA": "271725",
"SERIE_NOTA": "1",
"DATA_NOTA": "29/04/2020",
"VALOR_NOTA": 10.45,
"PESO_NOTA": 12.02,
"VOLUMES_NOTA": 10.21,
"CUBAGEM_NOTA": 100.87,
 "REMETENTE_NOTA": {
"CNPJ": "89746287000107",
"NOME": "Bryan e Vitor Pizzaria Delivery ME",
"BAIRRO": "VARADOURO",
"LOGRADOURO": "Rua Siqueira Campos",
"NUMERO": "831",
"CODIGO_IBGE": "2609600",
"CEP": "53010250"
},
"DESTINATARIO_NOTA": {
"CNPJ": "49730557000177",
"NOME": "Mariana e Lucca Publicidade e Propaganda ME",
"BAIRRO": "BULTRINS",
"LOGRADOURO": "Travessa dos Bultrins",
"NUMERO": "332",
"CODIGO_IBGE": "2609600",
"CEP": "53320171"
}
}
]
}
]

2.11.3 – Resposta de Sucesso - HTTP Status Code 200

Retornar no corpo da resposta aquilo que foi enviado no corpo da requisição;

{
"RETORNO": "Importação realizada com sucesso!",
"ID_NOTA": "990098",
"STATUS_IMPORTACAO": true
}

2.11.2 – Respostas para Possíveis Erros

ERRO Possível Solução

Não Autorizado - GUID informada não Verificar a GUID enviada no parâmetro

pertente a nenhum cliente registrado Autorization no cabeçalho

Analisar se todos os Campos

Informe um {Campo} da/o {Objeto};
Obrigatórios foram Preenchidos

Remetente da nota, não inválido para a Verificar se o CNPJ do Remetente é

chave de acesso informado na Chave de Acesso

A Serie/Número da nota fiscal é Verificar se o Numero/Série informado

inválida(o) Condiz com a Chave de Acesso
 Transportadora deve ter a cidade
Nenhuma cidade com o codigo:
informada
{cod_ibge}, está cadastrada no sistema.
Previamente Cadastrada no Sistema

2.12 – IncluiManifestoRomaneio
Através dessa operação a GW Sistema disponibilizará junto à transportadora, ações de
inclusão de manifesto ou romaneio

O caminho será:
https://api.saas.gwsistemas.com.br/webresources/v2/servicosGW/incluirManifestoRomaneio

2.12.1 – Cabeçalho da Requisição {Header}

Método: POST

Parâmetro Descrição Tipo de Dado Obrigatório

Authorization Token para Alfanumérico SIM

autenticação

Content-type Tipo de Conteúdo Alfanumérico SIM

2.12.2 – Corpo da Requisção {body}:

Parâmetro Descrição Tipo de Dado Obrigatório

Tipo que poderá ser "M"

TIPO para manifesto ou "R" para Alfanumérico 𝑆𝐼𝑀
romaneio

CNPJ da filial que o

CNPJ_FILIAL_EMISSAO Manifesto/Romaneio foi Alfanumérico SIM
emitido

CNPJ da filial que o Apenas seTIPO

Manifesto será entregue. = 'M' E
CNPJ_FILIAL_DESTINO Alfanumérico
Apenas se o tipo for = TIPO_DESTINO
"M" = 'F'

CNPJ_REPRESENTANT CNPJ do representante Apenas seTIPO

Alfanumérico
E_DESTINO que o Manifesto será = 'M' E
 entregue. Apenas se o TIPO_DESTINO
tipo for = "M" = 'R'

Poderá ser "F" para filial

TIPO_DESTINO de destino ou "R" para Alfanumérico SIM
representante de destino

CIDADE_ORIGEM Cidade de origem Alfanumérico SIM

UF_ORIGEM UF de origem Alfanumérico SIM

CIDADE_DESTINO Cidade de destino Alfanumérico SIM

UF_DESTINO UF de destino Alfanumérico SIM

CPF_MOTORISTA Cpf do motorista Alfanumérico SIM

PLACA Placa Alfanumérico SIM

PLACA_CARRETA Placa da carreta Alfanumérico NÃO

PLACA_BITREM Placa da carreta Alfanumérico NÃO

PLACA_3REBOQUE Placa da carreta Alfanumérico NÃO

Data do manifesto, se
Alfanumérico
DATA_SAIDA não for informada será NÃO
(ddMMyyyy)
considerado a data atual

Hora de saída do
manifesto, se não Alfanumérico
HORA_SAIDA NÃO
informar será (HHmm)
considerado a hora atual

Sério do MDFe, se não

informar o sistema irá
SERIE_MDFE considerar a série Alfanumérico NÃO
informada no cadastro
da filial

true para pré manifesto

ou pré romaneio ou false
PRE_LANCAMENTO boolean SIM
para manifesto ou
romaneio

OBSERVACAO Observacao Alfanumérico NÃO

DOCUMENTOS Documentos Objeto 𝑆𝐼𝑀

 Chave de acesso do CT-e
ou NF-e. Se mandar a
chave de acesso de uma
NF-e, o sistema irá
vincular no
CHAVE_ACESSO manifesto/romaneio o Alfanumérico SIM
CT-e que essa NF-e
pertence. Se enviar a
chave de acesso de um
CT-e então será vinculado
o CT-e

Exemplo do Body:
[
{
"TIPO": "M",
"CNPJ_FILIAL_EMISSAO": "09.989.009/0001-44",
"CNPJ_FILIAL_DESTINO": "09.990.876/0002-30",
"CNPJ_REPRESENTANTE_DESTINO": "",
"TIPO_DESTINO": "F",
"CIDADE_ORIGEM": "Recife",
"UF_ORIGEM": "PE",
"CIDADE_DESTINO": "João Pessoa",
"UF_DESTINO": "PB",
"CPF_MOTORISTA": "008.989.778-09",
"PLACA": "JJK-0989",
"PLACA_CARRETA": "HHH-9980",
"PLACA_BITREM": "",
"PLACA_3REBOQUE": "",
"DATA_SAIDA": "27/01/2022",
"HORA_SAIDA": "2230",
"SERIE_MDFE": "1",
"PRE_LANCAMENTO": true,
"OBSERVACAO": "",
"DOCUMENTOS":[
{
"CHAVE_ACESSO": "27200489746287000107550010002717251011001313"
},
{
"CHAVE_ACESSO": "27200489746287000107570010002717251011001313"
}
]
},
{
"TIPO": "R",
"CNPJ_FILIAL_EMISSAO": "09.989.009/0001-44",
 "CNPJ_FILIAL_DESTINO": "",
"CNPJ_REPRESENTANTE_DESTINO": "",
"TIPO_DESTINO": "F",
"CIDADE_ORIGEM": "Recife",
"UF_ORIGEM": "PE",
"CIDADE_DESTINO": "João Pessoa",
"UF_DESTINO": "PB",
"CPF_MOTORISTA": "008.989.778-09",
"PLACA": "JJK-0989",
"PLACA_CARRETA": "HHH-9980",
"PLACA_BITREM": "",
"PLACA_3REBOQUE": "",
"DATA_SAIDA": "27/01/2022",
"HORA_SAIDA": "2230",
"SERIE_MDFE": "1",
"PRE_LANCAMENTO": false,
"OBSERVACAO": "",
"DOCUMENTOS":[
{
"CHAVE_ACESSO": "27200489746287000107550010002717251011001313"
},
{
"CHAVE_ACESSO": "27200489746287000107570010002717251011001313"
}
]
}
]

2.11.3 – Resposta de Sucesso - HTTP Status Code 200

Retornar no corpo da resposta aquilo que foi enviado no corpo da requisição;

{
"RETORNO": "Importação realizada com sucesso!",
"TIPO": "Manifesto"
"Número": "990098",
"STATUS_IMPORTACAO": true
}

ou

{
"RETORNO": "Importação realizada com sucesso!",
"TIPO": "Romaneio"
"Número": "990098",
"STATUS_IMPORTACAO": true
}
2.11.2 – Respostas para Possíveis Erros

ERRO Possível Solução

Não Autorizado - GUID informada não Verificar a GUID enviada no parâmetro

pertente a nenhum cliente registrado Autorization no cabeçalho

Tipo inválido Analisar se o tipo é M ou R

Analisar se existe filial para o CNPJ

Filial de emissão não encontrada
informado

Analisar se existe filial para o CNPJ de

destino, mas isso deverá ser verificado se
Filial de destino não encontrado
o campo "Tipo" for "M" E o campo
"TIPO_DESTINO" igual a "F"

Analisar se existe fornecedor para o CNPJ

Representante de destino não de representante, mas isso deverá ser
encontrado verificado se o campo "Tipo" for "M" E o
campo "TIPO_DESTINO" igual a "R"

Analisar se existe cidade cadastrada no

Cidade de origem não encontrado sistema para a CIDADE_ORIGEM e
UF_ORIGEM

Analisar se existe cidade cadastrada no

Cidade de destino não encontrado sistema para a CIDADE_DESTINO e
UF_DESTINO

Motorista não encontrado Analisar se existe o motorista informado

Analisar se existe veículo cadastro para a

Placa não encontrada
placa informada

Analisar se existe veículo cadastro para a

Placa da carreta não encontrada
placa da carreta informada

Analisar se existe veículo cadastro para a

Placa do Bitrem não encontrada
placa do Bi-Trem informado

Analisar se existe veículo cadastro para a

Placa do 3. reboque não encontrada
placa do 3. Reboque informado

Analisar se existe um CT-e para a chave

CT-e não encontrado de acesso informada. Se a chave for de
uma NF-e então deverá verificar se existe
 um CT_e onde a NF-e da chave informada
esteja vinculada.

Tabela de Códigos de retornos

Código Mensagem Rastreabilidade

000 Acesso autorizado. solicitarToken

001 Acesso não autorizado solicitarToken

002 GUID não cadastrado solicitarToken,

recuperarSenha

050 E-mail enviado com sucesso. recuperarSenha

051 E-mail informado não cadastrado. recuperarSenha

052 E-mail de recuperação de senha não foi recuperarSenha

enviado, tente novamente mais tarde.

100 A consulta não foi executada. listaCargas,

listaOcorrencias

150 Coleta cadastrada dom sucesso solicitarColeta

151 Validações da Coleta, na mensagem solicitarColeta

trará todos os erros detalhados.

400 Tabela 2.11.2 incluirNotasFiscal

800 Foi enviado um e-mail com os dados de chatbot/criarConta

acesso.

801 Seu e-mail não foi localizado em nossa chatbot/criarConta

base.

802 Seu acesso não pôde ser liberado, pois chatbot/criarConta

você não está definido como responsável
financeiro

900 Não foi possível acessar a base destino Todos os métodos

990 O limite máximo de conexões foi Todos os métodos
atingido!

999 Erro não Catalogado Todos os métodos