Policies API

Query and manage warranty policy instances

Use the Policies API to query warranty policies — the coverage records created when a customer purchases a warranty.

Fetch policies by customer

GET /api/public/policies/fetch

Returns all warranty policies for a customer. Add ?policy_id={id} to fetch a single policy with its order data.

Required headers: X-Shopify-Shop-Domain, X-Shopify-Customer-Id

Each policy includes: policy number, status, customer info, order info, warranty plan details, protected product details, and coverage dates.

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

Returns a specific policy by ID.

Query parameters:

shopDomain (required) — your Shopify store domain
customerId (optional) — when provided, includes order data and verifies customer ownership

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

Finds the warranty policy for a specific line item in an order. Used on order status pages to show warranty coverage per product.

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
protectionAttributes (optional) — protection reference from cart transform

POST /api/public/policies/validate

Validates that a policy exists by matching both the policy ID and order name. Used as a security step in embedded claim forms.

Required body fields: orderName, policyId

Returns { "valid": true } or { "valid": false }.

Status	Description
`active`	Within coverage period, can accept claims
`expired`	Coverage period ended
`cancelled`	Cancelled (refund or merchant action)
`pending`	Being processed (awaiting order confirmation)
`voided`	Voided due to order cancellation or chargeback