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

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.

URL para consulta do documento: /MANIFEST/api/gfe/v1/Manifest/"D MG 01 101202"

• POST – permite a inclusão de um romaneio de frete do GFE. A inclusão utilizará a mesma estrutura de dados demonstradas para o método GET. As informações obrigatórias para criação do Romaneio são: Transportador e Tipo de Operação.

URL para criação do romaneio: MANIFEST/api/gfe/v1/Manifest/

Poderá ser criado apenas o romaneio e, posteriormente no GFE de forma manual realizar o vínculo com documentos de carga, ou então, poderá ser enviado o Romaneio e os Documentos de Carga.

Abaixo um exemplo de informações que podem ser enviadas.

{
	"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.

O Romaneio será criado com o campo Origem (GWN_ORI) igual a 3=Outros.

Para os documentos de carga vinculados pode ser enviada apenas a chave da NF-e ou então os campos chaves do documentos de carga (tipo do documento, emissor, série, data de emissão e número do documento).

Caso o romaneio seja criado sem vínculo com Documentos de carga receberá a situação "1=Digitado". Caso tenha documentos de carga receberá a situação "2=Emitido".

O romaneio será liberado automaticamente, caso o tipo de operação utilizado esteja parametrizado para liberação automática.

URL para alteração do romaneio: MANIFEST/api/gfe/v1/Manifest/

• PUT – Permite a alteração das informações do romaneio. As alterações dependerão da situação do Romaneio no GFE e estará sujeita a validações do programa padrão do romaneio (GFEA050).  Não será tratada a vinculação de novos documentos de carga no romaneio.

Exemplo de alteração Romaneio

{
	"CompanyID": "T1",
	"BranchID": "D MG 01 ",
	"ManifestNumber": "123456",
	"FreightClas": "01",
	"Notes": "Teste",
}

LISTA DE PROGRAMAS DESENVOLVIDOS 

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.