API de produtos

Use a API de produtos para pesquisar produtos sincronizados, verificar a elegibilidade de garantia em lote e registrar produtos para cobertura de garantia.

Pesquisar produtos

GET /api/public/products/search

Pesquisa seu catálogo de produtos sincronizados por título, SKU, código de barras ou fornecedor.

Parâmetros de consulta:

• search (obrigatório) — termo de busca, com no mínimo 2 caracteres
• limit (opcional) — máximo de resultados; padrão 20, máximo 50
• myshopifyDomain (opcional) — filtra pelo domínio da loja
• orgId (opcional) — quando informado, os resultados incluem dados de elegibilidade (isEligible, warrantyIds, regras correspondentes)

Verificar a elegibilidade de produtos (em lote)

GET /api/public/products/eligibility

Verifica a elegibilidade de garantia de vários produtos de uma só vez.

Parâmetros de consulta:

• productIdsString (obrigatório) — IDs de produtos separados por vírgula
• orgId (obrigatório) — ID da organização

Retorna cada produto com isEligible, defaultExtendedWarrantyId, defaultOEMWarrantyId e warrantyIds.

Registrar um produto

POST /api/public/products/register

Registra um produto para cobertura de garantia por meio do formulário de registro voltado ao cliente.

Campos obrigatórios: productId, purchaseDate, purchasedFrom, customerName, customerEmail, shopDomain

Campos opcionais: customerPhone, orderNumber, serialNumber, warrantyId, warrantyType, warrantyTerm, purchaseProofFileCount, productPhotoFileCount

Regras de validação:

• A data da compra deve ser hoje ou anterior e estar dentro dos últimos 2 anos
• O e-mail deve ter um formato válido
• O produto deve existir na loja Shopify
• O domínio da loja deve estar cadastrado no Umbrella

Em caso de sucesso, retorna um registrationId e um registrationNumber com status pending. Um e-mail de confirmação é enviado ao cliente, e o lojista tem 30 dias para analisar o registro.

Relacionados

• Autenticação — credenciais da API
• API de garantias — gerenciamento de planos de garantia
• API de registros e números de série — consulta de registros e validação de números de série
• Visão geral dos endpoints — lista completa de endpoints