For Whole System Warranty
This endpoint generates warranty quotes for a whole system order. Provide your store, product line items, and installer warranty duration to receive available warranty plans, prices, product coverage details, and terms and conditions. When quotes are available, SureBright saves them and your product details as a proposal that you can update or use to create a contract.
For the whole flow, from the first quote to a cancelled plan, read the Whole System Warranty guide.
Headers#
Country#
This endpoint prices plans for the United States only. The request carries no country or state field. If your account has no United States Whole System Warranty set up, the call returns 512. If you sell in Canada, ask your SureBright contact.
Request fields#
Each lineItemList entry:
Installer warranty duration#
Requesting Quotes#
Send storeId, lineItemList, and installerWarrantyDuration to request warranty quotes for your products. Leave sbProposalId out of the initial request.
You can include a new partnerProposalId to associate the proposal with an ID from your system. Reusing an existing ID on the same storeId updates that proposal, so never use one reference for two different jobs.
When quotes are available, the response includes the warranty plans and sbProposalId. Save this ID to request updated quotes or create a contract.
How line items are priced#
Each line is assessed for eligibility, and only eligible lines are priced.
If no line is covered the call returns 516. If the covered lines add up to zero it returns 515. There is no separate line type for installation labour on this endpoint: a labour line is assessed like any other line, so read its isCovered value.
Updating Quotes for an Existing Proposal#
Include sbProposalId or partnerProposalId with your current line items and installer warranty duration to request updated quotes for the same proposal. If you provide both, they must refer to the same proposal. A conflicting partnerProposalId returns HTTP 409 with code PROPOSAL_ID_MISMATCH.
Quotes are recalculated using the submitted product details and current pricing and coverage. If the products, classification, installer warranty duration, pricing, and coverage are unchanged, the existing quote and plan IDs are returned. If these details change, the proposal and its quotes are updated, and the IDs from the earlier quote for that installer warranty duration can no longer be used to create a contract.
A proposal keeps one quote per installer warranty duration. Quoting the same proposal with a different duration adds a quote for that duration and leaves the others in place. The warrantyQuoteId you send when you create the contract decides which one applies.
Once a platform has created a contract for a connected installer from a proposal, re-quote that proposal with sbProposalId. A request that carries only partnerProposalId does not find it and starts a new proposal.
To create or update a contract, submit sbProposalId, warrantyQuoteId, and the selected warrantyQuoteItemId to the Create / Update Contracts for Whole System Warranty endpoint. Use the quote and plan IDs from the same response. Updating quotes does not automatically update an existing contract.
Backward compatibility: The response also includes sbSalesLeadId with the same value as sbProposalId. Existing integrations can use it to request updated quotes or create and update contracts. Leave it out of the initial quote request. If you provide both sbProposalId and sbSalesLeadId, their values must match; otherwise, this quote endpoint returns HTTP 409 with code SB_PROPOSAL_ID_MISMATCH. Any supplied partnerProposalId must refer to the same proposal. For new integrations, use sbProposalId.
Errors#
Error bodies are {"isError": true, "message": "..."}. They carry no errorType field. A code is added on the rows that show one; on the 403, 404, 409 and 502 rows it is present when the request carried sbProposalId or sbSalesLeadId.
Requests that carry partnerId can also return:
511 to 516 are application codes on this endpoint, not gateway errors. Read the message before you retry: only 500, 502 and 503 are worth retrying unchanged.
Related#
https://api.surebright.com/quote/api/whole-system/listQuotesThis endpoint generates warranty quotes for a whole system order. Provide your store, product line items, and installer warranty duration to receive available warranty plans, prices, product coverage details, and terms and conditions. When quotes are available, SureBright saves them and your product details as a proposal that you can update or use to create a contract. For an initial quote request, omit sbProposalId. You can include a new partnerProposalId to associate the proposal with an ID from your system. Save the returned sbProposalId for updated quotes and contract creation. To update quotes for an existing proposal, include sbProposalId or partnerProposalId with your current line items and installer warranty duration. Any supplied partnerProposalId must refer to the same proposal. Quotes are recalculated using the submitted details and current pricing and coverage. Unchanged products, classification, installer warranty duration, pricing, and coverage retain the existing quote and plan IDs; changed details update the proposal and its quotes. Use the quote and plan IDs from the same response when creating or updating a contract. Updating quotes does not automatically update an existing contract.
Backward compatibility: Existing integrations can use sbSalesLeadId to request updated quotes or create and update contracts. It has the same value as sbProposalId in the response. Omit it from the initial quote request. If both identifiers are supplied, their values must match; otherwise, the quote endpoint returns HTTP 409 with code SB_PROPOSAL_ID_MISMATCH. Any supplied partnerProposalId must refer to the same proposal. For new integrations, use sbProposalId.
Body
{
"storeId": "test-store-id",
"partnerProposalId": "9f3e21c6-6bdb-4c7f-9b91-2a4f9a2c7d11",
"lineItemList": [
{
"title": "PMC Prophecy5 2-Way Floorstanding Speaker (Pair)",
"unitPrice": 6500,
"categoryTag": "Speaker Floorstanding",
"quantity": 1,
"description": "High-performance floorstanding speaker pair for immersive audio systems."
}
],
"installerWarrantyDuration": 3
}