System warranty quotes by account

Price a whole-system plan from a list of priced line items or a total, without saving a proposal.

POST https://{HOST_NAME}/quote/api/quote/systemwarranty/listQuotes

This endpoint prices a whole-system plan for an installed system from the line items (or just the total) and the installer's own warranty term. Unlike For Whole System Warranty, it is keyed on your SureBright account rather than a store, and it does not save a proposal or return proposal ids, so its quotes cannot be turned into a contract.

New integrations should use For Whole System Warranty (POST /quote/api/whole-system/listQuotes), which saves the quote as a proposal you can update and convert into a contract. This endpoint backs the pricing shown in the installer portal, where installers quote and record Whole System Warranty sales. It is not used by the Merchant Portal. For the API flow, read the Whole System Warranty guide.

Headers#

HeaderDescriptionRequired
Content-Typeapplication/jsonYes

No authentication header is needed for this endpoint.

Query parameters#

string

SYNC to save the quote before responding. Default ASYNC.

Body#

objectrequired
object[]

The system's components. Required unless totalPrice is sent. Only items with an sbCategoryId, a unit price above zero and a quantity above zero count towards the total. SureBright also leaves out an item whose unit price is above the limit it sets; ask your SureBright contact if an item you expected is not counted.

number

Total system price, used when lineItemsList is not sent.

numberrequired

The installer's own warranty on the system, in months. Priced terms are 3, 6 and 12. Other values round down to the nearest priced term; values below 3 return 513.

Example request#

bash
curl -X POST 'https://{HOST_NAME}/quote/api/quote/systemwarranty/listQuotes' \
  -H 'Content-Type: application/json' \
  -d '{
    "storeInfo": { "storeParentId": "0f6c1d2e-7a8b-4c9d-8e1f-2a3b4c5d6e7f", "currency": "USD" },
    "lineItemsList": [
      { "sbCategoryId": "2b7e4f10-9c3a-4d5e-8f61-7a2b3c4d5e6f", "productPrice": 4200, "quantity": 1 },
      { "sbCategoryId": "2b7e4f10-9c3a-4d5e-8f61-7a2b3c4d5e6f", "productPrice": 650, "quantity": 2 }
    ],
    "installerWarrantyDuration": 12
  }'

Response#

quoteListobject[]

One standard quote object (see By Category) priced on the system total. PolicyData carries one entry per plan term with quoteId, quoteItemId, price, coverageYears and deductibleAmount.

sbCategoryIdstring

The system-warranty category the quote was priced against.

Errors#

CodeBodyMeaning
400{"isError": true, "message": "Request body is required"}Empty body
400{"isError": true, "message": "Missing required fields in payload"}storeInfo missing, or neither lineItemsList nor totalPrice
400{"isError": true, "message": "Missing required store or customer information"}storeParentId or currency missing
400{"isError": true, "message": "installerWarrantyDuration is required"}Duration missing
400{"isError": true, "message": "Invalid total price"}The counted items add up to zero
400{"isError": true, "message": "Store parent not found"} or a message that the account has no system-warranty program for this currencyThe account is not set up for system warranty in that country
513{"isError": true, "message": "No Quote Found"}installerWarrantyDuration below 3
500{"isError": true, "errorType": 500, "errorMessage": "Something unexpectedly went wrong"}Unexpected failure