Envio de Metadados
POST https://freterapido.com/api/external/embarcador/v1/quotes/metadados?token=[seu_token]
Método que permite inserir vários metadados em um frete e enviar os metadados para a transportadora.
Basta informar na URL o token de integração conforme estrutura abaixo.
Observações:
Por regra da API, você só deve informar apenas um identificador único para a localização do frete, seja ele o identificador do frete, número do pedido ou os dados da NF-e.
- Em casos que houverem mais de um frete com o mesmo número do pedido, será inserido no frete mais recente;
- Em casos em que a inserção seja realizada pela NF-e, a API optará primeiro pela inserção através da chave de acesso. Caso não seja informada, a inserção será feita pelo número e série da NF-e. Nesses casos, assim como o número do pedido, será inserido no frete mais recente;
Envio:
Parâmetros da URL:
Nome | Descrição | Formato / Exemplo | Obrigatório |
---|---|---|---|
token | Token de integração | String | * |
* Obrigatório |
Envio:
Parâmetros do corpo da requisição:
Nome | Descrição | Formato / Exemplo | Obrigatório |
---|---|---|---|
freight_id | Identificador do frete contratado na Frete Rápido. Pode ser utilizado para rastrear o frete | String de 13 caracteres | Opcional |
order_number | Número do pedido contratado na Frete Rápido | String | Opcional |
invoice_key | Chave de acesso da nota fiscal | String Numérica | Opcional |
invoice_number | Número da nota fiscal | String Numérica | Opcional |
invoice_serie | Série da nota fiscal | String Numérica | Obrigatório se informado invoice_number |
metadata | Array de objetos contendo chave e valor com as informações adicionais da contratação | Array de objetos JSON contendo até 64 itens | * |
key | Nome do atributo de informação extra da solicitação de coleta, deve ser nome único para chave | String de até 255 caracteres | * |
value | Corresponde ao valor do atributo da chave informada | String de até 255 caracteres | * |
* Obrigatório
Exemplo de envio:
{
"freight_id": "",
"order_number": "",
"invoice_key": "",
"invoice_number": "",
"invoice_serie": "",
"metadata": [
{
"key": "",
"value": ""
}
]
}
Resposta:
- Se a requisição obtiver sucesso, deve ser retornado o código de resposta HTTP 200. Senão, pode ser retornada uma mensagem de erro para que possamos investigar.