Tipos de webhooks de visibilidade integrada avançada
O webhook de visibilidade integrada avançada permite que a FedEx envie dados de eventos de rastreamento, de forma segura e quase em tempo real, referentes a remessas associadas a números de conta FedEx específicos para um URL de destino.
Você pode criar um projeto de webhook de visibilidade integrada avançada no FedEx Developer Portal e associá-lo a um ou mais números de conta FedEx ou números de rastreamento FedEx com base no tipo de inscrição selecionado.
Ir para:
INSCRIÇÃO DA VISIBILIDADE INTEGRADA AVANÇADA POR NÚMERO DE CONTA ou INSCRIÇÃO DA VISIBILIDADE INTEGRADA AVANÇADA POR NÚMERO DE RASTREAMENTO para ver as etapas necessárias para a criação do webhook de visibilidade integrada avançada.
Visão geral da visibilidade integrada avançada da FedEx
Os clientes da FedEx podem fazer uma assinatura usando um número de conta ou número de rastreamento para receber, quase em tempo real, atualizações sobre eventos de remessas em trânsito, desde a criação de etiquetas até o comprovante de entrega de pacotes, incluindo a foto do comprovante de entrega.
Tipos de assinatura
Os clientes da FedEx podem assinar a visibilidade integrada avançada utilizando uma destas opções:
- Por número da conta: assine usando o número da conta FedEx para receber atualizações de remessas correspondentes à conta.
- Por número de rastreamento: assine usando o número de rastreamento FedEx para receber atualizações sobre remessas correspondentes aos números de rastreamento especificados nos endpoints da API.
Observação: atualmente, as assinaturas exigem uma conta de 9 dígitos da FedEx nos EUA para cobrança, e os clientes pagam uma taxa mensal com base na quantidade de números de rastreamento. Para saber mais sobre os preços da visibilidade integrada avançada, consulte o guia de preços na visão geral da visibilidade integrada avançada.
Assinatura por número de conta: atualmente as assinaturas exigem contas FedEx de envio estabelecidas nos EUA com 9 dígitos.
A tabela abaixo mostra informações sobre os recursos da inscrição por número de conta e da inscrição da visibilidade integrada avançada por número de rastreamento
| Recursos | Assinatura por número de conta | Assinatura por número de rastreamento |
|---|---|---|
| Resposta | Dados seguros: informações pessoalmente identificáveis (PIIs), dados do remetente e do destinatário, comprovante de entrega assinado, opção de entrega conveniente (CDO)/resposta | Dados anônimos, como remessa e atualizações em trânsito, exceto PIIs/resposta |
| Associação | Associação por número de conta: associação de todos os números de rastreamento vinculados de uma vez | Associação de números de rastreamento |
| Propriedade | Os números de conta devem pertencer ao próprio usuário | Os números de rastreamento não precisam pertencer ao usuário |
| Filtragem | Pode filtrar eventos por remessas de entrada, de saída e de terceiros |
Não é possível filtrar eventos |
| Integração | Associação de números de conta por meio da interface do usuário | Associação de números de rastreamento por meio do endpoint de API |
| Limitação | É possível adicionar até 100 números de conta | É possível adicionar até 1.000 números de rastreamento por solicitação |
| Caso de uso adequado | Clientes diretos: se o cliente for o proprietário dos números de conta | Clientes terceiros: se o cliente tiver números de rastreamento que pertencem a clientes diretos |
Visibilidade integrada da FedEx – Comparação de recursos por tipo de assinatura
| Recurso/Elemento de dados | Assinatura por número de rastreamento | Assinatura por número de conta | Observações |
|---|---|---|---|
| SPOD (comprovante de entrega assinado) | Não disponível | Disponível (configuração necessária) | Imagem da assinatura em formato TIFF, entregue na carga útil |
| PPOD (foto do comprovante de entrega) | Disponível (configuração necessária) | Disponível (configuração necessária) | Imagem JPEG do local da entrega, codificação base64 |
| PPODA (foto do comprovante 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 | Mascaradas em assinaturas com base no rastreamento |
| Informações de contato (nome, telefone, empresa) | Mascaradas | Disponível | Remetente, destinatário, origem, destino, despachante etc. |
| Endereço e código postal | Mascaradas | Disponível | streetLines e postalCode são mascarados nas cargas úteis com base no rastreamento |
| Números de conta | Mascaradas | Disponível | Inclui valores da conta de billTo, remetente e destinatário |
| Valores financeiros do pacote (p. ex., declaredValue, codAmount) | Mascaradas | Disponível | Valores de alfândega, COD e declarados são mascarados |
| Detalhes de consulta e devolução (códigos de consulta, motivos de devolução) | Mascaradas | Disponível | Detalhes completos exibidos apenas para assinantes com base na conta |
| Dados de mercadorias e conteúdo | Mascaradas | Disponível | Inclui códigos, descrições, quantidades de peças |
| ID do funcionário (p. ex., equipe do evento) | Mascaradas | Não disponível | Mascarada em ambos os casos por motivos de privacidade |
| Notificações do evento e EDD/EDTW | Disponível | Disponível | Recursos de horário/data estimada da entrega aceitos em ambos |
| Remessa com vários pacotes (MPS) | Disponível | Disponível | Com informações adicionais de rastreamento |
| Pontuações de confiança e risco da entrega estimada | Disponível | Disponível | Apenas no nível premium |
Campos de dados mascarados para a assinatura da visibilidade integrada avançada por número de rastreamento
Resumo
Quando os clientes assinam o recebimento de atualizações do rastreamento de remessas usando a assinatura da visibilidade integrada avançada por número de rastreamento em vez da assinatura da visibilidade integrada avançada por número da conta, campos de dados específicos são mascarados para manter a privacidade do cliente e atender às políticas de segurança de dados.
O mascaramento garante que apenas as partes autorizadas possam acessar as informações sigilosas, como dados pessoais de contato, endereços e valores financeiros. Os clientes que usam a assinatura da visibilidade integrada avançada por número de rastreamento verão "XXXXX" nos campos mascarados mencionados abaixo, mesmo que esses dados possam estar disponíveis na assinatura da visibilidade integrada avançada.
Consequências do mascaramento:
- Visibilidade limitada dos detalhes de origem/destino e das partes envolvidas.
- Ausência de identificadores pessoais (p. ex., nome, número de telefone) e dados financeiros ou relacionados à alfândega.
- Proteção por design de informações proprietárias ou sigilosas da remessa para fins de segurança e conformidade regulatória.
Recomendamos que os clientes que solicitam acesso a esses campos mascarados para uso operacional ou comercial façam a assinatura usando o número da conta.
Pontos de dados que são MASCARADOS na assinatura da visibilidade integrada avançada por número de rastreamento:
Eventos de escaneamento
- 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 da alteração de entrega e endereço
- 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
Dados 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 pacote
- trackResult/packageDetail/customsValue/value
- trackResult/packageDetail/declaredValue/value
- trackResult/packageDetail/originalTransportationCharge/value
- trackResult/codDetail/codAmount/value
Informações sobre consultas e mercadorias
- 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údo do pacote 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ções sobre faturamento
- trackResult/billToParties/[Array]/billToParty/accountNumber
Benefícios aos clientes:
- Aumente a confiança do destinatário com notificações proativas para alterações em trânsito para Data estimada da entrega e janela de tempo de data de entrega.
- Reduza os custos do serviço de atendimento ao cliente para chamadas WISMO ("where is my order", ou "onde estão meus pedidos") e para contestações de entrega fornecendo a foto do comprovante de entrega da FedEx.
- Melhore a experiência do cliente fornecendo notificações quase em tempo real sobre status de remessas.
- Obtenha eficiência operacional recebendo atualizações por push em tempo real sobre as remessas, sem precisar fazer consultas contínuas para rastrear cada remessa.
Recursos e eventos de rastreamento
Eventos de rastreamento
Este recurso permite rastrear o status das remessas de forma proativa e notificar os clientes sobre as atualizações ao longo do ciclo de vida da remessa. Os clientes podem escolher o evento ou estágio exato do processo da remessa para os quais desejam receber notificações ou alertas. Estes são os eventos de remessa disponíveis:
- Envio: esta opção envia uma notificação quando o evento de remessa selecionado ocorre. Exemplo: etiqueta criada, coleta feita etc.
- Em trânsito: esta opção envia notificações sobre os eventos de trânsito da remessa. Exemplo: em trânsito, item retido na agência de entrega etc.
- Entrega: esta opção envia notificações sobre os eventos de entrega da remessa. Exemplo: saiu para entrega, entregue etc.
- Exceções: esta opção envia notificações relacionadas a exceções de entrega. Exemplo: atrasos de liberação etc.
- Opções de entrega conveniente: esta opção envia notificações sobre eventos de rastreamento personalizados. Exemplo: solicitação para reter na localidade aceita.
Para saber mais sobre as opções de eventos de remessa disponíveis, consulte a tabela Códigos de status e status de eventos de rastreamento da visibilidade integrada avançada.
Comprovante de entrega
Este recurso é usado para confirmar que um pedido foi recebido com êxito no destino pretendido. Essas informações incluem:
- Foto do comprovante de entrega (PPOD): a PPOD mostra aos clientes a localização exata do pacote no momento em que ele é entregue na porta de entrada.
A visibilidade integrada avançada entrega as imagens de PPOD na carga útil JSON no formato Base64. Após a entrega, essas imagens podem ser convertidas no formato JPEG.
Observação:
- A opção de PPOD está disponível nos EUA, Canadá, Porto Rico, Hong Kong, Nova Zelândia, Reino Unido e Irlanda.
- A opção de PPOD só está disponível para o FedEx Ground, o FedEx Express e pacotes/endereços residenciais.
- A opção de PPOD está disponível para entregas qualificadas quando o SPOD não é obrigatório. As opções PPOD e SPOD não estão disponíveis juntas.
- A opção de PPOD está disponível para entregas em que a assinatura é necessária (NSR) e que não são entregues diretamente para um cliente (ex., confiadas diretamente a um cliente durante a entrega).
- O PPOD aceita imagens de 14.000 a 33.000 bytes (aplicável a imagens com resolução de 320 x 240).
- Foto do comprovante da tentativa de entrega (PPODA): permite que os clientes recebam uma foto da localização exata onde o pacote deve ser entregue caso não seja possível concluir a entrega. A visibilidade integrada avançada entrega as imagens de PPODA na carga útil JSON no formato base64. Após a entrega, as imagens podem ser convertidas para o formato JPEG.
- A PPODA está disponível nos EUA e em Porto Rico.
- A opção de PPODA só está disponível para o FedEx Ground, o FedEx Express e pacotes/endereços residenciais e comerciais.
- A imagem da PPODA pode ser:
- Uma foto do aviso de serviço na porta.
- Uma foto da obstrução no ponto de entrega (por exemplo, portão trancado).
- Uma imagem dos pacotes entregues na parada.
- A PPODA aceita imagens de 14.000 a 33.000 bytes (válido para imagens com resolução de 320 x 240)
- Comprovante de entrega assinado (SPOD): o SPOD mostra aos clientes a assinatura do destinatário, bem como seu nome, data, hora e local de entrega. As informações no SPOD são apresentadas como um array de bytes, não como uma imagem. O array de bytes é uma sequência de caracteres codificada em Base64 que deve ser decodificada para gerar a imagem final da assinatura em formato PNG.
- O SPOD não está disponível para a assinatura da visibilidade integrada avançada por número de rastreamento.
- A imagem do SPOD terá de 4.000 a 6.000 bytes (aplicável a imagens com resolução de 400 x 95).
- A imagem do SPOD terá de 5.000 a 8.000 bytes (aplicável a imagens com resolução de 230 x 150).
- Comprovante de entrega GPS (GPSPOD):
- O GPSPOD permite que os clientes recebam as coordenadas geográficas do local de entrega.
Observação: o GPSPOD é disponibilizado por padrão para a assinatura da visibilidade integrada avançada por número da conta.
- O GPSPOD permite que os clientes recebam as coordenadas geográficas do local de entrega.
Eventos de data estimada da entrega e janela de tempo da entrega
Este recurso ajuda o destinatário da remessa a organizar sua agenda, pois mostra uma data ou um intervalo de tempo para as entregas da remessa. Essas informações incluem:
- Data estimada da entrega (EDD): esta opção fornece uma data estimada para a entrega da remessa ao destinatário. Exemplo: 20 de novembro de 20XX.
- Janela de tempo de entrega estimada (EDTW): esta opção disponibiliza ao destinatário uma janela de tempo estimada para a entrega da remessa no dia real da entrega. Exemplo: das 14h às 18h.
Filtros com base em evento
Este recurso permite que os clientes organizem seus projetos de webhooks com base nos métodos de faturamento das remessas. Estas são as opções disponíveis:
- Entrada: Selecione esta opção para remessas que serão entregues a você e pagas por você como destinatário.
- Saída: Selecione esta opção para remessas que serão enviadas por você e pagas por você como remetente.
- Terceiros: Selecione esta opção para remessas de entrada e saída que são faturadas para você como pagador terceirizado.
Observação: seu número de conta FedEx será usado para faturar ou pagar as remessas. No caso de um terceiro pagador, mesmo que você não seja o remetente ou o destinatário, as cobranças serão feitas ao seu número de conta FedEx.
Política de novas tentativas
Este recurso impede que a FedEx envie dados de eventos de rastreamento em caso de problemas no lado do cliente. A FedEx reterá os dados e tentará reenviá-los em um intervalo de três tentativas a cada 5 minutos.
Caso você não receba uma resposta bem-sucedida no período estabelecido, a FedEx interromperá a tentativa de nova entrega desse evento específico. No entanto, o cliente pode solicitar eventos perdidos nos últimos sete dias usando o botão manual "TENTAR NOVAMENTE" na página de detalhes do webhook do projeto de visibilidade integrada avançada.
Para saber mais sobre as políticas de novas tentativas, consulte a seção Mecanismo de nova tentativa .
