Histórico da Página
Objetivo
Para os usuários que possuem algum aplicativo customizado, e que precisam realizar um cadastro ou consulta do Romaneio de Carga no modulo Gestão de Frete Embarcador (SIGAGFE), foi disponibilizado o método Web Service REST.
Liberados os seguintes métodos:
- GET – permite a consulta de todos os romaneios de frete do GFE. Abaixo a lista de todas as informações que serão retornadas
| Descrição | Mensagem Padrão | Campo | Tamanho | Opções |
|---|---|---|---|---|
| Tags Romaneio de Frete | Manifest | |||
Filial | BranchId | GWN_FILIAL | Caracter - 08 | |
Número do Romaneio* | ManifestNumber | GWN_NRROM | Caracter - 8 | |
Tipo de Operação | OperType | GWN_CDTPOP | Caracter - 10 | |
Classificação de Frete | FreightClas | GWN_CDCLFR | Caracter - 4 | |
Transportador | Carrier | GWN_CDTRP | Caracter - 14 | |
Código do Motorista | Driver | GWN_CDMTR | Caracter – 6 | |
Código do Motorista 2 | Driver2 | GWN_CDMTR2 | Caracter – 6 | |
Tipo Veiculo | VehicleType | GWN_CDTPVC | Caracter – 10 | |
Placa Veículo Dianteiro | FrontLicencePlate | GWN_PLACAD | Caracter – 8 | |
Placa Veículo Traseiro | RearLicencePlate | GWN_PLACAT | Caracter – 8 | |
Placa Veículo do Meio | IntermediateLicPlate | GWN_PLACAM | Caracter – 8 | |
Situação* | Situation | GWN_SIT | Caracter – 1 | 1=Digitado; 2=Emitido; 3=Liberado; 4=Encerrado |
Data de Criação | ManifestCreationDate | GWN_DTIMPL | Data – 99/99/9999 | |
Horário de Criação | CreationHour | GWN_HRIMPL | Caracter - 05 | |
Situação do Cálculo* | CalculationStatus | GWN_CALC | Caracter - 01 | 1=Calculado com Sucesso; 2=Não Calculado; 3=Tentativa sem Sucesso; 4=Necessita Recálculo |
Data do Cálculo* | CalculationDate | GWN_DTCALC | Data – 99/99/9999 | |
Hora do Cálculo* | CalculationHour | GWN_HRCALC | Caracter - 05 | |
Usuário Criação Romaneio | User | GWN_USUIMP | Caracter - 50 | |
Origem* | Source | GWN_ORI | Caracter - 1 | 1=Usuário; 2=ERP; 3=Outros; 4=Sistema |
Data de Saída/Entrada* | OutflowInflowDt | GWN_DTSAI | Data – 99/99/9999 | |
Hora da Saída/Entrada* | OutflowInflowHr | GWN_HRSAI | Caracter - 5 | |
Percurso | Route | GWN_DISTAN | Caracter - 8 | |
Cidade Destino | DestinyCity | GWN_NRCIDD | Caracter - 7 | |
CEP Destino | DestinPostalCode | GWN_CEPD | Caracter - 8 | |
Observação | Notes | GWN_OBS | Memo - 10 | |
Data Retorno | ReturnDate | GWN_DTRET | Data – 99/99/9999 | |
Hora Retorno | ReturnTime | GWN_HRRET | Caracter - 05 | |
Hodômetro Saída | DepartureOdometerReadin | GWN_HODSAI | Caracter - 06 | |
Hodômetro Retorno | ReturnOdometerReading | GWN_HODRET | Caracter - 06 | |
Código Rastreamento | TracingCode | GWN_RASTR | Caracter - 18 | |
Vale Pedágio | TollVoucher | GWN_VALEP | Caracter - 1 | 1=Não se aplica;2=Não Conferido;3=Conferido |
Valor Pedágio | TollAmount | GWN_VPVAL | Numérico - 8 | |
Número do Lacre | SerialNumber | GWN_LACRE | Caracter - 5 | |
Viagem | TripNumber | GWN_VIAGEM | Caracter - 8 | |
Tags Documento de Carga | CargoDocuments | |||
Tipo Documento | CargoDocuments\DocType | GW1_CDTPDC | Caracter - 05 | |
Emissor do Documento | CargoDocuments\Issuer | GW1_EMISDC | Caracter - 14 | |
Data de Emissão | CargoDocuments\IssueDate | GW1_DTEMIS | Data - 99/99/9999 | |
Série do Documento | CargoDocuments\Series | GW1_SERDC | Caracter - 03 | |
Número do Documento | CargoDocuments\Number | GW1_NRDC | Caracter - 16 |
|
Chave NF-e | CargoDocuments\ElectronicValidationKey | GW1_DANFE | Caracter - 60 |
A URL para consulta dos dados é a /MANIFEST/api/gfe/v1/Manifest
Será possível realizar o filtro dos dados através da situação desejada. Neste caso, o filtro deve ser enviado da seguinte forma:
MANIFEST/api/gfe/v1/Manifest/?Status=1|2
Conforme este exemplo, serão listados apenas os Romaneios de Frete com situação Digitado ou Emitido.
Caso haja limitação para a busca e existam muitos romaneios na base é possível também realizar um filtro por quantidade de registros.
MANIFEST/api/gfe/v1/Manifest/?Page=1&PageSize=100
Neste exemplo, serão listados apenas os 100 primeiros romaneios encontrados.
Para buscar os próximos 100 registros, podemos realizar o filtro da seguinte forma:
MANIFEST/api/gfe/v1/Manifest/?Page=2&PageSize=100
- GET{InternalId} – Permite a consulta de apenas um Romaneio de Frete. Deve ser enviada a chave do Romaneio de frete: GWN_FILIAL + GWN_NRROM.
...
Abaixo um exemplo de informações que podem ser enviadas.
| Bloco de código |
|---|
{ "CompanyID": "T1", |
...
"BranchID": "D MG 01 ", |
...
"OperType": "01", |
...
"FreightClas": "PADRAO", |
...
"Carrier": "170089", |
...
"VehicleType":"CARRETA", |
...
"ManifestCreationDate": "2021-02-24", |
...
"CreationHour": "18:00", |
...
"Notes": "Teste Integração", |
...
"CargoDocuments": [ |
...
{ "ElectronicValidationKey": "123456123456123456123456123456123456123" |
...
} ] } |
O número do Romaneio não deve ser enviado pois o GFE verificará de forma incremental qual o próximo número disponível.
...
Exemplo de alteração Romaneio
| Bloco de código |
|---|
{ "CompanyID": "T1", |
...
"BranchID": "D MG 01 ", |
...
"ManifestNumber": "123456", |
...
"FreightClas": "01", |
...
"Notes": "Teste", |
...
} |
LISTA DE PROGRAMAS DESENVOLVIDOS
| Programa: GFEA050I | Programa: GFEA050API |
| Descrição: Funcionalidades de gravação/leitura/consistência dos dados. | Descrição: Métodos e variáveis utilizadas na API REST. |
| Procedimento: Não se aplica. | Procedimento: Não se aplica. |
| Nome externo: Não se aplica. | Nome externo: Não se aplica. |
| Nome menu: Não se aplica. | Nome menu: Não se aplica. |
| Template: Não se aplica. | Template: Não se aplica. |
| Registro padrão: Não se aplica. | Registro padrão: Não se Aplica. |
| Visualiza menu: Não | Visualiza menu: Não |
LISTA DE PARÂMETROS
Não se aplica.
LISTA DE CUSTOMIZAÇÃO Html
Não se aplica.
LISTA DE OBJETOS DE BANCOS DE DADOS
Não se aplica.
LISTA DE UPC/EPC
Não se aplica.
LISTA DE PROGRAMAS ALTERADOS
Não se aplica.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas