API de sinistros

Use a API de sinistros para enviar sinistros de garantia, fazer upload de arquivos de evidência e consultar o status dos sinistros.

Enviar um sinistro

POST /api/public/claims/submit

Envia um sinistro contra uma apólice existente. O sinistro é criado com status pending e dispara notificações por e-mail para o cliente e o lojista.

Cabeçalhos (recomendados): X-Shopify-Shop-Domain, X-Shopify-Customer-Id

Campos obrigatórios do corpo:

• policyId — a apólice contra a qual o sinistro é aberto
• claimType — veja os tipos de sinistro abaixo
• description — o que aconteceu
• dateOfIncident — data ISO do incidente

Opcional: additionalInfo

Tipos de sinistro

Valor	Descrição
manufacturer_defect	O produto falhou por um problema de fabricação
accidental_damage	Danificado por acidente
wear_and_tear	Desgastado pelo uso normal
spill_or_stain	Danificado por líquido ou mancha
lost_or_stolen	Perdido ou roubado
other	Outro motivo

Retorna claimId em caso de sucesso. Se a apólice tiver atingido o limite de sinistros, retorna um erro CLAIM_LIMIT_REACHED com detalhes.

Enviar um sinistro manual

POST /api/public/claims/submit-manual

Envia um sinistro sem uma apólice existente. Usado para sinistros iniciados pelo lojista (por exemplo, a partir do PDV).

Cabeçalho obrigatório: X-Shopify-Shop-Domain

Campos obrigatórios do corpo: customerEmail, customerName, productName, claimType, description, dateOfIncident

Opcional: customerPhone, orderNumber, additionalInfo

Buscar os sinistros de uma apólice

GET /api/public/claims/fetch?policy_id={policyId}

Cabeçalhos obrigatórios: X-Shopify-Shop-Domain, X-Shopify-Customer-Id

Retorna todos os sinistros da apólice e do cliente especificados, incluindo número do sinistro, status, tipo, motivo e datas.

Obter as evidências de um sinistro

GET /api/public/claims/{id}/evidence

Cabeçalhos obrigatórios: X-Shopify-Shop-Domain, X-Shopify-Customer-Id

Retorna os arquivos de evidência (fotos, vídeos) anexados ao sinistro.

Fazer upload de arquivos de evidência

POST /api/public/claims/upload-urls

Gera uma URL pré-assinada para fazer upload das evidências diretamente no armazenamento em nuvem.

Campos obrigatórios do corpo: fileName, fileType (tipo MIME), fileSize (bytes), claimId, fileCategory (photo ou video)

Limites de arquivo:

• Fotos (JPEG, PNG, GIF, WebP): máximo de 10 MB
• Vídeos (MP4, QuickTime, WebM): máximo de 100 MB

Fluxo de upload:

1. Chame /claims/upload-urls para obter uma URL pré-assinada
2. Envie o arquivo com PUT diretamente para essa URL, com o cabeçalho Content-Type correto

Status dos sinistros

Status	Descrição
pending	Enviado, aguardando a revisão do lojista
approved	Aprovado pelo lojista
denied	Negado pelo lojista
in_review	Em revisão ativa
resolved	Totalmente resolvido (substituição, reembolso etc.)

Relacionados

• API de apólices — Consulte as apólices antes de abrir sinistros
• API de garantias — Detalhes dos planos de garantia
• Referência de webhooks — Seja notificado quando o status de um sinistro mudar