Fedex Logo

Introdução

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

Observação:

  • Você precisa ter acesso de administrador para o projeto que tem esta API ativada.
  • 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.

Benefícios da assinatura da visibilidade integrada avançada por número de conta

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

  • Você pode editar e gerenciar facilmente o projeto de visibilidade integrada avançada usando endpoints de API.
  • É possível associar múltiplas contas ao projeto em uma única transação de API, eliminando a necessidade de selecionar cada conta individualmente.

Como funciona a assinatura da visibilidade integrada avançada por número de conta

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

Atualizar um projeto de visibilidade integrada avançada

Use este endpoint para atualizar detalhes de qualquer projeto de visibilidade integrada avançada em sua organização.

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

  • requestType: Especifique o tipo de solicitação de atualização. 
    • ADD_ACCOUNTS: Use esta opção para adicionar contas a um projeto existente se a organização já estiver associada ao projeto de visibilidade integrada avançada para todas as contas.
    • DELETE_ACCOUNTS: Use esta opção para excluir uma conta do projeto.
    • UPDATE_ALL: Use esta opção para realizar atualizações periódicas no projeto.
  • Observação: Este é um elemento opcional, sendo que o UPDATE_ALL é selecionado por padrão se uma opção não for especificada pelo usuário.
  • category: Especifique a categoria do recurso que você deseja atualizar para o projeto. Exemplo: RETRY_POLICY, PROOF_OF_DELIVERY etc.
  • subCategories: Especifique os recursos individuais para a categoria de recursos selecionada. Exemplo: BASIC_HRS, PPOD, SPOD, SHIP, TRAN etc.

Uma resposta bem-sucedida para esta solicitação retorna o ID da assinatura, um indicador informando se o projeto foi atualizado para todas as contas da organização e um carimbo de data e hora referente ao projeto atualizado.

Recuperar detalhes de um projeto

Use este endpoint para recuperar os detalhes de um projeto de visibilidade integrada avançada específico em um formato paginado.

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

  • authorization: Especifique o token de autorização.
  • subscriptionId: Especifique a ID de assinatura do projeto de visibilidade integrada avançada cujos detalhes você deseja recuperar.

Uma resposta bem-sucedida para esta solicitação contém os detalhes do projeto de webhooks especificado em um formato paginado ou retorna um alerta ou os detalhes de erro em caso de falha.

Regras do negócio

  • É possível associar até 30.000 números de conta de envio a um projeto de visibilidade integrada avançada em cada solicitação.
CLOSE

Response

Copy