Tipos de webhooks de Visibilidade integrada avançada
O webhook de Visibilidade integrada avançada permite que a FedEx emita dados de eventos de rastreio seguros praticamente em tempo real para um URL de destino referente a expedições associadas a um número de conta FedEx específico.
Pode criar um projeto de webhook de Visibilidade integrada avançada no FedEx Developer Portal e, em seguida, associar o webhook a um ou mais números de conta FedEx ou números de rastreio FedEx com base no seu tipo de subscrição selecionado.
Navegue para:
SUBSCRIÇÃO DE NÚMERO DE CONTA DE VISIBILIDADE INTEGRADA AVANÇADA ou SUBSCRIÇÃO DE NÚMERO DE RASTREIO DE VISIBILIDADE INTEGRADA AVANÇADA para consultar os passos para criar o respetivo webhook de Visibilidade Integrada Avançada.
Descrição geral da Visibilidade integrada avançada da FedEx
Os clientes FedEx podem subscrever um número de conta ou número de rastreio para receber eventos de expedição em trânsito praticamente em tempo real, desde a criação de etiquetas à prova de entrega de volumes, incluindo a Foto da prova de entrega.
Tipos de subscrição
Os clientes FedEx podem subscrever a Visibilidade integrada avançada através das seguintes opções:
- Por número de conta – subscreva o Número de conta FedEx para receber atualizações sobre expedições referentes à conta.
- Por número de rastreio – subscreva o Número de rastreio FedEx para receber atualizações sobre expedições referentes aos números de rastreio especificados através dos pontos finais da API.
Nota: atualmente, as Subscrições exigem uma conta FedEx de 9 dígitos dos EUA para faturação e é cobrada uma taxa mensal aos clientes com base na contagem de Números de Rastreio. Para saber mais sobre os preços da Visibilidade integrada avançada, consulte o Guia de preços de descrição geral da Visibilidade integrada avançada.
Se tiver subscrito por número de conta, atualmente as subscrições requerem contas de expedição FedEx baseadas nos EUA de 9 dígitos.
A tabela abaixo dá-lhe informações sobre as funcionalidades da subscrição de números de conta e da subscrição de números de rastreio da Visibilidade integrada avançada
| Funcionalidades | Subscrição baseada em número de conta | Subscrição baseada em número de rastreio |
|---|---|---|
| Resposta | Dados seguros = Informações sobre a identificação (PII), Dados do expedidor, Dados do destinatário, SPOD (Assinatura como prova de entrega), CDO (Opções de entrega convenientes)/resposta | Dados anónimos (inclui atualizações da expedição e em trânsito, excluindo PII - Informações sobre a identificação/resposta) |
| Associação | Associação por um número de conta = associação de todos os números de rastreio associados de uma vez | Associação de números de rastreio |
| Propriedade | Os números de conta têm de pertencer ao utilizador | Os números de rastreio têm de pertencer ao utilizador |
| Filtragem | Tem a capacidade de filtrar eventos por expedições nacionais, de exportação ou de terceiros |
Não é possível filtrar eventos |
| Integração | A associação de números de conta é feita através da IU | A associação de números de rastreio é feita através do ponto final da API |
| Limitação | Pode adicionar até 100 números de conta | Pode adicionar até 1000 números de rastreio por pedido |
| Caso de utilização adequado | Clientes diretos – se os números de conta pertencerem ao cliente | Clientes externos – se o cliente tiver números de rastreio pertencentes a clientes diretos |
Visibilidade Integrada FedEx – Comparação de funcionalidades por tipo de Subscrição
| Funcionalidade/Elementos de dados | Subscrição baseada em número de rastreio | Subscrição baseada em número de conta | Notas |
|---|---|---|---|
| SPOD (Assinatura como prova de entrega) | Não Disponível | Disponível (configuração necessária) | Imagem da assinatura em formato TIFF, entregue em carga |
| PPOD (Foto da Prova de entrega) | Disponível (configuração necessária) | Disponível (configuração necessária) | Imagem JPEG do local de entrega, codificada com base64 |
| PPODA (Foto da prova da tentativa de entrega) | Disponível (configuração necessária) | Disponível (configuração necessária) | Para tentativas de entrega, imagem JPEG fornecida |
| Coordenadas de GPS (gpsPodCoordinates) | Não Disponível | Disponível | Dissimulado em Subscrições baseadas em Rastreio |
| Informações de contacto (nome, telefone, empresa) | Dissimulado | Disponível | Por expedidor, destinatário, origem, destino, despachante alfandegário, etc. |
| Endereço de rua e código postal | Dissimulado | Disponível | streetLines e postalCode estão dissimulados em cargas baseadas em Rastreio |
| Números de conta | Dissimulado | Disponível | Inclui os valores da conta faturado a, expedidor e destinatário |
| Informações financeiras do volume (por exemplo, declaredValue, codAmount) | Dissimulado | Disponível | A alfândega, o COD (Pagamento contra entrega) e os valores declarados estão dissimulados |
| Pesquisa e detalhes de devolução (Códigos de pesquisa, Motivos da devolução) | Dissimulado | Disponível | Os detalhes completos são apresentados apenas para subscritores baseados em contas |
| Dados de conteúdos e mercadoria | Dissimulado | Disponível | Inclui quantidade, descrições, códigos de partes |
| ID do funcionário (por exemplo, equipa do evento) | Dissimulado | Não Disponível | Dissimulado em ambos os casos por motivos de privacidade |
| Notificações de evento e EDD/EDTW | Disponível | Disponível | Funcionalidades de data/hora de entrega estimada suportadas em ambos |
| Expedição com múltiplos pacotes (MPS) | Disponível | Disponível | Com informações de Rastreio adicionais |
| Classificações de risco e confiança da Entrega estimada | Disponível | Disponível | Parte apenas do nível Premium |
Campos de dados dissimulados para a Subscrição da Visibilidade integrada avançada baseada em números de Rastreio
Resumo
Quando os clientes subscrevem atualizações de Rastreio da expedição com a Subscrição da Visibilidade integrada avançada baseada em números de Rastreio em vez da Subscrição da Visibilidade integrada avançada baseada em números de conta, existem campos de dados específicos que são dissimulados para manter a privacidade do cliente e cumprir as políticas de segurança de dados.
Esta dissimulação garante que as informações confidenciais—como detalhes de contacto pessoais, endereços e valores financeiros—são acessíveis apenas às partes autorizadas. Os clientes que utilizam a Subscrição da Visibilidade integrada avançada baseada em números de Rastreio irão ver "XXXXX" nos campos dissimulados listados abaixo, apesar de estes dados poderem estar disponíveis através da Subscrição da Visibilidade integrada avançada baseada em números de Rastreio.
As implicações desta dissimulação incluem:
- Visibilidade limitada dos detalhes de origem/destino e das partes envolvidas.
- Ausência de identificadores pessoais (por exemplo, nomes, números de telefone) e dados financeiros ou relacionados com a alfândega.
- Proteção de propriedade planeada e informações sobre expedições sensíveis para conformidade de segurança e regulamentar.
Recomenda-se aos clientes que solicitem acesso a estes campos dissimulados para casos de utilização operacionais ou comerciais que efetuem a subscrição com o respetivo número de conta.
Os pontos de dados que estão DISSIMULADOS na Subscrição da Visibilidade integrada avançada baseada em números de Rastreio:
Analisar eventos
- scanEvent/location/locationContactAndAddress/address/streetLines
- scanEvent/location/locationContactAndAddress/contact/phoneNumber
- scanEvent/location/locationContactAndAddress/contact/companyName
- scanEvent/location/locationContactAndAddress/contact/personName
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/address/streetLines
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/phoneNumber
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/companyName
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/personName
Informações do expedidor
- trackResult/shipperInfo/contactAndAddress/address/postalCode
- trackResult/shipperInfo/contactAndAddress/address/streetLines
- trackResult/shipperInfo/contactAndAddress/contact/phoneNumber
- trackResult/shipperInfo/contactAndAddress/contact/companyName
- trackResult/shipperInfo/contactAndAddress/contact/personName
- trackResult/shipperInfo/account/value
Informações do Destinatário
- trackResult/recipientInfo/contactAndAddress/address/postalCode
- trackResult/recipientInfo/contactAndAddress/address/streetLines
- trackResult/recipientInfo/account/value
- trackResult/recipientInfo/contactAndAddress/contact/phoneNumber
- trackResult/recipientInfo/contactAndAddress/contact/companyName
- trackResultecipientInfo/contactAndAddress/contact/personName
Local de origem e destino
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/personName
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/originLocation/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/originLocation/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/personName
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/address/postalCode
Detalhes de alteração de endereço e entrega
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/gpsPodCoordinates
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/personName
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/personName
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/companyName
Informações do Despachante
- trackResult/broker/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/broker/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/broker/locationDetail/locationContactAndAddress/contact/personName
- trackResult/broker/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/broker/locationDetail/locationContactAndAddress/address/postalCode
Detalhes financeiros e do volume
- trackResult/packageDetail/customsValue/value
- trackResult/packageDetail/declaredValue/value
- trackResult/packageDetail/originalTransportationCharge/value
- trackResult/codDetail/codAmount/value
Pesquisa e informação da mercadoria
- trackResult/inquiries/[Array]/categoryCode
- trackResult/inquiries/[Array]/code
- trackResult/inquiries/[Array]/createTime
- trackResult/inquiries/[Array]/statusCode
- trackResult/commodityInfo/[Array]/description
- trackResult/commodityInfo/[Array]/code
Conteúdos do volume e Motivo da devolução
- trackResult/contents/[Array]/partNumber
- trackResult/contents/[Array]/partCode
- trackResult/contents/[Array]/description
- trackResult/contents/[Array]/quantity
- trackResult/returnReason/[Array]/code
- trackResult/returnReason/[Array]/description
Informação de facturação
- trackResult/billToParties/[Array]/billToParty/accountNumber
Vantagens para os clientes:
- Aumente a confiança do destinatário com notificações proativas sobre alterações à Data de entrega estimada e ao Intervalo de tempo do dia da entrega durante o transporte.
- Reduza os custos de serviço de apoio ao cliente relativos a chamadas sobre WISMO (Onde está a minha encomenda), bem como sobre contestações de entregas, ao fornecer a Foto da prova de entrega da FedEx.
- Melhore a experiência do cliente ao fornecer notificações praticamente em tempo real sobre o estado da expedição.
- Aumente a eficiência operacional ao receber atualizações push em tempo real sobre expedições, em alternativa a estar constantemente à procura de atualizações de rastreio em todas as expedições.
Funcionalidades e eventos de rastreio
Eventos de rastreio
Esta funcionalidade permite rastrear o estado das expedições e notificar proativamente os clientes sobre diferentes atualizações no ciclo de vida da expedição. Fornece aos clientes opções para escolher a fase exata do processo/eventos de expedição para os quais pretendem receber uma notificação/alerta. Os eventos de expedição disponíveis são:
- Enviar: esta opção fornece uma notificação quando o evento de expedição selecionado ocorrer. Exemplo: etiqueta criada, recolhido, etc.
- Em trânsito: esta opção fornece uma notificação para eventos de trânsito de expedições. Exemplo: em trânsito, volume retido no posto de entrega, etc.
- Entrega: esta opção fornece uma notificação para eventos de entrega de expedições. Exemplo: no exterior para entrega, entregue, etc.
- Exceções: esta opção fornece uma notificação para exceções de entrega. Exemplo: atraso de desalfandegamento, etc.
- Opções de entrega convenientes: selecione esta opção para receber uma notificação para alguns eventos de rastreio personalizados. Exemplo: pedido de retenção na estação aceite.
Para obter mais informações sobre as opções de eventos de expedição disponíveis, consulte a tabela Códigos de estado e estados de eventos de Rastreio de Visibilidade integrada avançada.
Prova de entrega
Esta funcionalidade é utilizada para confirmar que uma encomenda chegou ao destino pretendido com sucesso. Isto inclui:
- Foto da Prova de entrega (PPOD): permite aos clientes receber uma foto com a localização exata do seu volume assim que é entregue à porta de casa.
A Visibilidade integrada avançada apresenta as imagens da PPOD em carga JSON num formato base64. Depois, as imagens podem ser convertidas num formato JPEG.
Nota:
- A PPOD está disponível nos EUA, Canadá, Porto Rico, Hong Kong, Nova Zelândia, Reino Unido e Irlanda.
- A PPOD só está disponível para FedEx Ground, FedEx Express e endereços/volumes residenciais.
- O POD está disponível em entregas elegíveis quando a SPOD (Assinatura como prova de entrega) não for obrigatória. O POD e a SPOD não estão disponíveis em conjunto.
- A PPOD está disponível em entregas com a opção Não é necessária uma assinatura (NSR) que não sejam feitas diretamente ao cliente (por exemplo, entrega feita diretamente a um cliente);
- A PPOD suporta um tamanho de imagem de 14000 a 33000 bytes (aplicável a uma resolução de imagem de 320 x 240).
- Prova de tentativa de entrega em fotografia (PPODA): a PPODA permite aos clientes receber uma foto com a localização exata de onde o volume deve ser entregue, caso a entrega não possa ser concluída. A Visibilidade integrada avançada apresenta as imagens da PPODA em payload JSON num formato base64. Depois, as imagens podem ser convertidas num formato JPEG.
- A PPODA está disponível nos EUA e em Porto Rico.
- A PPODA só está disponível para FedEx Ground, FedEx Express e endereços/volumes residenciais e comerciais.
- A imagem da PPODA pode ser:
- Imagem da PPODA de aviso de passagem na porta.
- Foto de obstrução no ponto de entrega (ou seja, portão fechado).
- Imagem da PPOD de volumes entregues na paragem.
- A PPODA suporta um tamanho de imagem de 14000 a 33000 bytes (aplicável a uma resolução de 320 x 240)
- Assinatura como prova de entrega (SPOD): permite aos clientes receber uma foto da assinatura do destinatário, bem como o respetivo nome, data, hora e local de entrega. As informações da SPOD (Assinatura como prova de entrega) serão apresentadas como uma matriz de bytes e não como imagem. A matriz de bytes é uma cadeia codificada base64 que deve ser descodificada para obter a imagem final da assinatura em formato PNG
- A SPOD (Assinatura como prova de entrega) não está disponível para a Subscrição da Visibilidade integrada avançada baseada em números de Rastreio.
- O tamanho de imagem da SPOD (Assinatura como prova de entrega) será de 4000 a 6000 bytes (aplicável a uma resolução de imagem de 400 x 95).
- O tamanho de imagem da SPOD (Assinatura como prova de entrega) será de 5000 a 8000 bytes (aplicável a uma resolução de imagem de 230 x 150).
- Prova de entrega de GPS (GPSPOD):
- A POD de GPS permite aos clientes receber as coordenados geográficas do local de entrega.
Nota: a GPSPOD está disponível por predefinição para Subscrições da Visibilidade integrada avançada baseada em números de conta.
- A POD de GPS permite aos clientes receber as coordenados geográficas do local de entrega.
Eventos Data de entrega estimada e Intervalo de tempo da entrega
Esta funcionalidade ajuda os destinatários das expedições a planear os respetivos calendários ao indicar um intervalo de datas e/ou horas para entregas de expedição. Isto inclui:
- Data de entrega estimada (EDD): esta opção fornece uma data de entrega estimada da expedição ao destinatário. Exemplo: 20 de novembro de 20XX.
- Intervalo de tempo da entrega estimada (EDTW): esta opção indica um intervalo de tempo estimado ao destinatário para a entrega da expedição no dia da própria entrega. Exemplo: das 14h00 às 18h00.
Filtragem baseada em eventos
Esta funcionalidade permite que os clientes organizem os seus projetos de webhook com base nos métodos de faturação das expedições. As opções são:
- Nacional: selecione esta opção para expedições que serão entregues e pagas por si enquanto destinatário.
- Internacional: selecione esta opção para expedições que serão enviadas e pagas por si enquanto expedidor.
- Terceiros: selecione esta opção para expedições nacionais e internacionais que lhe são cobradas enquanto ordenante de terceiros.
Nota: o seu Número de conta FedEx será utilizado para cobrar ou pagar as expedições. No caso de um ordenante de terceiros, poderá não ser o expedidor ou o destinatário, mas os custos serão cobrados no seu Número de conta FedEx.
Política de novas tentativas
Esta funcionalidade impede a FedEx de enviar dados de eventos de rastreio em caso de um problema do lado do cliente. A FedEx irá reter os dados e tentar reenviá-los após 3 novas tentativas com intervalos de 5 minutos.
Se a FedEx não receber uma resposta com sucesso no intervalo de tempo definido, irá parar a nova entrega desse evento específico. No entanto, o cliente pode pedir eventos perdidos durante um período dos últimos 7 dias através de um botão "TENTAR NOVAMENTE" manual na página Detalhes do projeto do webhook de Visibilidade integrada avançada.
Para obter mais informações sobre políticas de novas tentativas, consulte a secção Mecanismo para novas tentativas.
