Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

SIMULAÇÃO DE FRETE VIA WEB SERVICE REST - FREIGHTSIMULATIONS

Características do Requisito

Linha de Produto:

Microsiga Protheus

Segmento:

Supply Chain - Logistica

Módulo:

SIGAGFE - Gestão de Frete Embarcador

Rotina:

Rotina

Nome Técnico

GFEWSSIMULATION

Simulação de Frete API REST

Rotina(s) envolvida(s)

Nome Técnico

GFEXFUNB

Cálculo de Frete

Requisito/Story/Issue (informe o requisito relacionado):

DLOGGFE-2197 / DLOGGFE-3183

País(es):

Brasil

Banco(s) de Dados:

Todos

Tabelas Utilizadas:

GWN - Romaneios.
GW1 - Documento de Carga.
GWU - Trechos do Itinerário.
GW8 - Itens Documento de Carga.
GU3 - Cadastro de Emitentes.

Sistema(s) Operacional(is):

Windows, Linux, Unix

Descrição

Para os usuários que possuem algum aplicativo customizado, e que precisam realizar uma simulação de frete no produto Gestão de Frete Embarcador (SIGAGFE), foi disponibilizado o método Web Service REST.

Para utilização, é necessário a atualização do produto e a configuração do Web Service REST, conforme descrito nos pré-requisitos.

Índice
minLevel2
excludeCaracterísticas do Requisito|Descrição
stylesquare

Método Publicado

FonteGFEWSSIMULATIONNome do ServiçoFREIGHTSIMULATION

Pré-requisitos para Utilização

  • Atualização do Microsiga Protheus com versão igual ou superior a 12.1.17.
  • Configuração do AppServer para disponibilizar as rotinas publicadas com o Web Service REST.
  • Após a configuração do Web Service REST, ao executar o appserver via console, será apresentada uma mensagem, informando que o Web Service REST está habilitado, vide imagem abaixo.

Image Removed

  • Pelo navegador de Internet, é possível visualizar todos os serviços disponíveis, inclusive a API FREIGHTSIMULATION.

Image Removed

  • API FREIGHTSIMULATION.

Image Removed

Métodos disponíveis no API FREIGHTSIMULATION.

Image Removed

Exemplo de Utilização

Para realizar testes, pode ser utilizado qualquer programa de sua preferência, que teste API Web Service REST.

Como exemplos de programas, podemos citar o SoapUI ou a extensão Postman do Navegador Chrome. Ambos são excelentes aplicativos.

Documento de Referência:

Para mais informações sobre a Simulação de Frete - FreightSimulations - API REST, consulte o documento de referência

Simulação de Frete - FreightSimulations - API REST

Utilizando o Postman para Realizar uma Simulação de Frete

A API FREIGHTSIMULATION disponibiliza o método GET, onde é retornado o arquivo de exemplo no formato JSON, que poderá ser utilizado para executar o método POST.

Image Removed 

Na ferramenta Postman, copie o exemplo retornado, altere para executar o POST e cole o exemplo no Body (corpo).
Altere as informações dos campos para dados válidos da base de dados e execute a simulação (mais abaixo tem a explicação de cada campo do arquivo JSON).

Image Removed

Após executar a simulação, o resultado da simulação será retornado no formato JSON.

Image Removed

Exemplo de arquivo JSON

Arquivo JSON de entrada para ser utilizado como base.

Bloco de código
languagexml
themeMidnight
titleJSON Entrada
collapsetrue
{
    "content": [
        {
            "Items": [
                {
                    "Manifest": [
                        {
                            "Length": 8,
                            "id": "ManifestNumber",
                            "Description": "Código agrupador/Romaneio",
                            "value": "01      ",
                            "Type": "string"
                        },
                        {
                            "Length": 14,
                            "id": "CarrierCode",
                            "Description": "Transportador a ser considerado no cálculo",
                            "value": "              ",
                            "Type": "string"
                        },
                        {
                            "Length": 10,
                            "id": "TypeOfVehicle",
                            "Description": "Tipo de Veículo",
                            "value": "          ",
                            "Type": "string"
                        },
                        {
                            "Length": 4,
                            "id": "FreightClassification",
                            "Description": "Classificação de frete",
                            "value": "    ",
                            "Type": "string"
                        },
                        {
                            "Length": 10,
                            "id": "OperationType",
                            "Description": "Tipo de Operação",
                            "value": "          ",
                            "Type": "string"
                        }
                    ],
                    "id": "1",
                    "ItemsDocumentBurden": [
                        {
                            "Items": [
                                {
                                    "Length": 14,
                                    "id": "IssuerCode",
                                    "Description": "Emitente do Documento de Carga/Nota Fiscal",
                                    "value": "              ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 3,
                                    "id": "InvoiceSerie",
                                    "Description": "Série do Documento de Carga/Nota Fiscal",
                                    "value": "   ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 16,
                                    "id": "InvoiceNumber",
                                    "Description": "Número do Documento de Carga/Nota Fiscal",
                                    "value": "00001           ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 5,
                                    "id": "TypeOfDocument",
                                    "Description": "Tipo do Documento de Carga/Nota Fiscal",
                                    "value": "     ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 15,
                                    "id": "ItemCode",
                                    "Description": "Código do Item do Documento de Carga/Nota Fiscal",
                                    "value": "ItemA          ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 4,
                                    "id": "FreightClassification",
                                    "Description": "Classificação de Frete do Item Documento de Carga/Nota Fiscal",
                                    "value": "    ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 4,
                                    "id": "ItemType",
                                    "Description": "Tipo do Item do Documento de Carga/Nota Fiscal",
                                    "value": "    ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 13.5,
                                    "id": "Quantity",
                                    "Description": "Quantidade do Item",
                                    "value": 0,
                                    "Type": "double"
                                },
                                {
                                    "Length": 13.5,
                                    "id": "Weight",
                                    "Description": "Peso do Item",
                                    "value": 100,
                                    "Type": "double"
                                },
                                {
                                    "Length": 13.5,
                                    "id": "NetWeight",
                                    "Description": "Peso Cubado",
                                    "value": 0,
                                    "Type": "double"
                                },
                                {
                                    "Length": 13.5,
                                    "id": "AlternativeQuantity",
                                    "Description": "Quantidade/Peso Alternativa",
                                    "value": 0,
                                    "Type": "double"
                                },
                                {
                                    "Length": 11.2,
                                    "id": "NetPrice",
                                    "Description": "Valor do Item",
                                    "value": 100,
                                    "Type": "double"
                                },
                                {
                                    "Length": 11.5,
                                    "id": "CubicVolume",
                                    "Description": "Volume Ocupado (m3)",
                                    "value": 0,
                                    "Type": "double"
                                }
                            ],
                            "id": "1"
                        }
                    ],
                    "Route": [
                        {
                            "Items": [
                                {
                                    "Length": 14,
                                    "id": "IssuerCode",
                                    "Description": "Emitente do Documento de Carga/Nota Fiscal",
                                    "value": "              ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 3,
                                    "id": "InvoiceSerie",
                                    "Description": "Série do Documento de Carga/Nota Fiscal",
                                    "value": "   ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 16,
                                    "id": "InvoiceNumber",
                                    "Description": "Número do Documento de Carga/Nota Fiscal",
                                    "value": "00001           ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 5,
                                    "id": "TypeOfDocument",
                                    "Description": "Tipo de Documento de Carga/Nota Fiscal",
                                    "value": "     ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 2,
                                    "id": "Sequence",
                                    "Description": "Sequência do Trecho. Serial único",
                                    "value": "01",
                                    "Type": "string"
                                },
                                {
                                    "Length": 14,
                                    "id": "CarrierCode",
                                    "Description": "Transportador do Trecho",
                                    "value": "              ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 7,
                                    "id": "CityCodeDelivery",
                                    "Description": "Cidade de Destino",
                                    "value": "       ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 10,
                                    "id": "TypeOfVehicle",
                                    "Description": "Tipo de veículo do trecho",
                                    "value": "          ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 7,
                                    "id": "CityCodeOrigin",
                                    "Description": "Número Cidade Origem",
                                    "value": "       ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 8,
                                    "id": "ZipCodeOrigin",
                                    "Description": "CEP de Origem",
                                    "value": "        ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 8,
                                    "id": "ZipCodeDelivery",
                                    "Description": "CEP de Destino",
                                    "value": "        ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 4,
                                    "id": "FreightClassification",
                                    "Description": "Classificação de Frete",
                                    "value": "    ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 10,
                                    "id": "OperationType",
                                    "Description": "Tipo de Operação",
                                    "value": "          ",
                                    "Type": "string"
                                }
                            ],
                            "id": "1"
                        }
                    ],
                    "DocumentBurden": [
                        {
                            "Items": [
                                {
                                    "Length": 8,
                                    "id": "ManifestNumber",
                                    "Description": "Código agrupador/Romaneio",
                                    "value": "01      ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 14,
                                    "id": "IssuerCode",
                                    "Description": "Emitente do Documento de Carga/Nota Fiscal",
                                    "value": "              ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 3,
                                    "id": "InvoiceSerie",
                                    "Description": "Série do Documento de Carga/Nota Fiscal",
                                    "value": "   ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 16,
                                    "id": "InvoiceNumber",
                                    "Description": "Número do Documento de Carga/Nota Fiscal",
                                    "value": "00001           ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 5,
                                    "id": "TypeOfDocument",
                                    "Description": "Tipo do Documento de Carga/Nota Fiscal",
                                    "value": "",
                                    "Type": "string"
                                },
                                {
                                    "Length": 14,
                                    "id": "SenderCode",
                                    "Description": "Remetente do Documento de Carga/Nota Fiscal",
                                    "value": "000000001     ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 14,
                                    "id": "CostumerCode",
                                    "Description": "Destinat\ufffdrio do Documento de Carga/Nota Fiscal",
                                    "value": "000000003     ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 60,
                                    "id": "DeliveryAddress",
                                    "Description": "Endereço de Entrega do Documento de Carga/Nota Fiscal",
                                    "value": "",
                                    "Type": "string"
                                },
                                {
                                    "Length": 50,
                                    "id": "DeliveryDistrict",
                                    "Description": "Bairro de Entrega do Documento de Carga/Nota Fiscal",
                                    "value": "",
                                    "Type": "string"
                                },
                                {
                                    "Length": 7,
                                    "id": "CityCodeDelivery",
                                    "Description": "Cidade de Entrega do Documento de Carga/Nota Fiscal",
                                    "value": "       ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 8,
                                    "id": "ZipCodeDelivery",
                                    "Description": "CEP de Entrega do Documento de Carga/Nota Fiscal",
                                    "value": "        ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 13.5,
                                    "id": "Unitizador",
                                    "Description": "Quantidade de Unitizadores",
                                    "value": 1,
                                    "Type": "double"
                                }
                            ],
                            "id": "1"
                        }
                    ]
                }
            ]
        }
    ]
}

Arquivo JSON de entrada mínimo para simulação para ser utilizado como base.

Bloco de código
languagexml
themeMidnight
titleJSON Entrada - Mínimo para simulação
collapsetrue
{
    "content": [
        {
            "Items": [
                {
                    "Manifest": [
                    ],
                    "id": "1",
                    "ItemsDocumentBurden": [
                        {
                            "Items": [
                                {
                                    "id": "Weight",
                                    "value": 20
                                }
                            ],
                            "id": "1"
                        }
                    ],
                    "Route": [
                        {
                            "Items": [

                            ],
                            "id": "1"
                        }
                    ],
                    "DocumentBurden": [
                        {
                            "Items": [
                                {
                                    "id": "SenderCode",
                                    "value": "000000001"
                                },
                                {
                                    "id": "CostumerCode",
                                    "value": "000000003"
                                }
                            ],
                            "id": "1"
                        }
                    ]
                }
            ]
        }
    ]
}

Arquivo JSON exemplo da saída simplificada com cálculo executado com sucesso.

Bloco de código
languagexml
themeMidnight
titleJSON Saída Simplificada
collapsetrue
{
    "content": [
        {
            "Items": [
                {
                    "FreightCalculation": [
                        {
                            "SimulationNumber": "000001",
                            "Items": [
                                {
                                    "id": "CarrierCode",
                                    "Description": "Código do Transportador da rota calculada",
                                    "value": "000000002     ",
                                    "length": 14,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierCnpj",
                                    "Description": "CNPJ do Transportador da rota calculada",
                                    "value": "48411553000163       ",
                                    "length": 21,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierName",
                                    "Description": "Nome do Transportador da rota calculada",
                                    "value": "TRANSP JOINVILLE                                                                ",
                                    "length": 80,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteCode",
                                    "Description": "Código da rota utilizada para o cálculo",
                                    "value": "0002",
                                    "length": 4,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteName",
                                    "Description": "Descrição da rota utilizada para o cálculo",
                                    "value": "País - 105 - BRASIL , UF - MG | País - 105 - BRASIL , UF - SC",
                                    "length": 150,
                                    "type": "string"
                                },
                                {
                                    "id": "TypeCapacity",
                                    "Description": "Tipo Lotação da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Veículo Dedicado)",
                                    "value": "Carga Fracionada",
                                    "length": 16,
                                    "type": "string"
                                },
                                {
                                    "id": "CostFreight",
                                    "Description": "Valor total do Frete",
                                    "value": 303,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "Tax",
                                    "Description": "Valor do imposto",
                                    "value": 30.3,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "DeliveryTime",
                                    "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss",
                                    "value": "0000-00-00T00:00:00",
                                    "length": "19",
                                    "type": "string"
                                }
                            ]
                        },
                        {
                            "SimulationNumber": "000002",
                            "Items": [
                                {
                                    "id": "CarrierCode",
                                    "Description": "Código do Transportador da rota calculada",
                                    "value": "000200001     ",
                                    "length": 14,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierCnpj",
                                    "Description": "CNPJ do Transportador da rota calculada",
                                    "value": "29801143000184       ",
                                    "length": 21,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierName",
                                    "Description": "Nome do Transportador da rota calculada",
                                    "value": "TRANSP MG                                                                       ",
                                    "length": 80,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteCode",
                                    "Description": "Código da rota utilizada para o cálculo",
                                    "value": "0001",
                                    "length": 4,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteName",
                                    "Description": "Descrição da rota utilizada para o cálculo",
                                    "value": "País - 105 - BRASIL , UF - SC | País - 105 - BRASIL , UF - MG",
                                    "length": 150,
                                    "type": "string"
                                },
                                {
                                    "id": "TypeCapacity",
                                    "Description": "Tipo Lotação da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Veículo Dedicado)",
                                    "value": "Carga Fracionada",
                                    "length": 16,
                                    "type": "string"
                                },
                                {
                                    "id": "CostFreight",
                                    "Description": "Valor total do Frete",
                                    "value": 100,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "Tax",
                                    "Description": "Valor do imposto",
                                    "value": 10,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "DeliveryTime",
                                    "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss",
                                    "value": "2017-10-25T16:33:44",
                                    "length": "19",
                                    "type": "string"
                                }
                            ]
                        },
                        {
                            "SimulationNumber": "000003",
                            "Items": [
                                {
                                    "id": "CarrierCode",
                                    "Description": "Código do Transportador da rota calculada",
                                    "value": "000400002     ",
                                    "length": 14,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierCnpj",
                                    "Description": "CNPJ do Transportador da rota calculada",
                                    "value": "87333684814          ",
                                    "length": 21,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierName",
                                    "Description": "Nome do Transportador da rota calculada",
                                    "value": "TRANSP AUTONOMO SP                                                              ",
                                    "length": 80,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteCode",
                                    "Description": "Código da rota utilizada para o cálculo",
                                    "value": "0001",
                                    "length": 4,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteName",
                                    "Description": "Descrição da rota utilizada para o cálculo",
                                    "value": "País - 105 - BRASIL , UF - MG | País - 105 - BRASIL , UF - SC",
                                    "length": 150,
                                    "type": "string"
                                },
                                {
                                    "id": "TypeCapacity",
                                    "Description": "Tipo Lotação da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Veículo Dedicado)",
                                    "value": "Carga Fracionada",
                                    "length": 16,
                                    "type": "string"
                                },
                                {
                                    "id": "CostFreight",
                                    "Description": "Valor total do Frete",
                                    "value": 1100,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "Tax",
                                    "Description": "Valor do imposto",
                                    "value": 0,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "DeliveryTime",
                                    "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss",
                                    "value": "2017-10-25T16:33:44",
                                    "length": "19",
                                    "type": "string"
                                }
                            ]
                        },
                        {
                            "SimulationNumber": "000004",
                            "Items": [
                                {
                                    "id": "CarrierCode",
                                    "Description": "Código do Transportador da rota calculada",
                                    "value": "36265337432   ",
                                    "length": 14,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierCnpj",
                                    "Description": "CNPJ do Transportador da rota calculada",
                                    "value": "36265337432          ",
                                    "length": 21,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierName",
                                    "Description": "Nome do Transportador da rota calculada",
                                    "value": "TRANSP INT CNPJ                                                                 ",
                                    "length": 80,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteCode",
                                    "Description": "Código da rota utilizada para o cálculo",
                                    "value": "0002",
                                    "length": 4,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteName",
                                    "Description": "Descrição da rota utilizada para o cálculo",
                                    "value": "País - 105 - BRASIL , UF - SC | País - 105 - BRASIL , UF - MG",
                                    "length": 150,
                                    "type": "string"
                                },
                                {
                                    "id": "TypeCapacity",
                                    "Description": "Tipo Lotação da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Veículo Dedicado)",
                                    "value": "Carga Fracionada",
                                    "length": 16,
                                    "type": "string"
                                },
                                {
                                    "id": "CostFreight",
                                    "Description": "Valor total do Frete",
                                    "value": 210,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "Tax",
                                    "Description": "Valor do imposto",
                                    "value": 0,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "DeliveryTime",
                                    "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss",
                                    "value": "2017-10-25T16:33:44",
                                    "length": "19",
                                    "type": "string"
                                }
                            ]
                        },
                        {
                            "SimulationNumber": "000005",
                            "Items": [
                                {
                                    "id": "CarrierCode",
                                    "Description": "Código do Transportador da rota calculada",
                                    "value": "7752          ",
                                    "length": 14,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierCnpj",
                                    "Description": "CNPJ do Transportador da rota calculada",
                                    "value": "07528127000127       ",
                                    "length": 21,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierName",
                                    "Description": "Nome do Transportador da rota calculada",
                                    "value": "BENEDETTI & BENEDETTI TRANSPS E LOGISTI                                         ",
                                    "length": 80,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteCode",
                                    "Description": "Código da rota utilizada para o cálculo",
                                    "value": "0002",
                                    "length": 4,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteName",
                                    "Description": "Descrição da rota utilizada para o cálculo",
                                    "value": "Cidade - 4242091 - JOINVILLE | Cidade - 3131062 - BELO HORIZONTE",
                                    "length": 150,
                                    "type": "string"
                                },
                                {
                                    "id": "TypeCapacity",
                                    "Description": "Tipo Lotação da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Veículo Dedicado)",
                                    "value": "Carga Fracionada",
                                    "length": 16,
                                    "type": "string"
                                },
                                {
                                    "id": "CostFreight",
                                    "Description": "Valor total do Frete",
                                    "value": 1200,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "Tax",
                                    "Description": "Valor do imposto",
                                    "value": 120,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "DeliveryTime",
                                    "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss",
                                    "value": "0000-00-00T00:00:00",
                                    "length": "19",
                                    "type": "string"
                                }
                            ]
                        },
                        {
                            "SimulationNumber": "000006",
                            "Items": [
                                {
                                    "id": "CarrierCode",
                                    "Description": "Código do Transportador da rota calculada",
                                    "value": "843770001     ",
                                    "length": 14,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierCnpj",
                                    "Description": "CNPJ do Transportador da rota calculada",
                                    "value": "56062926000166       ",
                                    "length": 21,
                                    "type": "string"
                                },
                                {
                                    "id": "CarrierName",
                                    "Description": "Nome do Transportador da rota calculada",
                                    "value": "TRANSP 1 DOC CARGA POR ROMANEIO JLLE                                            ",
                                    "length": 80,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteCode",
                                    "Description": "Código da rota utilizada para o cálculo",
                                    "value": "0002",
                                    "length": 4,
                                    "type": "string"
                                },
                                {
                                    "id": "RouteName",
                                    "Description": "Descrição da rota utilizada para o cálculo",
                                    "value": "País - 105 - BRASIL , UF - SC | País - 105 - BRASIL , UF - MG",
                                    "length": 150,
                                    "type": "string"
                                },
                                {
                                    "id": "TypeCapacity",
                                    "Description": "Tipo Lotação da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Veículo Dedicado)",
                                    "value": "Carga Fracionada",
                                    "length": 16,
                                    "type": "string"
                                },
                                {
                                    "id": "CostFreight",
                                    "Description": "Valor total do Frete",
                                    "value": 257,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "Tax",
                                    "Description": "Valor do imposto",
                                    "value": 0,
                                    "length": 11.2,
                                    "type": "double"
                                },
                                {
                                    "id": "DeliveryTime",
                                    "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss",
                                    "value": "2017-10-25T16:33:44",
                                    "length": "19",
                                    "type": "string"
                                }
                            ]
                        }
                    ],
                    "Status": "ok",
                    "Message": "FreightSimulations: Simulação realizada com sucesso."
                }
            ]
        }
    ]
}

Arquivo JSON exemplo de simulação de frete não realizada.

Bloco de código
languagexml
themeMidnight
titleJSON Saída Simulação não realizada
collapsetrue
{
    "content": [
        {
            "Items": [
                {
                    "Status": "error",
                    "Message": "\\LOG_GFE\\CalculoFrete_T1D MG 01     _20171012_090541_286.LOG",
                    "Error": "O cálculo de frete não pode ser realizado, demais informações podem ser visualizadas no arquivo de LOG de cálculo, quando parametrizado para gerar".
                }
            ]
        }
    ]
}

Arquivo JSON exemplo de validação do Código do Transportador (CarrierCode).

Bloco de código
languagexml
themeMidnight
titleJSON Saída Validação Código Transportador
collapsetrue
{
    "content": [
        {
            "Items": [
                {
                    "Status": "error",
                    "Message": "Campo CarrierCode. Código do Transportador (0000000029    ) não encontrado na base de dados, verifique o cadastro de Emitentes se este código existe. ",
                    "Error": "O cálculo de frete não pode ser realizado, demais informações podem ser visualizadas no arquivo de LOG de cálculo, quando parametrizado para gerar".
                }
            ]
        }
    ]
}

Arquivo JSON exemplo de validação do Tipo de Veículo (TypeOfVehicle).

Bloco de código
languagexml
themeMidnight
titleJSON Saída Validação Tipo de Veículo
collapsetrue
{
    "content": [
        {
            "Items": [
                {
                    "Status": "error",
                    "Message": "Campo TypeOfVehicle. Tipo de Veículo (zzzzz     ) não encontrado na base de dados, verifique se este código existe no cadastro de Tipo de Veículo. ",
                    "Error": "O cálculo de frete não pode ser realizado, demais informações podem ser visualizadas no arquivo de LOG de cálculo quando parametrizado para gerar"
                }
            ]
        }
    ]
}

Arquivo JSON exemplo de validação do Classificação de Frete (FreightClassification).

Bloco de código
languagexml
themeMidnight
titleJSON Saída Validação Classificação Frete
collapsetrue
{
    "content": [
        {
            "Items": [
                {
                    "Status": "error",
                    "Message": "Campo FreightClassification. Classificação de Frete (1234) não encontrado na base de dados, verifique se este código existe no cadastro de Classificação de Frete. ",
                    "Error": "O cálculo de frete não pode ser realizado, demais informações podem ser visualizadas no arquivo de LOG de cálculo quando parametrizado para gerar"
                }
            ]
        }
    ]
}

Arquivo JSON exemplo de validação do Tipo de Operação (OperationType).

Bloco de código
languagexml
themeMidnight
titleJSON Saída Validação Tipo de Operação
collapsetrue
{
    "content": [
        {
            "Items": [
                {
                    "Status": "error",
                    "Message": "Campo OperationType. Tipo de Operação (1111      ) não encontrado na base de dados, verifique se este código existe no cadastro de Tipo de Operação. ",
                    "Error": "O cálculo de frete não pode ser realizado, demais informações podem ser visualizadas no arquivo de LOG de cálculo quando parametrizado para gerar"
                }
            ]
        }
    ]
}

Detalhamento dos Agrupadores e Tags de Entrada

Manifest - Informações do romaneio. Ocorrências 1 ou mais.FieldDescriçãoChaveTipoTamanhoObservaçãoManifestNumberCódigo agrupador/Romaneio.*Alfanumerico8Obrigatório.CarrierCodeTransportador a ser considerado no cálculo, quando não informado no trecho/rota.Alfanumérico14TypeOfVehicleTipo de Veículo.Alfanumérico10FreightClassificationClassificação de Frete.Alfanumérico4OperationTypeTipo de Operação.Alfanumérico10DocumentBurden - Documentos de Carga do Romaneio - Para cada Manifest haverá uma ou mais ocorrências de DocumentBurden.FieldDescriçãoChaveTipoTamanhoObservaçãoManifestNumberCódigo agrupador/Romaneio.*Alfanumérico8Obrigatório. Campo de ligação com o agrupador Manifest/ManifestNumber.IssuerCodeEmitente do Documento de Carga/Nota Fiscal.*Alfanumérico14InvoiceSerieSérie do Documento de Carga/Nota Fiscal.*Alfanumérico3InvoiceNumberNúmero do Documento de Carga/Nota Fiscal.*Alfanumérico16TypeOfDocumentTipo do Documento de Carga/Nota Fiscal.*Alfanumérico5Caso não seja informado, será considerado o primeiro registro ativo na tabela GV5.SenderCodeRemetente do Documento de Carga/Nota Fiscal.Alfanumérico14Obrigatório, registro válido no banco de dados.CostumerCodeDestinatário do Documento de Carga/Nota Fiscal.Alfanumérico14Obrigatório, registro válido no banco de dados.DeliveryAddressEndereço de Entrega do Documento de Carga/Nota Fiscal.Alfanumérico60DeliveryDistrictBairro de Entrega do Documento de Carga/Nota Fiscal.Alfanumérico50CityCodeDeliveryCidade de Entrega do Documento de Carga/Nota Fiscal.Alfanumérico7ZipCodeDeliveryCEP de Entrega do Documento de Carga/Nota Fiscal.Alfanumérico8UnitizadorQuantidade de Unitizadores.Numérico13,5Padrão "1".Route - Trechos dos Documentos de Carga - Para cada DocumentBurden haverá uma ou mais ocorrências de Route.FieldDescriçãoChaveTipoTamanhoObservaçãoIssuerCodeEmitente do Documento de Carga/Nota Fiscal.*Alfanumérico14Campo de ligação com o agrupador DocumentBurden/IssuerCode.InvoiceSerieSérie do Documento de Carga/Nota Fiscal.*Alfanumérico3Campo de ligação com o agrupador DocumentBurden/InvoiceSerie.InvoiceNumberNúmero do Documento de Carga/Nota Fiscal.*Alfanumérico16Campo de ligação com o agrupador DocumentBurden/InvoiceNumber.TypeOfDocumentTipo de Documento de Carga/Nota Fiscal.*Alfanumérico5Campo de ligação com o agrupador DocumentBurden/TypeOfDocument.SequenceSequência do Trecho. Serial único.Alfanumérico2Sequencial único.CarrierCodeTransportador do trecho/rota. Ao utilizar o transportador em branco, será realizada a simulação para todos os trechos encontrados. Se informar o transportador, somente este será considerado.Alfanumérico14CityCodeDeliveryCidade de Destino.Alfanumérico7(*) Caso não seja informada, será considerada a cidade do endereço de entrega, quando preenchida, ou do destinatário do Documento de Carga.TypeOfVehicleTipo de veículo do trecho.Alfanumérico10CityCodeOriginNúmero Cidade Origem.Alfanumérico7(*) Caso não seja informada, será considerada a cidade do endereço do Remetente ou a cidade de destino do trecho anterior, quando houver.ZipCodeOriginCEP de Origem.Alfanumérico8ZipCodeDeliveryCEP de Destino.Alfanumérico8FreightClassificationClassificação de Frete.Alfanumérico4OperationTypeTipo de Operação.Alfanumérico10ItemsDocumentBurden - Itens dos Documentos de Carga - Para cada DocumentBurden haverá uma ou mais ocorrências de ItemsDocumentBurden.FieldDescriçãoChaveTipoTamanhoObservaçãoIssuerCodeEmitente do Documento de Carga/Nota Fiscal.*Alfanumérico14Campo de ligação com o agrupador DocumentBurden/IssuerCode.InvoiceSerieSérie do Documento de Carga/Nota Fiscal.*Alfanumérico3Campo de ligação com o agrupador DocumentBurden/InvoiceSerie.InvoiceNumberNúmero do Documento de Carga/Nota Fiscal.*Alfanumérico16Campo de ligação com o agrupador DocumentBurden/InvoiceNumber.TypeOfDocumentTipo do Documento de Carga/Nota Fiscal.*Alfanumérico5Campo de ligação com o agrupador DocumentBurden/TypeOfDocument.ItemCodeCódigo do Item do Documento de Carga/Nota Fiscal.Alfanumérico15FreightClassificationClassificação de Frete do Item Documento de Carga/Nota Fiscal.Alfanumérico4ItemTypeTipo do Item do Documento de Carga/Nota Fiscal.Alfanumérico4QuantityQuantidade do Item.Numérico13,5WeightPeso do Item.Numérico13,5NetWeightPeso Cubado.Numérico13,5AlternativeQuantityQuantidade/Peso Alternativa.Numérico13,5NetPriceValor do Item.Numérico11,2CubicVolumeVolume Ocupado (m3).Numérico11,5

Detalhamento dos Agrupadores e Tags de Saída

FreightCalculation - Simulações realizadas.FieldDescriçãoTipoTamanhoCarrierCodeCodigo do Transportador da rota calculada.Alfanumérico14CarrierCnpjCNPJ do Transportador da rota calculada.Alfanumérico14CarrierNameNome do Transportador da rota calculada.Alfanumérico80RouteCodeCódigo da rota utilizada para o cálculo.Alfanumérico4RouteNameDescrição da rota utilizada para o cálculo.Alfanumérico150TypeCapacityTipo de Lotação da Tabela de Frete (1=Carga Fracionada; 2=Carga Fechada; 3=Veículo Dedicado).Alfanumérico1CostFreightValor total do Frete.Numérico12,2TaxValor Imposto (ICMS ou ISS).Numérico12,2DeliveryTimePrazo de Entrega no formato YYYY-MM-DDThh:mm:ss.Alfanumérico19

Detalhamento técnico da estrutura do arquivo

Estrutura do arquivo de entrada.

TAGSDescriçãocontentsAgrupador.itemsAgrupador.manifestAgrupador dos romaneios.ManifestNumberCódigo agrupador/Romaneio.CarrierCodeTransportador a ser considerado no calculo quando não informado no trecho/rota.TypeOfVehicleTipo de Veículo.FreightClassificationClassificação de Frete.OperationTypeTipo de Operação.DocumentBurdenAgrupador dos Documentos de Carga.ItemsAgrupador.ManifestNumberCódigo agrupador/Romaneio.IssuerCodeEmitente do Documento de Carga/Nota Fiscal.InvoiceSerieSérie do Documento de Carga/Nota Fiscal.InvoiceNumberNúmero do Documento de Carga/Nota Fiscal.TypeOfDocumentTipo do Documento de Carga/Nota Fiscal.SenderCodeRemetente do Documento de Carga/Nota Fiscal.CostumerCodeDestinatário do Documento de Carga/Nota Fiscal.DeliveryAddressEndereço de Entrega do Documento de Carga/Nota Fiscal.DeliveryDistrictBairro de Entrega do Documento de Carga/Nota Fiscal.CityCodeDeliveryCidade de Entrega do Documento de Carga/Nota Fiscal.ZipCodeDeliveryCEP de Entrega do Documento de Carga/Nota Fiscal.UnitizadorQuantidade de Unitizadores.RouteAgrupador das Rotas do Documento de Carga.ItemsAgrupador.IssuerCodeEmitente do Documento de Carga/Nota Fiscal.InvoiceSerieSérie do Documento de Carga/Nota Fiscal.InvoiceNumberNúmero do Documento de Carga/Nota Fiscal.TypeOfDocumentTipo de Documento de Carga/Nota Fiscal.SequenceSequência do Trecho. Serial único.CarrierCodeTransportador do trecho/rota. Ao utilizar o transportador em branco, será realizada a simulação para todos os trechos encontrados. Ao informar o transportador, somente este será considerado.CityCodeDeliveryCidade de Destino.TypeOfVehicleTipo de veículo do trecho.CityCodeOriginNúmero Cidade Origem.ZipCodeOriginCEP de Origem.ZipCodeDeliveryCEP de Destino.FreightClassificationClassificação de Frete.OperationTypeTipo de Operação.ItemsDocumentBurdenAgrupador dos Itens do Documento de Carga.ItemsAgrupador.IssuerCodeEmitente do Documento de Carga/Nota Fiscal.InvoiceSerieSérie do Documento de Carga/Nota Fiscal.InvoiceNumberNúmero do Documento de Carga/Nota Fiscal.TypeOfDocumentTipo do Documento de Carga/Nota Fiscal.ItemCodeCódigo do Item do Documento de Carga/Nota Fiscal.FreightClassificationClassificação de Frete do Item do Documento de Carga/Nota Fiscal.ItemTypeTipo do Item do Documento de Carga/Nota Fiscal.QuantityQuantidade do Item.WeightPeso do Item.NetWeightPeso Cubado.AlternativeQuantityQuantidade/Peso Alternativa.NetPriceValor do Item.CubicVolumeVolume Ocupado (m3).

Estrutura do arquivo da simulação realizada.

TAGSDescriçãocontentAgrupador.ItemsAgrupador.StatusStatus.MessageMensagem do Status.FreightCalculationAgrupador.SimulationNumberNúmero da Simulação.ItemsAgrupador.CarrierCodeCódigo do Transportador da rota calculada.CarrierCnpjCNPJ do Transportador da rota calculada.CarrierNameNome do Transportador da rota calculada.RouteCodeCódigo da rota utilizada para o cálculo.RouteNameDescrição da rota utilizada para o cálculo.TypeCapacityTipo de Lotação da Tabela de Frete (1=Carga Fracionada; 2=Carga Fechada; 3=Veículo Dedicado).CostFreightValor total do Frete.TaxValor Imposto (ICMS ou ISS).DeliveryTimePrazo de Entrega no formato YYYY-MM-DDThh:mm:ss.

Estrutura do arquivo de simulação não realizada.

TAGSDescriçãocontentAgrupador.ItemsAgrupador.StatusStatus.MessageMensagem do Status.ErrorMensagem de erro.