API de garantías

Crea, consulta y gestiona planes de garantía mediante la API

API de garantías

Usa la API de garantías para obtener los detalles de los planes de garantía y verificar si un producto es elegible para la cobertura de garantía.

Obtener una garantía por ID

GET /api/public/warranty/{warrantyId}

Devuelve los detalles del plan de garantía y su representación como producto de Shopify (que se usa para agregar la garantía al carrito).

Parámetro de ruta: warrantyId (obligatorio) — el ID del plan de garantía.

Devuelve el objeto de la garantía con el tipo de plan, el estado, los términos (duración y precio), los detalles de la cobertura y el producto de Shopify correspondiente con los ID y precios de sus variantes.

Verificar la elegibilidad de garantía (por producto)

GET / POST /api/public/warranty-eligibility

Verifica si un producto es elegible para la cobertura de garantía y devuelve los planes disponibles. Es el endpoint principal que usa el widget de la tienda.

Encabezados obligatorios:

  • X-Shopify-Shop-Domain — el dominio de tu tienda
  • X-Shopify-Product-Id — el ID del producto que se va a verificar (o envíalo en el cuerpo o la consulta)

Parámetros del cuerpo (POST) o de la consulta (GET):

  • shopifyShopDomain (obligatorio) — el dominio de tu tienda
  • eligibleProductId (obligatorio) — el ID del producto de Shopify
  • cached (opcional) — establécelo en false para omitir la caché

Devuelve la garantía extendida elegible (con los datos del producto de Shopify), la garantía OEM elegible, los límites del plan, la información del comerciante, la configuración regional, las traducciones y los datos de moneda.

Verificar la elegibilidad de garantía (línea de pedido)

POST /api/public/warranty/eligibility

Verifica la elegibilidad de una línea de pedido específica. Se usa en los contextos posteriores a la compra y de la página de estado del pedido.

Encabezado obligatorio: X-Shopify-Shop-Domain

Parámetros del cuerpo:

  • orderId u orderName (uno obligatorio) — identifica el pedido
  • lineItemId, variantId o position (al menos uno obligatorio) — identifica la línea de pedido

El endpoint busca la línea de pedido primero por lineItemId, luego por variantId y después por position. El formato de la respuesta coincide con el del endpoint de elegibilidad por producto.

Tipos de plan

Tipo de planValorDescripción
Garantía extendidaextended_warrantyGarantía de pago que se compra al finalizar la compra
Garantía OEMoem_warrantyGarantía del fabricante incluida sin cargo

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