Árvore de páginas

Versões comparadas

Chave

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

...

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/ 
Informações
titleImportante

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.

...

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 Image Added

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 RemovedImage Added

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

Image RemovedImage Added


Exemplo de arquivo JSON

...

Deck of Cards
effectDuration0
idJsonEntrada1
Card
effectDuration0
id1
labelVersão 1
Bloco de código
languagexml
themeMidnight
titleJSON Entrada v1
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"
                        },
						{
							"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,
                              "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"
                        }
                    ]
                }
            ]
        }
    ]
}
Card
defaulttrue
effectDuration0
id2
labelVersão 2 (Recomendada)
Bloco de código
languagexml
themeMidnight
titleJSON Entrada v2
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 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": 146,
                                    "id": "CostumerCodeSenderERPCode",
                                    "Description": "Destinat\ufffdrioCódigo do ERP do Remetente do Documento de Carga/Nota Fiscal",
                                    "value": "000000003000000001     ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 6014,
                                    "id": "DeliveryAddressCostumerCode",
                                    "Description": "Endereço de Entrega Destinat\ufffdrio do Documento de Carga/Nota Fiscal",
                                    "value": "000000003     ",
                                    "Type": "string"
                                },
                                    
							 	{
                                    "Length": 506,
                                    "id": "DeliveryDistrictCostumerERPCode",
                                    "Description": "Bairro de EntregaCódigo do ERP do Destinat\ufffdrio do Documento de Carga/Nota Fiscal",
                                    "value": "000000003     ",
                                    "Type": "string"
                                },
                                                 {
                                    "Length": 760,
                                    "id": "CityCodeDeliveryDeliveryAddress",
                                    "Description": "CidadeEndereço de Entrega do Documento de Carga/Nota Fiscal",
                                    "value": "",
       ",
                                     "Type": "string"
                                },
                                {
                                    "Length": 850,
                                    "id": "ZipCodeDeliveryDeliveryDistrict",
                                    "Description": "CEPBairro de Entrega do Documento de Carga/Nota Fiscal",
                                    "value": "        ",
                                    "Type": "string"
                                },
                                {
                                    "Length": 13.57,
                                    "id": "UnitizadorCityCodeDelivery",
                                    "Description": "QuantidadeCidade de Entrega do Documento de Carga/Nota UnitizadoresFiscal",
                                    "value": 1 "       ",
                                    "Type": "doublestring"
                                },
                            ],
    {
                        "id": "1"
           "Length": 8,
            }
                    ]
    "id": "ZipCodeDelivery",
           }
            ]
        }
    ]
}

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": [ {
 "Description": "CEP de Entrega do Documento de Carga/Nota Fiscal",
        
"Items":
 
[
                
{
           "value": "        "
Manifest": [
,
                
],
                    "
id
Type": "
1
string"
,

                    
"ItemsDocumentBurden":
 
[
           },
             
{
                   {
         
"Items":
 
[
                          "Length": 13.5,
     
{
                               "id": "Unitizador",
                                    "
id
Description": "
Weight
Quantidade de Unitizadores",
                                    "value": 
20
1,
                                 
}
   "Type": "double"
                              
],
  }
                            
"id": "1"
],
                        
}
    "id": "1"
               
],
         }
           
"Route":
 
[
        ]
                
{
}
            ]
        }
    ]
}


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
{
    "Itemscontent": [

        {
            "Items": [
        ],
        {
                    "idManifest": "1"[
                    ],
    }
                    ]"id": "1",
                    "DocumentBurdenItemsDocumentBurden": [
                        {
                            "Items": [
                                {
                                    "id": "SenderCodeWeight",
                                    "value": "000000001"20
                                },
                                {
      ],
                              "id": "CostumerCode1",
                        }
            "value": "000000003"
       ],
                         }"Route": [
                            ],{
                            "idItems": "1"[

                        }
    ],
                ]
                }"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"DocumentBurden": [
                        {
                            "SimulationNumberItems": "000001",
[
                               "Items": [{
                                    { "id": "SenderCode",
                                    "idvalue": "CarrierCode000000001",
                                    "Description": "Código do Transportador da rota calculada"},
                                    "value": "000000002     ",{
                                    "lengthid": 14"CostumerCode",
                                    "typevalue": "string000000003"
                                },
                            ],
    {
                                    ""id": "CarrierCnpj1",
                        }
            "Description": "CNPJ do Transportador da rota calculada",
  ]
                }
            ]
      "value": "48411553000163 }
    ]
}


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": [
                   {
            "lengthItems": 21,[
                {
                    "typeStatus": "stringok",
                    "Message": "FreightSimulations: Simula\ufffd\ufffdo realizada com sucesso.",
       },
               "FreightCalculation": [
                {
        {
                            "idSimulationNumber": "CarrierName000001",
                                    "DescriptionItems": "Nome[
 do Transportador da rota calculada",
                           {
         "value": "TRANSP JOINVILLE                         "type": "string",
                                      ""length": 14,
                                    "lengthid": 80"CarrierCode",
                                    "typevalue": "string"
49            ",
                    },
                       "Description": "C\ufffddigo do Transportador da rota calculada"
         {
                       },
                      "id": "RouteCode",
          {
                              "Description": "Código da rota utilizada para o cálculo"type": "string",
                                    "valuelength": "0002"21,
                                    "lengthid": 4"CarrierCnpj",
                                    "typevalue": "string"
84429869000308       ",
                                     },
     "Description": "CNPJ do Transportador da rota calculada"
                           {
     },
                               "id": "RouteName", {
                                    "Descriptiontype": "Descrição da rota utilizada para o cálculostring",
                                    "valuelength": "País - 105 - BRASIL , UF - MG | País - 105 - BRASIL , UF - SC"80,
                                    "lengthid": 150"CarrierName",
                                    "typevalue": "string"
ABC-TRANSP                                      },
                                {",
                                    "idDescription": "TypeCapacity",
Nome do Transportador da rota calculada"
                               "Description": "Tipo Lotação da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Veículo Dedicado)", },
							 	{
                                    "valuetype": "Carga Fracionadastring",
                                    "length": 1614,
                                    "typeid": "stringCarrierERPCode",
                                }    "value": "49            ",
                                {
    "Description": "Código do ERP do Transportador da rota calculada"
                        "id": "CostFreight",
       },
                             "Description": "Valor total do Frete",{
                                    "valuetype": 303"string",
                                    "length": 11.24,
                                    "typeid": "doubleRouteCode",
                                     }"value": "0001",
                                {
    "Description": "C\ufffddigo da rota utilizada para o c\ufffdlculo"
                         "id": "Tax",
       },
                             "Description": "Valor do imposto",{
                                    "valuetype": 30.3"string",
                                    "length": 11.2150,
                                    "typeid": "doubleRouteName",
                                },
     "value": "Remetente - 77170 - TOTVS S.A. | Destinat\ufffdrio - 12704 - NICOM COMERC MATS PARA            {CONSTRUCOES LTDA",
                                    "idDescription": "DeliveryTime",
      Descri\ufffd\ufffdo da rota utilizada para o c\ufffdlculo"
                              "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss" },
                                    "value": "0000-00-00T00:00:00",{
                                    "lengthtype": "19string",
                                    "typelength": "string"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)"
   "SimulationNumber": "000002",
                            "Items": [ },
                                {
                                    "idtype": "CarrierCodedouble",
                                    "Descriptionlength": "Código do Transportador da rota calculada"11.2,
                                    "valueid": "000200001     CostFreight",
                                    "lengthvalue": 14100,
                                    "typeDescription": "stringValor total do Frete"
                                },
                                {
                                    "idtype": "CarrierCnpjdouble",
                                    "Descriptionlength": "CNPJ do Transportador da rota calculada"11.2,
                                    "valueid": "29801143000184       Tax",
                                    "lengthvalue": 217,
                                    "typeDescription": "stringValor Imposto (ICMS ou ISS)"
                                },
                                {
                                    "idtype": "CarrierNamestring",
                                    "Descriptionlength": "Nome do Transportador da rota calculada19",
                                    "valueid": "TRANSP MG"DeliveryTime",
                                    "value": "0000-00-00T00:00:00",
                                    "Description": ",
Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss"
                               "length": 80},
                                {
    "type": "string"
                                }"type": "string",
                                   {  "length": 6,
                                    "id": "RouteCodeTableCode",
                                    "Descriptionvalue": "Código da rota utilizada para o cálculo000001",
                                    "valueDescription": "0001",
     C\ufffddigo da tabela utilizada para o c\ufffdlculo"
                               "length": 4},
                                {
    "type": "string"
                                }"type": "string",
                                   { "length": 10,
                                    "id": "RouteNameVehicleType",
                                    "Descriptionvalue": "Descrição     da rota utilizada para o cálculo",
                                    "valueDescription": "PaísTipo - 105 - BRASIL , UF - SC | País - 105 - BRASIL , UF - MG",de Ve\ufffdculo"
                                },
    "length": 150,
                           {
         "type": "string"
                          "type": "string",
     },
                                {"length": 10,
                                    "id": "TypeCapacityOperationType",
                                    "Descriptionvalue": "Tipo Lotação da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Veículo Dedicado)",
                                    "valueDescription": "Carga Fracionada",Tipo de Opera\ufffd\ufffdo"
                                },
    "length": 16,
                           {
         "type": "string"
                          "type": "string",
     },
                                {"length": 4,
                                    "id": "CostFreightFreightClassification",
                                    "Descriptionvalue": "Valor  total do Frete",
                                    "valueDescription": 100, "Classifica\ufffd\ufffdo de Frete"
                                },
      "length": 11.2,
                         {
           "type": "double"
                        "type": "string",
       },
                                {"length": 6,
                                    "id": "TaxTradingCode",
                                    "Descriptionvalue": "Valor do imposto000001",
                                    "valueDescription": 10, "C\ufffddigo da Negocia\ufffd\ufffdo"
                                },
    "length": 11.2,
                           {
         "type": "double"
                          "type": "string",
     },
                                {"length": 4,
                                    "id": "DeliveryTimeTrackCode",
                                    "Descriptionvalue": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss0001",
                                    "valueDescription": "2017-10-25T16:33:44",C\ufffddigo da Faixa"
                                }
    "length": "19",
                       ],
             "type": "string"
              "FreightComponents": [
                 }
               {
             ]
                        },
"Items": [
                           {
             {
               "SimulationNumber": "000003",
                            "Itemstype": ["string",
                                 {
           "length": 20,
                        "id": "CarrierCode",
                   "id": "ComponentCode",
                "Description": "Código do Transportador da rota calculada",
                      "value": "FRETE PESO          ",
  "value": "000400002     ",
                                    "lengthDescription": 14,
  "C\ufffddigo do componente"
                                  "type": "string"
     },
                           },
             {
                   {
                         "type": "double",
          "id": "CarrierCnpj",
                                 "length": 12.2,
  "Description": "CNPJ do Transportador da rota calculada",
                                    "valueid": "87333684814  "ComponentValue",
        ",
                                    "lengthvalue": 21100,
                                    "type": "string"
          "Description": "Valor do componente"
                   },
                     },
           {
                             {
       "id": "CarrierName",
                                    "Descriptiontype": "Nome do Transportador da rota calculada",
"string",
                                            "valuelength": 20,
 "TRANSP AUTONOMO SP                                         "id": "ComponentCategory",
                    ",
                        "value": "Frete Unidade",
          "length": 80,
                                    "typeDescription": "stringCategoria do componente"
                                        },
                                {
    ]
                                }
        "id": "RouteCode",
                   ]
                 "Description": "Código da rota utilizada para o cálculo"},
                        {
                    "value": "0001",
       "SimulationNumber": "000002",
                            "lengthItems": 4,[
                                {
    "type": "string"
                                }"type": "string",
                                  {   "length": 14,
                                    "id": "RouteNameCarrierCode",
                                    "Descriptionvalue": "Descrição77785    da rota utilizada para o cálculo",
                                    "valueDescription": "PaísC\ufffddigo -do 105Transportador -da BRASIL , UF - MG | País - 105 - BRASIL , UF - SC",rota calculada"
                                },
    "length": 150,
                           {
         "type": "string"
                          "type": "string",
     },
                                {"length": 21,
                                    "id": "TypeCapacityCarrierCnpj",
                                    "Descriptionvalue": "Tipo06331583000110 Lotação da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Veículo Dedicado)",
                                    "valueDescription": "Carga Fracionada",
    CNPJ do Transportador da rota calculada"
                                "length": 16},
                                {
    "type": "string"
                                }"type": "string",
                                    {"length": 80,
                                    "id": "CostFreightCarrierName",
                                    "Descriptionvalue": "ValorTRANSPORTADORA totalSCUBIDU do Frete",
           LTDA ME                         "value": 1100,
                                    "length": 11.2,
                                    "typeDescription": "doubleNome do Transportador da rota calculada"
                                },
                                {
                                    "idtype": "Taxstring",
                                    "Descriptionlength": "Valor do imposto"4,
                                    "valueid": 0"RouteCode",
                                    "lengthvalue": 11.2"0001",
                                    "typeDescription": "doubleC\ufffddigo da rota utilizada para o c\ufffdlculo"
                                },
                                {
                                    "idtype": "DeliveryTimestring",
                                    "Descriptionlength": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss"150,
                                    "valueid": "2017-10-25T16:33:44RouteName",
                                    "lengthvalue": "19",
Cidade - 4209102 - JOINVILLE | Cidade - 3550308 - SAO PAULO",
                         "type": "string"
          "Description": "Descri\ufffd\ufffdo da rota utilizada para o c\ufffdlculo"
               }
                   },
         ]
                        },{
                        {
            "type": "string",
               "SimulationNumber": "000004",
                     "length": 16,
      "Items": [
                                {"id": "TypeCapacity",
                                    "idvalue": "CarrierCodeCarga Fracionada",
                                    "Description": "Código do Transportador Tipo Lota\ufffd\ufffdo da rota calculada",
       Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Ve\ufffdculo Dedicado)"
                             "value": "36265337432   "},
                                    "length": 14,{
                                    "type": "stringdouble",
                                   }  "length": 11.2,
                                    { "id": "CostFreight",
                                    "idvalue": "CarrierCnpj"750,
                                    "Description": "CNPJValor total do TransportadorFrete"
 da rota calculada",
                                    "value": "36265337432          "},
                                    "length": 21,{
                                    "type": "stringdouble",
                                    }"length": 11.2,
                                     {"id": "Tax",
                                    "idvalue": "CarrierName"52.5,
                                    "Description": "NomeValor doImposto Transportador(ICMS da rota calculada",ou ISS)"
                                },
    "value": "TRANSP INT CNPJ                         {
                                        "type": "string",
                                    "length": 80"19",
                                    "typeid": "stringDeliveryTime",
                                },
    "value": "0000-00-00T00:00:00",
                           {
         "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss"
                     "id": "RouteCode",
           },
                         "Description": "Código da rota utilizada para o cálculo",{
                                    "valuetype": "0002string",
                                    "length": 46,
                                    "typeid": "stringTableCode",
                                },
     "value": "000001",
                          {
          "Description": "C\ufffddigo da tabela utilizada para o c\ufffdlculo"
                   "id": "RouteName",
            },
                        "Description": "Descrição da rota utilizada para o cálculo",        {
                                    "valuetype": "País - 105 - BRASIL , UF - SC | País - 105 - BRASIL , UF - MGstring",
                                    "length": 15010,
                                    "typeid": "stringVehicleType",
                                },
    "value": "          ",
                 {
                   "Description": "Tipo de Ve\ufffdculo"
              "id": "TypeCapacity",
                  },
                    "Description": "Tipo Lotação da Tabela de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Veículo Dedicado)", {
                                    "valuetype": "Carga Fracionadastring",
                                    "length": 1610,
                                    "typeid": "stringOperationType",
                                },
    "value": "          ",
                 {
                   "Description": "Tipo de Opera\ufffd\ufffdo"
              "id": "CostFreight",
                 },
                   "Description": "Valor total do Frete",
         {
                           "value         "type": 210"string",
                                    "length": 11.24,
                                    "typeid": "doubleFreightClassification",
                                 },
    "value": "    ",
                           {
         "Description": "Classifica\ufffd\ufffdo de Frete"
                        "id": "Tax",
       },
                             "Description": "Valor do imposto",{
                                    "valuetype": 0"string",
                                    "length": 11.26,
                                    "typeid": "doubleTradingCode",
                                },
    "value": "000001",
                           {
         "Description": "C\ufffddigo da Negocia\ufffd\ufffdo"
                        "id": "DeliveryTime",
          },
                          "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss", {
                                    "valuetype": "2017-10-25T16:33:44string",
                                    "length": "19"4,
                                    "typeid": "stringTrackCode",
                                }
    "value": "0001",
                       ]
             "Description": "C\ufffddigo da Faixa"
        },
                        {}
                            "SimulationNumber": "000005"],
                            "ItemsFreightComponents": [
                                {
                                    "idItems": "CarrierCode",
[
                                       "Description": "Código do Transportador da rota calculada",
 {
                                            "valuetype": "7752string",
          ",
                                    "length": 1420,
                                            "typeid": "stringComponentCode",
                                },
            "value": "GRIS                ",
        {
                                    "idDescription": "CarrierCnpj",
C\ufffddigo do componente"
                                      "Description": "CNPJ do},
 Transportador da rota calculada",
                                    "value": "07528127000127{
        ",
                                    "lengthtype": 21"double",
                                    "type": "string"
       "length": 12.2,
                        },
                       "id": "ComponentValue",
         {
                                    "idvalue": "CarrierName"0,
                                            "Description": "NomeValor do componente"
 Transportador  da rota calculada",
                                    "value": "BENEDETTI & BENEDETTI TRANSPS E LOGISTI},
                                        {
        ",
                                    "lengthtype": 80"string",
                                    "type": "string"
       "length": 20,
                        },
                    "id": "ComponentCategory",
           {
                                    "idvalue": "RouteCodeFrete Valor",
                                    "Description": "Código da rota utilizada para o cálculo",
                                    "value"Description": "0002Categoria do componente",
                                       "length": 4, }
                                    "type": "string"]
                                },
                                {
                                    "idItems": "RouteName",
[
                                        "Description": "Descrição da rota utilizada para o cálculo",
{
                                            "valuetype": "Cidade - 4242091 - JOINVILLE | Cidade - 3131062 - BELO HORIZONTE",
"string",
                                            "length": 15020,
                                            "typeid": "stringComponentCode",
                                },
            "value": "FRETE FIXO          ",
        {
                                    "idDescription": "TypeCapacity",C\ufffddigo do componente"
                                    "Description": "Tipo Lotação da Tabela},
 de Frete. (1=Carga Fracionada 2=Carga Fechada 3=Veículo Dedicado)",
                                {
    "value": "Carga Fracionada",
                                        "lengthtype": 16"double",
                                    "type": "string"
       "length": 12.2,
                        },
                        "id": "ComponentValue",
        {
                                    "idvalue": "CostFreight"750,
                                            "Description": "Valor total do Fretecomponente",
                                       "value": 1200},
                                    "length": 11.2,
   {
                                 "type": "double"
          "type": "string",
                     },
                       "length": 20,
        {
                                    "id": "TaxComponentCategory",
                                            "Descriptionvalue": "ValorFrete do impostoUnidade",
                                    "value": 120,
        "Description": "Categoria do componente"
                           "length": 11.2,
            }
                        "type": "double"
           ]
                     },
           }
                     {
       ]
                        }
     "id": "DeliveryTime",
              ]
                }
      "Description": "Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss", ]
        }
    ]
}


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": [
        {
            "valueItems": "0000-00-00T00:00:00",[
                {
                    "lengthStatus": "19error",
                    "Message": "\\LOG_GFE\\CalculoFrete_T1D MG 01     _20171012_090541_286.LOG",
        "type": "string"
           "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": [
         {
       {
                     "SimulationNumberStatus": "000006error",
                    "Message": "Campo CarrierCode. Código do Transportador (0000000029  "Items": [
 ) 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".
        "id": "CarrierCode",
       }
            ]
        }
    ]
}


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
{
     "Descriptioncontent": "Código do Transportador da rota calculada",[
        {
            "Items": [
               "value": "843770001 {
     ",
               "Status": "error",
                    "lengthMessage": 14,
     "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. ",
        "type": "string"
           "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": [
        {
            "idItems": "CarrierCnpj",[
                {
                    "DescriptionStatus": "CNPJ do Transportador da rota calculadaerror",
                                    "value"Message": "56062926000166Campo 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. ",
                    "lengthError": 21,
"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                "type": "string"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": [
        {
                                    "id"Items": "CarrierName",[
                {
                    "DescriptionStatus": "Nome do Transportador da rota calculadaerror",
                                    "valueMessage": "TRANSPCampo 1OperationType. DOCTipo CARGAde POROperação ROMANEIO(1111 JLLE     ) 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                "length": 80,para gerar".
                }
            ]
        "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

...

]
}


Arquivo JSON de Build Desatualizada.

Bloco de código
languagexml
themeMidnight
titleJSON Saída Build Desatualizada
collapsetrue
{
    "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
Deck of Cards
effectDuration0
idItemsDocumentBurden1
Card
effectDuration0
id1
labelVersão 1
ItemsDocumentBurden - Itens dos Documentos de Carga - Para cada DocumentBurden haverá uma ou mais ocorrências de ItemsDocumentBurden.
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 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érico15
FreightClassificationClassificação de Frete do Item Documento de Carga/Nota Fiscal.
Alfanumérico4
ItemTypeTipo do Item do Documento de Carga/Nota Fiscal.
Alfanumérico4
QuantityQuantidade do Item.
Numérico13,5
WeightPeso do Item.
Numérico13,5
NetWeightPeso Cubado.
Numérico13,5
AlternativeQuantityQuantidade/Peso Alternativa.
Numérico13,5
NetPriceValor do Item.
Numérico11,2
CubicVolumeVolume Ocupado (m3).
Numérico11,5
Card
effectDuration0
id2
labelVersão 2
ItemsDocumentBurden - Itens dos Documentos de Carga - Para cada DocumentBurden haverá uma ou mais ocorrências de ItemsDocumentBurden.
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 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érico15
FreightClassificationClassificação de Frete do Item Documento de Carga/Nota Fiscal.
Alfanumérico4
ItemTypeTipo do Item do Documento de Carga/Nota Fiscal.
Alfanumérico4
QuantityQuantidade do Item.
Numérico13,5
WeightPeso do Item.
Numérico13,5
NetWeightPeso Cubado.
Numérico13,5
AlternativeQuantityQuantidade/Peso Alternativa.
Numérico13,5
NetPrice

Valor do Liquido do Item.


Numérico11,2
CubicVolumeVolume Ocupado (m3).
Numérico11,5
GrossPrice

Valor do Bruto do Item


Numérico11,2Versã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.

Deck of Cards
effectDuration0
idDetTecAll
Card
effectDuration0
id1
labelVersão 1
TAGSDescriçã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.



FreightClassificationClassificação de Frete.



OperationType
Tipo de Operação.



BaseDate
Data base para cálculo



DocumentBurden
Agrupador dos Documentos de Carga.




Items
Agrupador.





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.

...






SenderERPCodeCódigo do ERP do Remetente do Documento de Carga/Nota Fiscal

...

.





CostumerCodeDestinatário do Documento de Carga/Nota Fiscal.

...






CostumerERPCodeCódigo do ERP do Destinatá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.

...




Route

Agrupador das Rotas do Documento de Carga.




Items
Agrupador.





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

...

.

...





Items

...


Agrupador.





IssuerCodeEmitente

...

do Documento de Carga/Nota Fiscal

...

.

...






InvoiceSerie

...

Sé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.

...

...

Detalhamento dos Agrupadores e Tags de Saída

...






NetWeightPeso Cubado.





AlternativeQuantityQuantidade/Peso Alternativa.





NetPriceValor do Item.





CubicVolumeVolume Ocupado (m3).
Card
effectDuration0
id2
labelVersão 2

Detalhamento técnico da estrutura do arquivo

...

TAGSDescriçã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.



FreightClassificationClassificação de Frete.



OperationType
Tipo de Operação.



DocumentBurden
Agrupador dos Documentos de Carga.




Items
Agrupador.





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.



Route

Agrupador das Rotas do Documento de Carga.




Items
Agrupador.





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.




Items
Agrupador.





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 Líquido do Item.





CubicVolumeVolume 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
Informações
titleImportante

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.

...