API de garantias

Use a API de garantias para obter os detalhes dos planos de garantia e verificar a elegibilidade de produtos para cobertura de garantia.

Obter garantia pelo ID

GET /api/public/warranty/{warrantyId}

Retorna os detalhes do plano de garantia e sua representação como produto na Shopify (usada para adicionar a garantia ao carrinho).

Parâmetro de caminho: warrantyId (obrigatório) — o ID do plano de garantia.

Retorna o objeto da garantia com o tipo de plano, o status, os termos (duração e preço), os detalhes da cobertura e o produto correspondente na Shopify, com os IDs e os preços das variantes.

Verificar elegibilidade de garantia (por produto)

GET / POST /api/public/warranty-eligibility

Verifica se um produto é elegível para cobertura de garantia e retorna os planos disponíveis. É o principal endpoint usado pelo widget da loja.

Cabeçalhos obrigatórios:

• X-Shopify-Shop-Domain — o domínio da sua loja
• X-Shopify-Product-Id — o ID do produto a verificar (ou envie no corpo/na query)

Parâmetros do corpo POST ou da query GET:

• shopifyShopDomain (obrigatório) — o domínio da sua loja
• eligibleProductId (obrigatório) — o ID do produto na Shopify
• cached (opcional) — defina como false para ignorar o cache

Retorna a garantia estendida elegível (com os dados do produto na Shopify), a garantia OEM elegível, os limites do plano, as informações do lojista, o idioma, as traduções e os dados de moeda.

Verificar elegibilidade de garantia (item de linha do pedido)

POST /api/public/warranty/eligibility

Verifica a elegibilidade de um item de linha específico do pedido. Usado nos contextos de pós-compra e da página de status do pedido.

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 de linha

O endpoint procura o item de linha primeiro por lineItemId, depois por variantId e por último por position. O formato da resposta é o mesmo do endpoint de elegibilidade por produto.

Tipos de plano

Tipo de plano	Valor	Descrição
Garantia estendida	extended_warranty	Garantia paga comprada no checkout
Garantia OEM	oem_warranty	Garantia do fabricante incluída sem custo

Relacionados

• Autenticação — Credenciais da API e limites de requisições
• Visão geral dos endpoints — Lista completa de endpoints
• API de produtos — Pesquisa de produtos e elegibilidade
• API de apólices — Gerenciamento de apólices após a compra