Árvore de páginas

Índice


Objetivo

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.


Método Publicado

FonteGFEWSSIMULATIONEndereço das Versões
Nome do ServiçoFREIGHTSIMULATIONhttp://endereco.com:porta/rest/FREIGHTSIMULATION/supply/gfe/v1/freightsimulations/freightsimulation/
http://endereco.com:porta/rest/FREIGHTSIMULATION/supply/gfe/v2/freightsimulations/freightsimulation/ 

Importante

Recomendada a utilização da versão 2 da API.


Pré-requisitos para Utilização

  • Atualização do Microsiga Protheus com versão igual ou superior a 12.1.17.
  • Atualização da Build 131227a a partir da versão 13.2.3.6.
  • 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.


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


  • API FREIGHTSIMULATION.



  • Métodos disponíveis no API FREIGHTSIMULATION


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.


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.

 

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).

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


Exemplo de arquivo JSON

Arquivo JSON de entrada para ser utilizado como base.

    JSON Entrada v1
    {
        "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"
                            },
    						{
    							"Length": 20,
    							"id": "BaseDate",
    							"Description": "Data Base para cálculo",
    							"value": "2024-08-15T00:00:00"
    							"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"
                            }
                        ]
                    }
                ]
            }
        ]
    }
    JSON Entrada v2
    {
        "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 Liquido do Item",
                                        "value": 100,
                                        "Type": "double"
                                    },
                                    {
                                        "Length": 11.2,
                                        "id": "GrossPrice",
                                        "Description": "Valor do Bruto 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": 6,
                                        "id": "SenderERPCode",
                                        "Description": "Código do ERP do 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": 6,
                                        "id": "CostumerERPCode",
                                        "Description": "Código do ERP do 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.

    JSON Entrada - Mínimo para simulação
    {
        "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.

    JSON Saída Simplificada
    {
        "content": [
            {
                "Items": [
                    {
                        "Status": "ok",
                        "Message": "FreightSimulations: Simula\ufffd\ufffdo realizada com sucesso.",
                        "FreightCalculation": [
                            {
                                "SimulationNumber": "000001",
                                "Items": [
                                    {
                                        "type": "string",
                                        "length": 14,
                                        "id": "CarrierCode",
                                        "value": "49            ",
                                        "Description": "C\ufffddigo do Transportador da rota calculada"
                                    },
                                    {
                                        "type": "string",
                                        "length": 21,
                                        "id": "CarrierCnpj",
                                        "value": "84429869000308       ",
                                        "Description": "CNPJ do Transportador da rota calculada"
                                    },
                                    {
                                        "type": "string",
                                        "length": 80,
                                        "id": "CarrierName",
                                        "value": "ABC-TRANSP                                                                      ",
                                        "Description": "Nome do Transportador da rota calculada"
                                    },
    							 	{
                                        "type": "string",
                                        "length": 14,
                                        "id": "CarrierERPCode",
                                        "value": "49            ",
                                        "Description": "Código do ERP do Transportador da rota calculada"
                                    },
                                    {
                                        "type": "string",
                                        "length": 4,
                                        "id": "RouteCode",
                                        "value": "0001",
                                        "Description": "C\ufffddigo da rota utilizada para o c\ufffdlculo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 150,
                                        "id": "RouteName",
                                        "value": "Remetente - 77170 - TOTVS S.A. | Destinat\ufffdrio - 12704 - NICOM COMERC MATS PARA CONSTRUCOES LTDA",
                                        "Description": "Descri\ufffd\ufffdo da rota utilizada para o c\ufffdlculo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 16,
                                        "id": "TypeCapacity",
                                        "value": "Carga Fracionada",
                                        "Description": "Tipo Lota\ufffd\ufffdo da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Ve\ufffdculo Dedicado)"
                                    },
                                    {
                                        "type": "double",
                                        "length": 11.2,
                                        "id": "CostFreight",
                                        "value": 100,
                                        "Description": "Valor total do Frete"
                                    },
                                    {
                                        "type": "double",
                                        "length": 11.2,
                                        "id": "Tax",
                                        "value": 7,
                                        "Description": "Valor Imposto (ICMS ou ISS)"
                                    },
                                    {
                                        "type": "string",
                                        "length": "19",
                                        "id": "DeliveryTime",
                                        "value": "0000-00-00T00:00:00",
                                        "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss"
                                    },
                                    {
                                        "type": "string",
                                        "length": 6,
                                        "id": "TableCode",
                                        "value": "000001",
                                        "Description": "C\ufffddigo da tabela utilizada para o c\ufffdlculo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 10,
                                        "id": "VehicleType",
                                        "value": "          ",
                                        "Description": "Tipo de Ve\ufffdculo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 10,
                                        "id": "OperationType",
                                        "value": "          ",
                                        "Description": "Tipo de Opera\ufffd\ufffdo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 4,
                                        "id": "FreightClassification",
                                        "value": "    ",
                                        "Description": "Classifica\ufffd\ufffdo de Frete"
                                    },
                                    {
                                        "type": "string",
                                        "length": 6,
                                        "id": "TradingCode",
                                        "value": "000001",
                                        "Description": "C\ufffddigo da Negocia\ufffd\ufffdo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 4,
                                        "id": "TrackCode",
                                        "value": "0001",
                                        "Description": "C\ufffddigo da Faixa"
                                    }
                                ],
                                "FreightComponents": [
                                    {
                                        "Items": [
                                            {
                                                "type": "string",
                                                "length": 20,
                                                "id": "ComponentCode",
                                                "value": "FRETE PESO          ",
                                                "Description": "C\ufffddigo do componente"
                                            },
                                            {
                                                "type": "double",
                                                "length": 12.2,
                                                "id": "ComponentValue",
                                                "value": 100,
                                                "Description": "Valor do componente"
                                            },
                                            {
                                                "type": "string",
                                                "length": 20,
                                                "id": "ComponentCategory",
                                                "value": "Frete Unidade",
                                                "Description": "Categoria do componente"
                                            }
                                        ]
                                    }
                                ]
                            },
                            {
                                "SimulationNumber": "000002",
                                "Items": [
                                    {
                                        "type": "string",
                                        "length": 14,
                                        "id": "CarrierCode",
                                        "value": "77785         ",
                                        "Description": "C\ufffddigo do Transportador da rota calculada"
                                    },
                                    {
                                        "type": "string",
                                        "length": 21,
                                        "id": "CarrierCnpj",
                                        "value": "06331583000110       ",
                                        "Description": "CNPJ do Transportador da rota calculada"
                                    },
                                    {
                                        "type": "string",
                                        "length": 80,
                                        "id": "CarrierName",
                                        "value": "TRANSPORTADORA SCUBIDU LTDA ME                                                  ",
                                        "Description": "Nome do Transportador da rota calculada"
                                    },
                                    {
                                        "type": "string",
                                        "length": 4,
                                        "id": "RouteCode",
                                        "value": "0001",
                                        "Description": "C\ufffddigo da rota utilizada para o c\ufffdlculo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 150,
                                        "id": "RouteName",
                                        "value": "Cidade - 4209102 - JOINVILLE | Cidade - 3550308 - SAO PAULO",
                                        "Description": "Descri\ufffd\ufffdo da rota utilizada para o c\ufffdlculo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 16,
                                        "id": "TypeCapacity",
                                        "value": "Carga Fracionada",
                                        "Description": "Tipo Lota\ufffd\ufffdo da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Ve\ufffdculo Dedicado)"
                                    },
                                    {
                                        "type": "double",
                                        "length": 11.2,
                                        "id": "CostFreight",
                                        "value": 750,
                                        "Description": "Valor total do Frete"
                                    },
                                    {
                                        "type": "double",
                                        "length": 11.2,
                                        "id": "Tax",
                                        "value": 52.5,
                                        "Description": "Valor Imposto (ICMS ou ISS)"
                                    },
                                    {
                                        "type": "string",
                                        "length": "19",
                                        "id": "DeliveryTime",
                                        "value": "0000-00-00T00:00:00",
                                        "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss"
                                    },
                                    {
                                        "type": "string",
                                        "length": 6,
                                        "id": "TableCode",
                                        "value": "000001",
                                        "Description": "C\ufffddigo da tabela utilizada para o c\ufffdlculo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 10,
                                        "id": "VehicleType",
                                        "value": "          ",
                                        "Description": "Tipo de Ve\ufffdculo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 10,
                                        "id": "OperationType",
                                        "value": "          ",
                                        "Description": "Tipo de Opera\ufffd\ufffdo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 4,
                                        "id": "FreightClassification",
                                        "value": "    ",
                                        "Description": "Classifica\ufffd\ufffdo de Frete"
                                    },
                                    {
                                        "type": "string",
                                        "length": 6,
                                        "id": "TradingCode",
                                        "value": "000001",
                                        "Description": "C\ufffddigo da Negocia\ufffd\ufffdo"
                                    },
                                    {
                                        "type": "string",
                                        "length": 4,
                                        "id": "TrackCode",
                                        "value": "0001",
                                        "Description": "C\ufffddigo da Faixa"
                                    }
                                ],
                                "FreightComponents": [
                                    {
                                        "Items": [
                                            {
                                                "type": "string",
                                                "length": 20,
                                                "id": "ComponentCode",
                                                "value": "GRIS                ",
                                                "Description": "C\ufffddigo do componente"
                                            },
                                            {
                                                "type": "double",
                                                "length": 12.2,
                                                "id": "ComponentValue",
                                                "value": 0,
                                                "Description": "Valor do componente"
                                            },
                                            {
                                                "type": "string",
                                                "length": 20,
                                                "id": "ComponentCategory",
                                                "value": "Frete Valor",
                                                "Description": "Categoria do componente"
                                            }
                                        ]
                                    },
                                    {
                                        "Items": [
                                            {
                                                "type": "string",
                                                "length": 20,
                                                "id": "ComponentCode",
                                                "value": "FRETE FIXO          ",
                                                "Description": "C\ufffddigo do componente"
                                            },
                                            {
                                                "type": "double",
                                                "length": 12.2,
                                                "id": "ComponentValue",
                                                "value": 750,
                                                "Description": "Valor do componente"
                                            },
                                            {
                                                "type": "string",
                                                "length": 20,
                                                "id": "ComponentCategory",
                                                "value": "Frete Unidade",
                                                "Description": "Categoria do componente"
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }


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

    JSON Saída Simulação não realizada
    {
        "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).

    JSON Saída Validação Código Transportador
    {
        "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).

    JSON Saída Validação Tipo de Veículo
    {
        "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).

    JSON Saída Validação Classificação Frete
    {
        "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).

    JSON Saída Validação Tipo de Operação
    {
        "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".
                    }
                ]
            }
        ]
    }


    Arquivo JSON de Build Desatualizada.

    JSON Saída Build Desatualizada
    {
        "errorCode": 500,
        "errorMessage": "invalid class JSSONOBJECT"
    }



    Detalhamento dos Agrupadores e Tags de Entrada

    Manifest - Informações do romaneio. Ocorrências 1 ou mais.
    FieldDescriçãoChaveTipoTamanhoObservação
    ManifestNumberCódigo agrupador/Romaneio.*Alfanumerico8Obrigatório.
    CarrierCodeTransportador a ser considerado no cálculo, quando não informado no trecho/rota.
    Alfanumérico14
    TypeOfVehicleTipo de Veículo.
    Alfanumérico10
    FreightClassificationClassificação de Frete.
    Alfanumérico4
    OperationTypeTipo de Operação.
    Alfanumérico10
    BaseDateData Base para cálculo.
    Alfanumérico20



    DocumentBurden - Documentos de Carga do Romaneio - Para cada Manifest haverá uma ou mais ocorrências de DocumentBurden.
    FieldDescriçãoChaveTipoTamanhoObservação
    ManifestNumberCódigo agrupador/Romaneio.*Alfanumérico8Obrigatório. Campo de ligação com o agrupador Manifest/ManifestNumber.
    IssuerCodeEmitente do Documento de Carga/Nota Fiscal.*Alfanumérico14
    InvoiceSerieSérie do Documento de Carga/Nota Fiscal.*Alfanumérico3
    InvoiceNumberNúmero do Documento de Carga/Nota Fiscal.*Alfanumérico16
    TypeOfDocumentTipo 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érico14A obrigatoriedade desta tag está em conjunto com a tag CityCodeDelivery, uma das duas deve estar preenchida para funcionamento da API. O registro informado deve estar cadastro na rotina de emitentes. (Tabela GU3)
    SenderERPCodeCódigo do ERP do Remetente do Documento de Carga/Nota Fiscal.
    Alfanumérico6Esta tag serve apenas para busca na tabela de Emitentes do código do remetente, preenchendo após esta busca, a mesma informação do SenderCode. Caso a tag SenderCode esteja preenchida, esta tag será desconsiderada.
    CostumerCodeDestinatário do Documento de Carga/Nota Fiscal.
    Alfanumérico14Obrigatório. O registro informado deve estar cadastro na rotina de emitentes. (Tabela GU3)
    CostumerERPCodeCódigo do ERP do Destinatário do Documento de Carga/Nota Fiscal.
    Alfanumérico6Esta tag serve apenas para busca na tabela de Emitentes do código do destinatário, preenchendo após esta busca, a mesma informação do CostumerCode. Caso a tag CostumerCode esteja preenchida, esta tag será desconsiderada.
    DeliveryAddressEndereço de Entrega do Documento de Carga/Nota Fiscal.
    Alfanumérico60
    DeliveryDistrictBairro de Entrega do Documento de Carga/Nota Fiscal.
    Alfanumérico50
    CityCodeDeliveryCidade de Entrega do Documento de Carga/Nota Fiscal.
    Alfanumérico7
    ZipCodeDeliveryCEP de Entrega do Documento de Carga/Nota Fiscal.
    Alfanumérico8
    UnitizadorQuantidade 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ção
    IssuerCodeEmitente 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. O valor inicial do campo deverá ser "01".
    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érico14
    CityCodeDeliveryCidade 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érico10
    CityCodeOriginNú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érico8
    ZipCodeDeliveryCEP de Destino.
    Alfanumérico8
    FreightClassificationClassificação de Frete.
    Alfanumérico4
    OperationTypeTipo de Operação.
    Alfanumérico10
      ItemsDocumentBurden - Itens dos Documentos de Carga - Para cada DocumentBurden haverá uma ou mais ocorrências de ItemsDocumentBurden.
      Field Descrição Chave Tipo Tamanho Observação
      IssuerCode Emitente do Documento de Carga/Nota Fiscal. * Alfanumérico 14 Campo de ligação com o agrupador DocumentBurden/IssuerCode.
      InvoiceSerie Série do Documento de Carga/Nota Fiscal. * Alfanumérico 3 Campo de ligação com o agrupador DocumentBurden/InvoiceSerie.
      InvoiceNumber Número do Documento de Carga/Nota Fiscal. * Alfanumérico 16 Campo de ligação com o agrupador DocumentBurden/InvoiceNumber.
      TypeOfDocument Tipo do Documento de Carga/Nota Fiscal. * Alfanumérico 5 Campo de ligação com o agrupador DocumentBurden/TypeOfDocument.
      ItemCode Código do Item do Documento de Carga/Nota Fiscal.
      Alfanumérico 15
      FreightClassification Classificação de Frete do Item Documento de Carga/Nota Fiscal.
      Alfanumérico 4
      ItemType Tipo do Item do Documento de Carga/Nota Fiscal.
      Alfanumérico 4
      Quantity Quantidade do Item.
      Numérico 13,5
      Weight Peso do Item.
      Numérico 13,5
      NetWeight Peso Cubado.
      Numérico 13,5
      AlternativeQuantity Quantidade/Peso Alternativa.
      Numérico 13,5
      NetPrice Valor do Item.
      Numérico 11,2
      CubicVolume Volume Ocupado (m3).
      Numérico 11,5
      ItemsDocumentBurden - Itens dos Documentos de Carga - Para cada DocumentBurden haverá uma ou mais ocorrências de ItemsDocumentBurden.
      Field Descrição Chave Tipo Tamanho Observação
      IssuerCode Emitente do Documento de Carga/Nota Fiscal. * Alfanumérico 14 Campo de ligação com o agrupador DocumentBurden/IssuerCode.
      InvoiceSerie Série do Documento de Carga/Nota Fiscal. * Alfanumérico 3 Campo de ligação com o agrupador DocumentBurden/InvoiceSerie.
      InvoiceNumber Número do Documento de Carga/Nota Fiscal. * Alfanumérico 16 Campo de ligação com o agrupador DocumentBurden/InvoiceNumber.
      TypeOfDocument Tipo do Documento de Carga/Nota Fiscal. * Alfanumérico 5 Campo de ligação com o agrupador DocumentBurden/TypeOfDocument.
      ItemCode Código do Item do Documento de Carga/Nota Fiscal.
      Alfanumérico 15
      FreightClassification Classificação de Frete do Item Documento de Carga/Nota Fiscal.
      Alfanumérico 4
      ItemType Tipo do Item do Documento de Carga/Nota Fiscal.
      Alfanumérico 4
      Quantity Quantidade do Item.
      Numérico 13,5
      Weight Peso do Item.
      Numérico 13,5
      NetWeight Peso Cubado.
      Numérico 13,5
      AlternativeQuantity Quantidade/Peso Alternativa.
      Numérico 13,5
      NetPrice

      Valor do Liquido do Item.


      Numérico 11,2
      CubicVolume Volume Ocupado (m3).
      Numérico 11,5
      GrossPrice

      Valor do Bruto do Item


      Numérico 11,2 Versão 2


      Detalhamento dos Agrupadores e Tags de Saída

      FreightCalculation - Simulações realizadas.
      FieldDescriçãoTipoTamanho
      CarrierCodeCodigo do Transportador da rota calculada.Alfanumérico14
      CarrierCnpjCNPJ do Transportador da rota calculada.Alfanumérico14
      CarrierNameNome do Transportador da rota calculada.Alfanumérico80
      CarrierERPCodeCódigo do ERP do Transportador da rota calculada.Alfanumérico6
      RouteCodeCódigo da rota utilizada para o cálculo.Alfanumérico4
      RouteNameDescrição da rota utilizada para o cálculo.Alfanumérico150
      TypeCapacityTipo de Lotação da Tabela de Frete (1=Carga Fracionada; 2=Carga Fechada; 3=Veículo Dedicado).Alfanumérico1
      CostFreightValor total do Frete.Numérico12,2
      TaxValor Imposto (ICMS ou ISS).Numérico12,2
      DeliveryTimePrazo de Entrega no formato YYYY-MM-DDThh:mm:ss.Alfanumérico19
      TableCodeCódigo da tabela utilizada para o cálculoAlfanumérico6
      VehicleTypeTipo de VeículoAlfanúmerico10
      OperationTypeTipo de OperaçãoAlfanúmerico10
      FreightClassificationClassificação de FreteAlfanúmerico4
      TradingCodeCódigo da NegociaçãoAlfanúmerico6
      TrackCodeCódigo da FaixaAlfanúmerico4
      FreightComponents - Componentes do Cálculo de Frete
      FieldDescriçãoTipoTamanho
      ComponentCodeCódigo do ComponenteAlfanúmerico20
      ComponentValueValor do ComponenteNúmerico12,2
      ComponentCategoryCategoria do ComponenteAlfanúmerico20

      Detalhamento técnico da estrutura do arquivo

      Estrutura do arquivo de entrada.

        TAGS Descrição
        contents




        Agrupador.

        items



        Agrupador.


        manifest


        Agrupador dos romaneios.



        ManifestNumber
        Código agrupador/Romaneio.



        CarrierCode
        Transportador a ser considerado no calculo quando não informado no trecho/rota.



        TypeOfVehicle
        Tipo de Veículo.



        FreightClassification Classificação de Frete.



        OperationType
        Tipo de Operação.



        BaseDate
        Data base para cálculo



        DocumentBurden
        Agrupador dos Documentos de Carga.




        Items
        Agrupador.





        ManifestNumber Código agrupador/Romaneio.





        IssuerCode Emitente do Documento de Carga/Nota Fiscal.





        InvoiceSerie Série do Documento de Carga/Nota Fiscal.





        InvoiceNumber Número do Documento de Carga/Nota Fiscal.





        TypeOfDocument Tipo do Documento de Carga/Nota Fiscal.





        SenderCode Remetente do Documento de Carga/Nota Fiscal.





        SenderERPCode Código do ERP do Remetente do Documento de Carga/Nota Fiscal.





        CostumerCode Destinatário do Documento de Carga/Nota Fiscal.





        CostumerERPCode Código do ERP do Destinatário do Documento de Carga/Nota Fiscal.





        DeliveryAddress Endereço de Entrega do Documento de Carga/Nota Fiscal.





        DeliveryDistrict Bairro de Entrega do Documento de Carga/Nota Fiscal.





        CityCodeDelivery Cidade de Entrega do Documento de Carga/Nota Fiscal.





        ZipCodeDelivery CEP de Entrega do Documento de Carga/Nota Fiscal.





        Unitizador Quantidade de Unitizadores.



        Route

        Agrupador das Rotas do Documento de Carga.




        Items
        Agrupador.





        IssuerCode Emitente do Documento de Carga/Nota Fiscal.





        InvoiceSerie Série do Documento de Carga/Nota Fiscal.





        InvoiceNumber Número do Documento de Carga/Nota Fiscal.





        TypeOfDocument Tipo de Documento de Carga/Nota Fiscal.





        Sequence Sequência do Trecho. Serial único.





        CarrierCode Transportador 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.





        CityCodeDelivery Cidade de Destino.





        TypeOfVehicle Tipo de veículo do trecho.





        CityCodeOrigin Número Cidade Origem.





        ZipCodeOrigin CEP de Origem.





        ZipCodeDelivery CEP de Destino.





        FreightClassification Classificação de Frete.





        OperationType Tipo de Operação.



        ItemsDocumentBurden Agrupador dos Itens do Documento de Carga.




        Items
        Agrupador.





        IssuerCode Emitente do Documento de Carga/Nota Fiscal.





        InvoiceSerie Série do Documento de Carga/Nota Fiscal.





        InvoiceNumber Número do Documento de Carga/Nota Fiscal.





        TypeOfDocument Tipo do Documento de Carga/Nota Fiscal.





        ItemCode Código do Item do Documento de Carga/Nota Fiscal.





        FreightClassification Classificação de Frete do Item do Documento de Carga/Nota Fiscal.





        ItemType Tipo do Item do Documento de Carga/Nota Fiscal.





        Quantity Quantidade do Item.





        Weight Peso do Item.





        NetWeight Peso Cubado.





        AlternativeQuantity Quantidade/Peso Alternativa.





        NetPrice Valor do Item.





        CubicVolume Volume Ocupado (m3).
        TAGS Descrição
        contents




        Agrupador.

        items



        Agrupador.


        manifest


        Agrupador dos romaneios.



        ManifestNumber
        Código agrupador/Romaneio.



        CarrierCode
        Transportador a ser considerado no calculo quando não informado no trecho/rota.



        TypeOfVehicle
        Tipo de Veículo.



        FreightClassification Classificação de Frete.



        OperationType
        Tipo de Operação.



        DocumentBurden
        Agrupador dos Documentos de Carga.




        Items
        Agrupador.





        ManifestNumber Código agrupador/Romaneio.





        IssuerCode Emitente do Documento de Carga/Nota Fiscal.





        InvoiceSerie Série do Documento de Carga/Nota Fiscal.





        InvoiceNumber Número do Documento de Carga/Nota Fiscal.





        TypeOfDocument Tipo do Documento de Carga/Nota Fiscal.





        SenderCode Remetente do Documento de Carga/Nota Fiscal.





        CostumerCode Destinatário do Documento de Carga/Nota Fiscal.





        DeliveryAddress Endereço de Entrega do Documento de Carga/Nota Fiscal.





        DeliveryDistrict Bairro de Entrega do Documento de Carga/Nota Fiscal.





        CityCodeDelivery Cidade de Entrega do Documento de Carga/Nota Fiscal.





        ZipCodeDelivery CEP de Entrega do Documento de Carga/Nota Fiscal.





        Unitizador Quantidade de Unitizadores.



        Route

        Agrupador das Rotas do Documento de Carga.




        Items
        Agrupador.





        IssuerCode Emitente do Documento de Carga/Nota Fiscal.





        InvoiceSerie Série do Documento de Carga/Nota Fiscal.





        InvoiceNumber Número do Documento de Carga/Nota Fiscal.





        TypeOfDocument Tipo de Documento de Carga/Nota Fiscal.





        Sequence Sequência do Trecho. Serial único.





        CarrierCode Transportador 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.





        CityCodeDelivery Cidade de Destino.





        TypeOfVehicle Tipo de veículo do trecho.





        CityCodeOrigin Número Cidade Origem.





        ZipCodeOrigin CEP de Origem.





        ZipCodeDelivery CEP de Destino.





        FreightClassification Classificação de Frete.





        OperationType Tipo de Operação.



        ItemsDocumentBurden Agrupador dos Itens do Documento de Carga.




        Items
        Agrupador.





        IssuerCode Emitente do Documento de Carga/Nota Fiscal.





        InvoiceSerie Série do Documento de Carga/Nota Fiscal.





        InvoiceNumber Número do Documento de Carga/Nota Fiscal.





        TypeOfDocument Tipo do Documento de Carga/Nota Fiscal.





        ItemCode Código do Item do Documento de Carga/Nota Fiscal.





        FreightClassification Classificação de Frete do Item do Documento de Carga/Nota Fiscal.





        ItemType Tipo do Item do Documento de Carga/Nota Fiscal.





        Quantity Quantidade do Item.





        Weight Peso do Item.





        NetWeight Peso Cubado.





        AlternativeQuantity Quantidade/Peso Alternativa.





        NetPrice Valor Líquido do Item.





        CubicVolume Volume Ocupado (m3).





        GrossPrice

        Valor do Bruto do Item.


        Estrutura do arquivo da simulação realizada.

        TAGSDescrição
        content




        Agrupador.

        Items



        Agrupador.


        Status


        Status.


        Message


        Mensagem do Status.


        FreightCalculation

        Agrupador.



        SimulationNumber

        Número da Simulação.



        Items

        Agrupador.




        CarrierCode
        Código do Transportador da rota calculada.




        CarrierCnpj
        CNPJ do Transportador da rota calculada.




        CarrierName
        Nome do Transportador da rota calculada.




        RouteCode
        Código da rota utilizada para o cálculo.




        RouteName
        Descrição da rota utilizada para o cálculo.




        TypeCapacity
        Tipo de Lotação da Tabela de Frete (1=Carga Fracionada; 2=Carga Fechada; 3=Veículo Dedicado).




        CostFreight
        Valor total do Frete.




        Tax
        Valor Imposto (ICMS ou ISS).




        DeliveryTime
        Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss.




        TableCode
        Código da tabela utilizada para cálculo




        VehicleType
        Tipo de Veículo




        OperationType
        Tipo de Operação




        FreightClassification
        Classificação de Frete




        TradingCode
        Código da Negociação




        TrackCode
        Código da Faixa



        FreightComponents

        Agrupador




        Items
        Agrupador





        ComponentCodeCódigo do Componente





        ComponentValueValor do Componente





        ComponentCategoryCategoria do Componente



        FreightDocuments

        Agrupador




        Items
        Agrupador





        TypeofDocumentTipo do Documento





        DocumentEmissEmissor do Documento





        DocumentGradeSérie do Documento





        DocumentInvoiceNúmero do Documento





        DocumentSequenceSequência do Documento

        Importante

        O agrupador de FreightDocuments está disponível em ambientes que possuam o fonte GFEWSSIMULATION com a data igual ou superior a 25/01/2024.



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

        TAGSDescrição
        content

        Agrupador.

        Items
        Agrupador.


        StatusStatus.


        MessageMensagem do Status.


        ErrorMensagem de erro.