Método Publicado

Pré-requisitos para Utilização

Exemplo de arquivo JSON

Detalhamento dos Agrupadores e Tags de Entrada

Detalhamento dos Agrupadores e Tags de Entrada

Detalhamento dos Agrupadores e Tags de Saída

Detalhamento técnico da estrutura do arquivo

Detalhamento dos Agrupadores e Tags de Saída

Detalhamento técnico da estrutura do arquivo

Método Publicado

Pré-requisitos para Utilização

Exemplo de arquivo JSON

Detalhamento dos Agrupadores e Tags de Entrada

Detalhamento dos Agrupadores e Tags de Entrada

Detalhamento dos Agrupadores e Tags de Saída

Detalhamento técnico da estrutura do arquivo

Detalhamento dos Agrupadores e Tags de Saída

Detalhamento técnico da estrutura do arquivo

Histórico da Página

Método Publicado

Pré-requisitos para Utilização

Exemplo de arquivo JSON

Detalhamento dos Agrupadores e Tags de Entrada

Detalhamento dos Agrupadores e Tags de Entrada

Detalhamento dos Agrupadores e Tags de Saída

Detalhamento técnico da estrutura do arquivo

Detalhamento dos Agrupadores e Tags de Saída

Detalhamento técnico da estrutura do arquivo

Árvore de páginas

Versões comparadas

Chave

Árvore de páginas

Versões comparadas

Chave

Versão antiga 9

Nova versão Atual

Versão antiga 9

Nova versão Atual

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

Informações

title	Importante

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

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.
- No link http://tdn.totvs.com.br/pages/viewpage.action?pageId=185748193 é possível encontrar todas as configurações necessárias.
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

...

Deck of Cards

effectDuration	0
id	JsonEntrada1

Card

effectDuration	0
id	1
label	Versão 1

Bloco de código

language	xml
theme	Midnight
title	JSON Entrada v1
collapse	true

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

default	true
effectDuration	0
id	2
label	Versão 2 (Recomendada)

Bloco de código

language	xml
theme	Midnight
title	JSON Entrada v2
collapse	true

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

language	xml
theme	Midnight
title	JSON Entrada - Mínimo para simulação
collapse	true

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

language	xml
theme	Midnight
title	JSON Entrada - Mínimo para simulação
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Simplificada
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Simplificada
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Simulação não realizada
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Validação Código Transportador
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Validação Tipo de Veículo
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Validação Classificação Frete
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Validação Tipo de Operação
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Simulação não realizada
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Validação Código Transportador
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Validação Tipo de Veículo
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Validação Classificação Frete
collapse	true

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

language	xml
theme	Midnight
title	JSON Saída Validação Tipo de Operação
collapse	true

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

Bloco de código

language	xml
theme	Midnight
title	JSON Saída Build Desatualizada
collapse	true

{
    "errorCode": 500,
    "errorMessage": "invalid class JSSONOBJECT"
}

Manifest - Informações do romaneio. Ocorrências 1 ou mais.
Field	Descrição	Chave	Tipo	Tamanho	Observação
ManifestNumber	Código agrupador/Romaneio.	*	Alfanumerico	8	Obrigatório.
CarrierCode	Transportador a ser considerado no cálculo, quando não informado no trecho/rota.		Alfanumérico	14
TypeOfVehicle	Tipo de Veículo.		Alfanumérico	10
FreightClassification	Classificação de Frete.		Alfanumérico	4
OperationType	Tipo de Operação.		Alfanumérico	10
BaseDate	Data Base para cálculo.		Alfanumérico	20

DocumentBurden - Documentos de Carga do Romaneio - Para cada Manifest haverá uma ou mais ocorrências de DocumentBurden.
Field	Descrição	Chave	Tipo	Tamanho	Observação
ManifestNumber	Código agrupador/Romaneio.	*	Alfanumérico	8	Obrigatório. Campo de ligação com o agrupador Manifest/ManifestNumber.
IssuerCode	Emitente do Documento de Carga/Nota Fiscal.	*	Alfanumérico	14
InvoiceSerie	Série do Documento de Carga/Nota Fiscal.	*	Alfanumérico	3
InvoiceNumber	Número do Documento de Carga/Nota Fiscal.	*	Alfanumérico	16
TypeOfDocument	Tipo do Documento de Carga/Nota Fiscal.	*	Alfanumérico	5	Caso não seja informado, será considerado o primeiro registro ativo na tabela GV5.
SenderCode	Remetente do Documento de Carga/Nota Fiscal.		Alfanumérico	14	A 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)
SenderERPCode	Código do ERP do Remetente do Documento de Carga/Nota Fiscal.		Alfanumérico	6	Esta 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.
CostumerCode	Destinatário do Documento de Carga/Nota Fiscal.		Alfanumérico	14	Obrigatório. O registro informado deve estar cadastro na rotina de emitentes. (Tabela GU3)
CostumerERPCode	Código do ERP do Destinatário do Documento de Carga/Nota Fiscal.		Alfanumérico	6	Esta 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.
DeliveryAddress	Endereço de Entrega do Documento de Carga/Nota Fiscal.		Alfanumérico	60
DeliveryDistrict	Bairro de Entrega do Documento de Carga/Nota Fiscal.		Alfanumérico	50
CityCodeDelivery	Cidade de Entrega do Documento de Carga/Nota Fiscal.		Alfanumérico	7
ZipCodeDelivery	CEP de Entrega do Documento de Carga/Nota Fiscal.		Alfanumérico	8
Unitizador	Quantidade de Unitizadores.		Numérico	13,5	Padrão "1".

Route - Trechos dos Documentos de Carga - Para cada DocumentBurden haverá uma ou mais ocorrências de Route.
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 de Documento de Carga/Nota Fiscal.	*	Alfanumérico	5	Campo de ligação com o agrupador DocumentBurden/TypeOfDocument.
Sequence	Sequência do Trecho. Serial único.		Alfanumérico	2	Sequencial único. O valor inicial do campo deverá ser "01".
CarrierCode	Transportador 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érico	14
CityCodeDelivery	Cidade de Destino.		Alfanumérico	7	(*) Caso não seja informada, será considerada a cidade do endereço de entrega, quando preenchida, ou do destinatário do Documento de Carga.
TypeOfVehicle	Tipo de veículo do trecho.		Alfanumérico	10
CityCodeOrigin	Número Cidade Origem.		Alfanumérico	7	(*) Caso não seja informada, será considerada a cidade do endereço do Remetente ou a cidade de destino do trecho anterior, quando houver.
ZipCodeOrigin	CEP de Origem.		Alfanumérico	8
ZipCodeDelivery	CEP de Destino.		Alfanumérico	8
FreightClassification	Classificação de Frete.		Alfanumérico	4
OperationType	Tipo de Operação.		Alfanumérico	10

Deck of Cards

effectDuration	0
id	ItemsDocumentBurden1

Card

effectDuration	0
id	1
label	Versão 1

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

Card

effectDuration	0
id	2
label	Versão 2

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

FreightCalculation - Simulações realizadas.
Field	Descrição	Tipo	Tamanho
CarrierCode	Codigo do Transportador da rota calculada.	Alfanumérico	14
CarrierCnpj	CNPJ do Transportador da rota calculada.	Alfanumérico	14
CarrierName	Nome do Transportador da rota calculada.	Alfanumérico	80
CarrierERPCode	Código do ERP do Transportador da rota calculada.	Alfanumérico	6
RouteCode	Código da rota utilizada para o cálculo.	Alfanumérico	4
RouteName	Descrição da rota utilizada para o cálculo.	Alfanumérico	150
TypeCapacity	Tipo de Lotação da Tabela de Frete (1=Carga Fracionada; 2=Carga Fechada; 3=Veículo Dedicado).	Alfanumérico	1
CostFreight	Valor total do Frete.	Numérico	12,2
Tax	Valor Imposto (ICMS ou ISS).	Numérico	12,2
DeliveryTime	Prazo de Entrega no formato YYYY-MM-DDThh:mm:ss.	Alfanumérico	19
TableCode	Código da tabela utilizada para o cálculo	Alfanumérico	6
VehicleType	Tipo de Veículo	Alfanúmerico	10
OperationType	Tipo de Operação	Alfanúmerico	10
FreightClassification	Classificação de Frete	Alfanúmerico	4
TradingCode	Código da Negociação	Alfanúmerico	6
TrackCode	Código da Faixa	Alfanúmerico	4
FreightComponents - Componentes do Cálculo de Frete
Field	Descrição	Tipo	Tamanho
ComponentCode	Código do Componente	Alfanúmerico	20
ComponentValue	Valor do Componente	Númerico	12,2
ComponentCategory	Categoria do Componente	Alfanúmerico	20

Estrutura do arquivo de entrada.

Deck of Cards

effectDuration	0
id	DetTecAll

Card

effectDuration	0
id	1
label	Versão 1

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.

...

...

Card

effectDuration	0
id	2
label	Versão 2

...

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.

TAGS						Descriçã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
					ComponentCode	Código do Componente
					ComponentValue	Valor do Componente
					ComponentCategory	Categoria do Componente
			FreightDocuments			Agrupador
				Items		Agrupador
					TypeofDocument	Tipo do Documento
					DocumentEmiss	Emissor do Documento
					DocumentGrade	Série do Documento
					DocumentInvoice	Número do Documento
					DocumentSequence	Sequência do Documento

Informações

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

...

Peso Cubado.

AlternativeQuantity

Quantidade/Peso Alternativa.

Valor do Item.

CubicVolume

Volume Ocupado (m3).