API de apólices

Use a API de apólices para consultar apólices de garantia — os registros de cobertura criados quando um cliente compra uma garantia.

Buscar apólices por cliente

GET /api/public/policies/fetch

Retorna todas as apólices de garantia de um cliente. Adicione ?policy_id={id} para buscar uma única apólice com os dados do pedido.

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

Cada apólice inclui: número da apólice, status, informações do cliente, informações do pedido, detalhes do plano de garantia, detalhes do produto protegido e datas de cobertura.

Buscar apólice por ID

GET /api/public/policies/fetch/{policyId}

Retorna uma apólice específica pelo ID.

Parâmetros de consulta:

• shopDomain (obrigatório) — o domínio da sua loja Shopify
• customerId (opcional) — quando informado, inclui os dados do pedido e verifica se a apólice pertence ao cliente

Encontrar apólice por item do pedido

POST /api/public/policies/fetch/order-line-item-policy

Encontra a apólice de garantia de um item específico de um pedido. Usado nas páginas de status do pedido para mostrar a cobertura de garantia de cada produto.

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

Parâmetros do corpo:

• orderId ou orderName (um deles é obrigatório) — identifica o pedido
• lineItemId, variantId ou position (pelo menos um é obrigatório) — identifica o item
• protectionAttributes (opcional) — referência de proteção vinda do cart transform

Validar uma apólice

POST /api/public/policies/validate

Valida que uma apólice existe, conferindo tanto o ID da apólice quanto o nome do pedido. Usado como etapa de segurança nos formulários de sinistro incorporados.

Campos obrigatórios do corpo: orderName, policyId

Retorna { "valid": true } ou { "valid": false }.

Status das apólices

Status	Descrição
active	Dentro do período de cobertura; pode receber sinistros
expired	O período de cobertura terminou
cancelled	Cancelada (reembolso ou ação do lojista)
pending	Em processamento (aguardando a confirmação do pedido)
voided	Anulada devido ao cancelamento do pedido ou a um chargeback

Relacionados

• API de sinistros — abra sinistros contra apólices
• API de garantias — detalhes dos planos de garantia
• API de produtos — verificações de elegibilidade de produtos