API de pólizas

Consulta y gestiona las pólizas de garantía

API de pólizas

Usa la API de pólizas para consultar pólizas de garantía, es decir, los registros de cobertura que se crean cuando un cliente compra una garantía.

Obtener las pólizas de un cliente

GET /api/public/policies/fetch

Devuelve todas las pólizas de garantía de un cliente. Agrega ?policy_id={id} para obtener una sola póliza con los datos de su pedido.

Encabezados obligatorios: X-Shopify-Shop-Domain, X-Shopify-Customer-Id

Cada póliza incluye: número de póliza, estado, información del cliente, información del pedido, detalles del plan de garantía, detalles del producto protegido y fechas de cobertura.

Obtener una póliza por ID

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

Devuelve una póliza específica por su ID.

Parámetros de consulta:

  • shopDomain (obligatorio) — el dominio de tu tienda de Shopify
  • customerId (opcional) — si se proporciona, incluye los datos del pedido y verifica que la póliza pertenezca al cliente

Buscar una póliza por artículo del pedido

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

Busca la póliza de garantía de un artículo específico de un pedido. Se usa en las páginas de estado del pedido para mostrar la cobertura de garantía de cada producto.

Encabezado obligatorio: X-Shopify-Shop-Domain

Parámetros del cuerpo:

  • orderId u orderName (uno es obligatorio) — identifica el pedido
  • lineItemId, variantId o position (al menos uno es obligatorio) — identifica el artículo
  • protectionAttributes (opcional) — referencia de protección de la transformación del carrito

Validar una póliza

POST /api/public/policies/validate

Valida que una póliza exista comprobando que coincidan tanto el ID de la póliza como el nombre del pedido. Se usa como paso de seguridad en los formularios de reclamo integrados.

Campos obligatorios del cuerpo: orderName, policyId

Devuelve { "valid": true } o { "valid": false }.

Estados de la póliza

EstadoDescripción
activeDentro del periodo de cobertura; puede aceptar reclamos
expiredEl periodo de cobertura terminó
cancelledCancelada (por reembolso o acción del comerciante)
pendingEn proceso (en espera de la confirmación del pedido)
voidedAnulada por cancelación del pedido o contracargo

Relacionado

Solicitar demo

Descubre cómo myUmbrella puede transformar tu programa de garantías

Elige un horario

Elige un horario conveniente para tu demo personalizada

ESC

Empieza a escribir para buscar en todo el contenido

No se encontraron resultados

Prueba con otro término de búsqueda