Exportação de carga (v.1)

A consulta disponibiliza os dados das cargas da expedição. Dessa forma, é possível selecionar e filtrar os campos desejados, aplicando as regras e validações necessárias para que os dados sejam inseridos com sucesso na base do sistema terceiro.

Filtros

O filtro empresa é obrigatório para se obter os resultados. No entanto, recomenda-se a utilização de mais alguns dos filtros listados abaixo, para otimizar a consulta.

Existe ainda a possibilidade de não retornar os dados de volumes vinculados a carga. Para isso, está disponível o filtro lista_volumes, que pode ser utilizado com os valores "S" (Sim) ou "N" (Não). Por padrão, o valor considerado é "S", ou seja, os volumes serão incluídos na resposta, a menos que indicado o contrário.

Existe também, a possibilidade de não retornar os dados das notas vinculados a carga. Para isso, está disponível o filtro lista_notas, que pode ser utilizado com os valores "S" (Sim) ou "N" (Não). Por padrão, o valor considerado é "S", ou seja, as informações das notas, serão incluídos na resposta, a menos que indicado o contrário.

Existe também, a possibilidade de não retornar os dados dos itens avulsos incluídos na carga. Para isso, está disponível o filtro lista_itens_avulsos, que pode ser utilizado com os valores "S" (Sim) ou "N" (Não). Por padrão, o valor considerado é "S", ou seja, as informações dos itens avulsos, serão incluídos na resposta, a menos que indicado o contrário.

Alguns campos podem ser utilizados como filtros para tornar a sua consulta mais específica. A seguir, estão listadas as opções disponíveis para filtragem:

empresa

nota

serie

emissao_nota_inicio

emissao_nota_fim

cliente

pedido_terceiro

origem_pedido ([I]nterno, [E]xterno)

numero_carga

data_carga_inicio

data_carga_fim

lista_volumes ([S]im, [N]ão)

lista_notas ([S]im, [N]ão)

lista_itens_avulsos ([S]im, [N]ão)

Retorno

Caso houver erro, será retornar uma TAG única "erro", informando os detalhes do erro.

Fonte dos dados

PFAT012 - Montagem de carga

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Exemplo

{
  "tipoComando": "ASDCOMANDOJSONTMP",
  "grupoComando": "EXP_CARGA_V1",
  "empresa": "<integer>"
}

Respostas

🟢200Sucesso

application/json

Bodyapplication/json

Exemplo

[
	{
		"empresa": "<integer>",
		"empresa_origem": "<integer>",
		"carga": "<integer>",
		"carga_origem": "<integer>",
		"cliente": "<integer>",
		"nome_cliente": "<string>",
		"data_faturamento": "<string>",
		"data_saida": "<string>",
		"faturado": "<string>",
		"numero_os": "<integer>",
		"observacao": "<string>",
		"placa": "<string>",
		"redespacho": "<string>",
		"regiao": "<integer>",
		"nome_regiao": "<string>",
		"rota": "<integer>",
		"nome_rota": "<string>",
		"seguro": "<string>",
		"serie": "<string>",
		"tipo_frete": "<string>",
		"tipo_frete_redespacho": "<string>",
		"transportador": "<integer>",
		"nome_transportador": "<string>",
		"uf_placa": "<string>",
		"usuario_faturamento": "<integer>",
		"nome_usu_faturamento": "<string>",
		"veiculo": "<integer>",
		"viagem": "<integer>",
		"total_tributos": "<integer>",
		"total_frete": "<integer>",
		"valor_mercadorias": "<integer>",
		"valor_carga": "<integer>",
		"total_quantidade": "<integer>",
		"total_peso_liquido": "<integer>",
		"total_peso_bruto": "<integer>",
		"total_cubagem": "<integer>",
		"volumes": "<integer>",
		"quantidade_pedidos": "<integer>",
		"quantidade_itens": "<integer>",
		"quantidade_entregas": "<integer>",
		"pedidos": [
			{
				"pedido": "<integer>",
				"ordem": "<integer>",
				"especie": "<string>",
				"peso_adicional": "<integer>",
				"itens": [
					{
						"item_pedido": "<integer>",
						"item": "<string>",
						"desc_item": "<string>",
						"versao": "<string>",
						"desc_versao": "<string>",
						"unidade": "<string>",
						"quantidade_disponivel": "<integer>",
						"quantidade_reservada": "<integer>",
						"entregas": [
							{
								"entrega": "<integer>",
								"finaliza_entrega": "<string>",
								"cliente_entrega": "<integer>",
								"nome_cliente_entrega": "<string>",
								"peso_bruto": "<integer>",
								"peso_liquido": "<integer>",
								"quantidade": "<integer>",
								"situacao": "<string>",
								"volumes": "<integer>",
								"previsao_entrega": "<string>",
								"previsao_entrega_cliente": "<string>",
								"volumes_lidos": [
									{
										"origem": "<string>",
										"sequencial_lido": "<string>",
										"codigo_barras": "<string>",
										"op": "<integer>",
										"quantidade": "<integer>",
										"peso_bruto": "<integer>",
										"peso_tara": "<integer>",
										"peso_liquido": "<integer>",
										"volumes": "<integer>"
									}
								]
							}
						]
					}
				]
			}
		],
		"itens_avulsos": [
			{
				"sequencia": "<integer>",
				"item": "<string>",
				"desc_item": "<string>",
				"versao": "<string>",
				"desc_versao": "<string>",
				"quantidade": "<integer>",
				"peso_bruto": "<integer>",
				"peso_liquido": "<integer>",
				"unitario": "<integer>",
				"deposito": "<integer>",
				"volume": "<integer>",
				"entrega": "<integer>",
				"nota": "<integer>",
				"nota_gerada": "<integer>",
				"serie": "<string>",
				"serie_gerada": "<string>",
				"item_nota": "<integer>",
				"item_nota_gerada": "<integer>",
				"cfop": "<integer>",
				"var_cfop": "<integer>",
				"pedido": "<integer>",
				"item_pedido": "<integer>",
				"tipo_venda": "<integer>"
			}
		],
		"notas": [
			{
				"nota": "<integer>",
				"serie": "<string>",
				"emissao": "<string>"
			}
		]
	}
]

Filtros#

Fonte dos dados#

Requisição

Respostas

Filtros

Fonte dos dados