Envio de código de rastreio
Envia o código de rastreio cadastrado em um pedido para o e-commerce.
Configurações
Acesse Menu → Configurações → Aba E-commerce → Integrações e selecione sua integração de testes.
Acesse a aba Notificações e informe a URL em que deseja receber as notificações no campo URL para envio do rastreio.
Após a homologação da plataforma, as opções disponíveis para o usuário configurar serão as mesmas da integração de testes. Os dados serão enviados ao webhook conforme as configurações selecionadas pelo usuário.
Payload enviado
| Elemento | Tipo | Tamanho | Ocorrência | Descrição | Exemplo |
|---|---|---|---|---|---|
| cnpj | string | - | obrigatório | CNPJ/CPF da conta Tiny que está enviando o payload | 48404755000188 |
| idEcommerce | int | - | obrigatório | Identificador do e-commerce em que o webhook foi configurado | - |
| tipo | string | - | obrigatório | Identificador do tipo do webhook | rastreio |
| versao | string | - | obrigatório | Versão do Webhook | 1.0.0 |
| dados | object | - | obrigatório | Elemento utilizado para representar os dados enviados pelo webhook | - |
| dados.idEntregaEcommerce | int | - | opcional | Identificador da entrega no e-commerce | - |
| dados.idVendaTiny | int | - | obrigatório | Identificador da venda no Tiny | - |
| dados.idNotaFiscalTiny | int | - | obrigatório | Identificador da nota fiscal no Tiny | - |
| dados.idPedidoEcommerce | string | - | obrigatório | Identificador do pedido no e-commerce | - |
| dados.codigoRastreio | string | - | obrigatório | Código de rastreio do pedido | - |
| dados.urlRastreio | string | - | opcional | URL de rastreio do pedido | https://exemplo.com/rastreio?r=111222333 |
| dados.transportadora | string | - | opcional | Nome da transportadora | Transportadora LTDA |
| dados.formaEnvio | string | - | obrigatório | Descrição da forma de envio | Correios |
| dados.formaFrete | string | - | opcional | Descrição da forma de frete | SEDEX |
Confirmação de recebimento
O envio é síncrono, ou seja, o Tiny espera o retorno do integrador no momento do envio.
Para confirmar o recebimento da notificação na URL configurada, o webhook deverá retornar o status HTTP 200 e o payload exibido abaixo.
| Elemento | Tipo | Tamanho | Ocorrência | Descrição | Exemplo |
|---|---|---|---|---|---|
| idEntregaEcommerce | int | - | opcional | Identificador da entrega no e-commerce | - |
| error | string | - | opcional | Erro retornado pelo integrador a ser exibido para o usuário | - |
Caso o sistema integrado não retorne o status de recebimento, o payload será enviado novamente. São realizadas no máximo 2 tentativas de envio. Qualquer código de retorno fora da faixa HTTP 200 é considerado como erro e o envio do rastreio é rejeitado pelo Tiny.
