Warranty API

Use the Warranty API to retrieve warranty plan details and check product eligibility for warranty coverage.

Get warranty by ID

GET /api/public/warranty/{warrantyId}

Returns the warranty plan details and its Shopify product representation (used for adding the warranty to cart).

Path parameter: warrantyId (required) — the warranty plan ID.

Returns the warranty object with plan type, status, terms (duration and price), coverage details, and the corresponding Shopify product with variant IDs and prices.

Check warranty eligibility (product-based)

GET / POST /api/public/warranty-eligibility

Checks whether a product is eligible for warranty coverage and returns available plans. This is the primary endpoint used by the storefront widget.

Required headers:

• X-Shopify-Shop-Domain — your store domain
• X-Shopify-Product-Id — the product ID to check (or pass in body/query)

POST body or GET query parameters:

• shopifyShopDomain (required) — your store domain
• eligibleProductId (required) — the Shopify product ID
• cached (optional) — set to false to bypass cache

Returns the eligible extended warranty (with Shopify product data), eligible OEM warranty, plan limits, merchant info, locale, translations, and currency data.

Check warranty eligibility (order line item)

POST /api/public/warranty/eligibility

Checks eligibility for a specific order line item. Used in post-purchase and order status page contexts.

Required header: X-Shopify-Shop-Domain

Body parameters:

• orderId or orderName (one required) — identifies the order
• lineItemId, variantId, or position (at least one required) — identifies the line item

The endpoint looks up the line item by lineItemId first, then variantId, then position. Response format matches the product-based eligibility endpoint.

Plan types

Plan Type	Value	Description
Extended Warranty	extended_warranty	Paid warranty purchased at checkout
OEM Warranty	oem_warranty	Manufacturer warranty included at no charge

Related

• Authentication — API credentials and rate limits
• Endpoints Overview — Full endpoint listing
• Products API — Product search and eligibility
• Policies API — Policy management after purchase