Ir para o conteúdo

Webhook Metadados

POST http://transportadora.com/exemplo/webhook_metadados

Através desse Webhook a Transportadora receberá os metadados do frete criado pelo embarcador.

Basta disponibilizar uma URL única para receber as requisições com os dados abaixo.

O Webhook receberá a atualização dos metadados a cada conjunto de metadados inserido em um frete.

This is a alt text.

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
invoices Array de objetos podendo ter número e série ou chave de acesso da nota fiscal Array em Json Opcional
 number Número da nota fiscal String Se "serie" não informado
 serie Série da nota fiscal String Se "number" não informado
 key Chave de acesso da nota fiscal String Se não houver "number" e "serie"
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": "",
      "invoices": [
            {
                "number": "",
                "serie": "",
                "key": ""
            }
        ],
      "metadata": [
            {
                "key": "",
                "value": ""
            }
        ]
    }

Resposta:

  • Se a requisição obtiver sucesso, deve ser retornado o código de resposta HTTP 200. Senão, pode ser retornado uma mensagem de erro para que possamos investigar.
Voltar ao topo