POST api/v1/cotacao — API AllPost

Descrição

Realiza uma nova cotação de frete.
Obs.: A chave de autenticação para cotações não é a mesma para os demais endpoints.
Utilize Token Cotação: utilizada para realizar cotações de frete, é um token único por loja, utilize o campo canal para diferenciar as integrações. Não existe limite de requisições.

Parâmetros de Entrada

Campo	Descrição	Tipo	Tamanho	Obrigatório
filiaisOrigem	Se vazio, considera todas as filiais ativas para cotação; para limitar, informe os códigos ERP separados por vírgula.	string	60	não
cepDestino	código postal do destinatário	string	8	sim
canal	canal de vendas	string	30	sim
volumes	lista de produtos	array		sim
sku	código do produto	string	50	não
quantidade	quantidade de itens a ser cotado	integer		sim
valorUnitario	valor unitário do produto	numeric	(9,2)	sim
peso	peso unitário do produto em quilo (kg)	numeric	(9,3)	não
altura	altura unitária do produto em centímetros (cm)	numeric	(9,3)	não
largura	Largura unitária do produto em centímetros (cm)	numeric	(9,3)	não
profundidade	Profundidade unitária do produto em centímetros (cm)	numeric	(9,3)	não

Se o sku não for informado ou o produto não estiver cadastrado no sistema os dados de peso e dimensões serão considerados do JSON de entrada.
Se o sku for informado e o produto estiver cadastrado no sistema os dados de peso e dimensões serão considerados do cadastro do produto e não do JSON de entrada.

Parâmetros de Retorno

Campo	Descrição	Tipo	Tamanho
retorno	dados de retorno	array
idCotacao	código da cotação de frete	string	11
mensagem	mensagem de sucesso ou erro	string	255
dataCotacao	data e hora da cotação de frete	date
destino	dados do destino	array
cep	código postal do destinatário	integer	8
uf	estado brasileiro abreviado	string	8
ufExtenso	estado brasileiro por extenso	string	8
regiaoUf	nome da região do estado: Interior, Capital ou Metropolitano	string	14
regiaoPais	nome da regição do pais: Sul, Sudeste, etc...	string	100
dadosEntrada	dados de entrada para cotar o frete	array
cepDestino	código postal do destinatário	string	8
canal	canal de vendas	string	30
nomeLoja	nome da Loja	string	40
carrinho	dados do produto para cotar o frete
valorNF	valor total dos itens	numeric	(9,2)
totalPeso	peso total dos itens	numeric	(9,3)
totalCubagem	cubagem total dos itens	numeric	(9,4)
altura	altura total dos itens	numeric	(9,3)
largura	largura total dos itens	numeric	(9,3)
profundidade	profundidade total dos itens	numeric	(9,3)
maiorPrazo	maior prazo cross entre os itens	integer
produto	lista de produto	array
sku	código do produto	string	50
agrupador	código agrupador do produto	string	35
categoria	categoria do produto	string	100
qt	quantidade de produtos cotado	integer
preco	valor unitário de entrada. Json Entrada – Campo: volumes->valorUnitario	numeric	(9,2)
precoCadastro	preço de venda padrão	numeric	(9,2)
precoCanalDe	preço de exibição referente ao canal de vendas	numeric	(9,2)
precoCanalPor	preço de venda referente ao canal de vendas	numeric	(9,2)
idSku	código sku interno do allpost	integer
estoqueProduto	total de estoque no momento da cotação	integer
estoque	se produto cadastrado o estoque será o mesmo do campo estoqueProduto, caso não cadastrado o valor será dos dados de entrada volumes->qt	integer
opcoesEntrega	lista de opções de entrega	array
possuiEstoque	0 para sim e 1 para não (no momento da cotação)	integer
freteCobrar	valor do frete a cobrar do cliente	numeric	(9,2)
freteReal	valor do frete que a transportadora irá cobrar	numeric	(9,2)
prazoEntregaTotal	prazo de entrega do produto	integer
estoque	estoque total dos produtos na filial no momento da cotação	integer
prazoEntrega	informações detalhadas sobre os prazos de entrega
prazoTransportadora	prazo de entrega da transportadora, ou seja, prazo de entrega depois da coleta do produto	integer
maiorPrazoCros	maior prazo cross entre os itens. Exemplo: prazo de compra do produto	integer
prazoAdicionalFilial	prazo de faturamento e preparação do produto na filial	integer
prazoAdicionalMetodo	prazo adicional por método de envio, exemplo: prazo que a transportadora demora para coletar	integer
prazoEntregaRegra	prazo de entrega na regra de frete	integer
prazoTotal	prazo de entrega do produto	integer
dadosFrete	informações detalhadas sobre a cotação de frete
filial	código interno da filial	integer
filialERP	código da filial	string	30
filialNome	nome dado a filial	string	30
filialCidade	Cidade da filial	string	45
filialUF	UF da filial	string	2
idMetodoEnvio	código do método de envio	integer
idTransportadora	código da transportadora	integer
transportadoraNome	nome da transportadora	string	40
metodoEnvioNome	nome do método de envio	string	40
ordenacao	Ordenação da lista de cotação. v para valor e p para prazo	string	1
perAdiDesconto	Percentual de desconto ou acréscimo no frete, que foi configurado na filial	numeric	(9,3)
tabelas	códigos de tabelas e generalidades utilizadas
idTabela	código da tabela de frete	integer
generalidade	informações sobre generalidade utilizadas
idTDA	código da taxa de difícil acesso	integer
TDA	valor da taxa de difícil acesso	numeric	(9,2)
idTRT	código da taxa de restrição de entrega	integer
TRT	valor da taxa de restrição de entrega	numeric	(9,2)
idListaRegras	lista de códigos de regras de frete que foram aplicadas na cotação	array

Body

{
	"filiaisOrigem": "",
	"cepDestino": "01010010",
	"canal": "Teste",
	"volumes": [{
		"sku": "123",
		"quantidade": 1,
		"valorUnitario": 100.90,
		"peso": 3,
		"altura": 10,
		"largura": 11,
		"profundidade": 12
	}]
}

Response

{
	"retorno": {
		"idCotacao": "11081910314",
		"mensagem": "sucesso",
		"dataCotacao": "2021-11-11T08:19:10-03:00",
		"destino": {
		  "cep": 4139000,
		  "uf": "SP",
		  "ufExtenso": "S\u00e3o Paulo",
		  "regiaoUf": "Capital",
		  "regiaoPais": "Sudeste"
		}
	},
	"dadosEntrada": {
		"cepDestino": "01010010",
		"canal": "Meu Canal de Vendas",
		"nomeLoja": "Minha Loja",
		"carrinho": {
			"valorNF": 497,
			"totalPeso": 0.11,
			"totalCubagem": 0.00299439,
			"altura": 21,
			"largura": 14.7,
			"profundidade": 9.7,
			"maiorPrazo": 2,
			"produto": [{
				"sku": "111111",
				"agrupador": "1300",
				"categoria": "DVD",
				"qt": 1,
				"preco": 497,
				"precoCadastro": 497,
				"precoCanalDe": 0,
				"precoCanalPor": 0,
				"idSku": 0,
				"estoqueProduto": 15,
				"estoque": 15
			}]
		}
	},
	"opcoesEntrega": [{
		"possuiEstoque": 0,
		"freteCobrar": 39.84,
		"freteReal": 40.66,
		"prazoEntregaTotal": 11,
		"estoque": 10,
		"prazoEntrega": {
			"prazoTransportadora": 3,
			"maiorPrazoCros": 2,
			"prazoAdicionalFilial": 2,
			"prazoAdicionalMetodo": 4,
			"prazoEntregaPorRegra": 0,
			"prazoTotal": 11
		},
		"dadosFrete": {
			"filial": 20,
			"filialERP": "33",
			"filialNome": "Filial 33",
			"filialCidade": "São Paulo",
			"filialUF": "SP",
			"idMetodoEnvio": 1,
			"idTransportadora": 1,
			"transportadoraNome": "Correios",
			"metodoEnvioNome": "Pac",
			"ordenacao": "v",
			"perAdiDesconto": -2,
			"tabelas": {
				"idTabela": 436868,
				"generalidade": {
					"idTDA": 0,
					"TDA": 0,
					"idTRT": 0,
					"TRT": 0
				},
				"idListaRegras": [
					42
				]
			}
		}
	}]
}