For Whole System Warranty

Headers#

Header	Description	Required
X-SureBright-Access-Token	Access token for authentication	No
Content-Type	application/json	Yes

Country and State Codes#

Country codes (Alpha 2): IBAN Country Codes
US State codes: FIPS State Codes

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 updates that proposal.

When quotes are available, the response includes the warranty plans and sbProposalId. Save this ID to request updated quotes or create a contract.

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.

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.

POSThttps://{HOST_NAME}/quote/api/whole-system/listQuotes

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 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

application/json

json

{
  "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
}

PreviousBy Url Next Overview