POST api/v1/pedidoRastreioEvento

Altera a visibilidade ao cliente final ou a descrição de um evento de rastreio já registrado, identificado pelo seu hash. Tipo e data e hora não são alteráveis porque compõem o hash — para corrigi-los, registre um evento novo.

Limite: 120 requisições por minuto

Descrição

Altera a visibilidade ao cliente final, a descrição ou a sigla de um evento de rastreio já registrado.

O evento é identificado pelo seu hash, devolvido na consulta de rastreio (serviço 44).

O que NÃO é alterável. Os campos tipo e dataHora compõem o hash do evento. Alterá-los deixaria o documento com um identificador que não corresponde ao conteúdo, e o mesmo evento voltaria a ser aceito como novo em reenvios futuros — quebrando a idempotência. Enviar qualquer um dos dois resulta em 400, com recusa explícita. Para corrigir tipo ou data, registre um evento novo pelo serviço 43.

Por que a sigla É alterável. Ela não compõe o hash, então corrigi-la não muda a identidade do evento nem afeta reenvios. Este é o único caminho para ajustar uma sigla: reenviar o evento pelo serviço 43 com sigla diferente é tratado como duplicado e não atualiza nada. Para remover uma sigla lançada por engano, envie "sigla": null ou "sigla": "".

Como localizar o volume. Informe o pedido por idPedido (o mais preciso, devolvido pelo serviço 43) ou por numeroPedido / pedidoCanal / pedidoLoja. Informe o volume por chaveEnvio ou, alternativamente, por codigoRastreio / chaveNFe / identificadorEnvio — a mesma precedência do serviço 43.

Caso de uso mais comum. Um evento foi lançado como público e deveria ser interno (ou o contrário). Enviar visivelClienteFinal: false remove o evento da página pública imediatamente, mantendo-o visível ao atendente na tela do pedido.

Obs.: Utilizar tokenAPI (Authorization: Bearer)

Limite de requisições: 120 requisições por minuto.

Códigos de erro:

Código	Descrição
400	Requisição inválida — JSON ausente, hash não informado, nenhuma forma de localizar o pedido ou o volume, nenhum campo alterável informado, descrição vazia, sigla que não é texto, ou tentativa de alterar tipo/dataHora.
401	Não autorizado — Token ausente, inválido, inativo ou sem permissão para este serviço/método.
404	Pedido não encontrado, volume de rastreio não encontrado, ou hash inexistente neste volume.
429	Limite de requisições ultrapassada — Aguarde o próximo minuto para novas requisições.

Body da Requisição

{
  "idPedido": "21487f878432f9f72dfe4df59c4a47d4",
  "chaveEnvio": "1175100",
  "hash": "e0d24f8a1c6b93705d2f8a1c6b93705d2f8a1c6b",
  "visivelClienteFinal": false,
  "descricao": "Divergência de endereço - em tratativa com o comercial",
  "sigla": "CDL"
}

Parâmetros de Entrada

Campo	Descrição	Tipo	Tamanho	Obrigatório
hash	Identificador do evento a alterar, obtido na consulta de rastreio (serviço 44).	string	40	sim
idPedido	Identificador do pedido no HelpyGo, devolvido pelo serviço 43. É a forma mais precisa de localizar o pedido. Obrigatório se numeroPedido, pedidoCanal e pedidoLoja não forem informados.	string	32	condicional
numeroPedido	Número do pedido no HelpyGo. Alternativa a idPedido.	string	100	condicional
pedidoCanal	Número do pedido no canal/marketplace. Alternativa a idPedido.	string	100	condicional
pedidoLoja	Número do pedido na loja/plataforma de envio. Alternativa a idPedido.	string	100	condicional
chaveEnvio	Chave do volume onde o evento está. Tem precedência sobre os campos abaixo.	string	100	condicional
codigoRastreio	Alternativa para identificar o volume, quando chaveEnvio não é informada.	string	100	condicional
chaveNFe	Alternativa para identificar o volume, 44 dígitos.	string	44	condicional
identificadorEnvio	Alternativa para identificar o volume, quando não há código nem nota.	string	100	condicional
visivelClienteFinal	Nova visibilidade do evento na página pública. Informe este campo, descricao e/ou sigla — ao menos um é obrigatório.	boolean		condicional
descricao	Nova descrição do evento. Truncada em 500 caracteres. Não pode ser vazia.	string	500	condicional
sigla	Nova sigla do evento (código no sistema da loja). Truncada em 10 caracteres. Envie null ou "" para remover a sigla. Alterável porque não compõe o hash do evento.	string	10	condicional
tipo	Não alterável. Compõe o hash do evento. Enviar este campo resulta em 400.	-		não
dataHora	Não alterável. Compõe o hash do evento. Enviar este campo resulta em 400.	-		não

Parâmetros de Retorno

Campo	Descrição	Tipo	Tamanho
mensagem	Mensagem da operação. Em erro, descreve o campo e o motivo.	string	255
idPedido	Identificador do pedido no HelpyGo.	string	32
chaveEnvio	Chave do volume onde o evento foi alterado.	string	100
hash	Identificador do evento alterado. Permanece o mesmo, porque tipo e dataHora não mudam.	string	40
alterado	Lista dos campos efetivamente alterados nesta requisição.	array

Exemplo de Resposta

{
  "mensagem": "Evento atualizado",
  "idPedido": "21487f878432f9f72dfe4df59c4a47d4",
  "chaveEnvio": "1175100",
  "hash": "e0d24f8a1c6b93705d2f8a1c6b93705d2f8a1c6b",
  "alterado": [
    "visivelClienteFinal",
    "descricao",
    "sigla"
  ]
}