A assinatura da visibilidade integrada avançada por número de rastreamento foi criada para permitir que o assinante gerencie seus projetos de webhook baseados em números de rastreamento e realize operações de projeto como adicionar números de rastreamento e editar ou visualizar detalhes do trabalho usando endpoints de API.

Observação:

• Você precisa ter acesso de administrador ou colaborador ao projeto de visibilidade integrada avançada.
• Para obter mais informações sobre a visibilidade integrada avançada e seus recursos, acesse a página de documentação da visibilidade integrada avançada.

Estes são os benefícios da assinatura da visibilidade integrada avançada por número de rastreamento:

• Você pode editar e gerenciar facilmente os números de rastreamento do projeto de visibilidade integrada avançada usando endpoints de API.
• É possível associar múltiplos números de rastreamento ao projeto em uma única transação de API, eliminando a necessidade de associar cada número de rastreamento individualmente.
• Você pode enviar as solicitações consecutivas de API e visualizar os detalhes de sucesso/falha no registro das solicitações.

Use os endpoints abaixo para gerenciar seu projeto de visibilidade integrada avançada:

Esta API só pode ser acessada na visão geral do projeto, como mostrado na captura de tela acima.

Use este endpoint para acionar um trabalho assíncrono que associa um ou mais números de rastreamento a um projeto específico de visibilidade integrada avançada.

As informações de entrada necessárias para essa solicitação são as seguintes:

• Ação: especifique a ação a ser realizada ao enviar a solicitação. Exemplo: ADD.
• Detalhes do número de rastreamento: especifique o número de rastreamento.

É possível associar até 1.000 números de rastreamento em uma única solicitação. A resposta bem-sucedida a essa solicitação retornará jobID, status atual do trabalho e carimbo de data e hora da criação e da conclusão do trabalho. Use a jobID posteriormente para verificar o status do trabalho assíncrono.

Use este endpoint para obter o status de um trabalho assíncrono (uma ou mais solicitações consecutivas na fila) ou o status de todos os trabalhos enviados.

As informações de entrada necessárias para essa solicitação são as seguintes:

• ID do trabalho: especifique a ID do trabalho cujo status você deseja obter.

Observação: a ID do trabalho é opcional para esse endpoint. Se a ID do trabalho não for especificada, você receberá o status de todos os trabalhos enviados.

A resposta bem-sucedida a essa solicitação retornará jobID, status atual do trabalho e carimbo de data e hora da criação e da conclusão do trabalho. A resposta exibirá o status atual dos trabalhos. Além disso, a resposta também conterá mensagens de sucesso, erros ou avisos para permitir que os usuários visualizem e solucionem problemas, conforme aplicável.

• Um status de trabalho CONCLUÍDO indica que todos os números de rastreamento foram validados e processados corretamente.
  • O status CONCLUÍDO significa que os números de rastreamento foram validados e processados corretamente, mas não significa que todos os números de rastreamento foram adicionados corretamente ao projeto de visibilidade integrada avançada.
  • Se você tentar associar vários números de rastreamento e apenas alguns forem associados, o trabalho ainda terá o status de CONCLUÍDO. Para confirmar o status de cada número de rastreamento na solicitação de associação, baixe o relatório do lote.

Observação:

• Um status de trabalho de FALHA indica que não foi possível processar a solicitação devido a problemas diversos ou falha no hardware e que o usuário deve tentar novamente.

Status e suas descrições:

Use este endpoint para baixar o relatório JSON de um trabalho assíncrono que tenha o status de CONCLUÍDO.

As informações de entrada necessárias associadas a essa solicitação são as seguintes:

• ID do trabalho: especifique a ID do trabalho cujo status você deseja obter.

Observação:

• A ID do trabalho é obrigatória para esse endpoint.
• Só é possível baixar o relatório de um trabalho assíncrono por vez.
• Se o trabalho não estiver CONCLUÍDO e você tentar baixar o relatório, uma mensagem de erro será exibida.

A resposta bem-sucedida dessa solicitação gera o relatório do trabalho no formato JSON.

• É possível associar até 1.000 números de rastreamento de envio a um projeto de visibilidade integrada avançada em cada solicitação.
• Não existe um limite máximo de números de rastreamento que podem ser associados a um projeto de visibilidade integrada avançada.
• Após 40 dias, qualquer número de rastreamento associado será desassociado do projeto de visibilidade integrada avançada.
• O status e os detalhes da ID de trabalho de um projeto de visibilidade integrada avançada não estarão disponíveis após 90 dias.
• Informações de rastreamento protegidas, como endereço e assinatura do destinatário, não estarão disponíveis na assinatura da visibilidade integrada avançada por número de rastreamento.