For Whole System Warranty

This endpoint generates warranty quotes for an entire system order. Provide store, proposal, and detailed line item information along with the installer warranty duration. The API returns available warranty offers, product coverage details, and a link to specific terms and conditions for the quoted products.

POST /api/v1/quote/whole-system/quote

Try it

List Quotes for Whole System Warranty

cURL

curl --request POST \
  --url https://{HOST_NAME}/api/v1/quote/whole-system/quote \
  --header 'Content-Type: application/json' \
  --header 'X-SureBright-Access-Token: <x-surebright-access-token>' \
  --data '
{
  "storeId": "test-store-id",
  "platform": "Dtools",
  "lineItemList": [
    {
      "title": "PMC Prophecy5 2-Way Floorstanding Speaker (Pair)",
      "unitPrice": 6500,
      "quantity": 1,
      "categoryTag": "Speaker Floorstanding",
      "description": "High-performance floorstanding speaker pair for immersive audio systems."
    }
  ],
  "installerWarrantyDuration": 3,
  "proposalId": "9f3e21c6-6bdb-4c7f-9b91-2a4f9a2c7d11"
}
'

200

{
  "warrantyQuoteId": "36eaa6e3-ca1f-4bc1-86da-76caf7a7114d",
  "totalCoveredAmount": 6500,
  "tncLink": "https://customer.surebright.com/t-c/098e0e696f20839479dfe4a2804756233d32130f068441e24c6c0dbbc790677f71879502aee2ce87e116739d4dae3332",
  "warrantyQuoteItemList": [
    {
      "warrantyQuoteItemId": "a7defcbd-aa07-4e01-9076-c1935af20a98",
      "coverageYears": 2,
      "quotePrice": 40
    }
  ],
  "coverageWidgetHeading": "Add premium product protection",
  "coveragePopupHeading": "Don't want to spend extra on this product for the next few years? We've got you covered!",
  "coverageList": [
    {
      "coverageItemType": "COVERAGE_OPTION",
      "coverageItemTitle": "Your warranty plan provides,",
      "coverageItemList": [
        "Comprehensive coverage for mechanical or electrical breakdowns and even power surges",
        "100% coverage for repairs for extended years that also includes labor and not just parts",
        "Coverage for inevitable wear and tear affecting the product's functionality after years of usage",
        "Replacement or reimbursement, if we can't repair it"
      ]
    }
  ],
  "lineItemList": [
    {
      "title": "PMC Prophecy5 2-Way Floorstanding Speaker (Pair)",
      "unitPrice": 6500,
      "isCovered": true,
      "sbCategoryName": "Speaker Floorstanding",
      "quantity": 1,
      "description": "High-performance floorstanding speaker pair for immersive audio systems."
    }
  ]
}

Headers

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

Country and State Codes

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

Headers

X-SureBright-Access-Token · string · required

Access token for authentication

Body

application/json

storeId · string · required

A unique identifier for the store

Example:

"test-store-id"

platform · string · required

The platform identifier for the store

Example:

"Dtools"

lineItemList · object[] · required

A list of line items representing the products in the order

Show child attributes

lineItemList. title · string · required

The title or name of the product

Example:

"PMC Prophecy5 2-Way Floorstanding Speaker (Pair)"

lineItemList. unitPrice · number<float> · required

The unit price of the product purchased

Example:

6500

lineItemList. quantity · integer · required

The quantity of the product purchased

Example:

1

lineItemList. categoryTag · string

The category tag for the product

Example:

"Speaker Floorstanding"

lineItemList. description · string

The description of the product

Example:

"High-performance floorstanding speaker pair for immersive audio systems."

installerWarrantyDuration · integer · required

The duration of the installer warranty in months

Example:

3

proposalId · string

A unique identifier for the proposal

Example:

"9f3e21c6-6bdb-4c7f-9b91-2a4f9a2c7d11"

Response

200

application/json

Quotes Found

warrantyQuoteId · string

A unique ID representing this specific return quote in this particular API call

Example:

"36eaa6e3-ca1f-4bc1-86da-76caf7a7114d"

totalCoveredAmount · number<float>

Total covered amount for the product purchased

Example:

6500

tncLink · string

Unique link for legal Terms & Conditions of the warranty for each product Category

Example:

"https://customer.surebright.com/t-c/098e0e696f20839479dfe4a2804756233d32130f068441e24c6c0dbbc790677f71879502aee2ce87e116739d4dae3332"

warrantyQuoteItemList · object[]

A list of warranty offers generated for this particular request

Show child attributes

warrantyQuoteItemList. warrantyQuoteItemId · string

Unique identifier for the warranty quote item

Example:

"a7defcbd-aa07-4e01-9076-c1935af20a98"

warrantyQuoteItemList. coverageYears · integer

Duration of the warranty in years

Example:

2

warrantyQuoteItemList. quotePrice · number<float>

Price of the warranty quote

Example:

40

coverageWidgetHeading · string

Heading for the various tenure options shown to a customer on the product page

Example:

"Add premium product protection"

coveragePopupHeading · string

Title that nudges the customers to buy a warranty for their product purchase

Example:

"Don't want to spend extra on this product for the next few years? We've got you covered!"

coverageList · object[]

List of coverage options grouped under different sections

Show child attributes

coverageList. coverageItemType · enum<string>

Available options: COVERAGE_OPTION, WHY_SUREBRIGHT_OPTION

Example:

"COVERAGE_OPTION"

coverageList. coverageItemTitle · string

Example:

"Your warranty plan provides,"

coverageList. coverageItemList · string[]

Example:

[
  "Comprehensive coverage for mechanical or electrical breakdowns and even power surges",
  "100% coverage for repairs for extended years that also includes labor and not just parts",
  "Coverage for inevitable wear and tear affecting the product's functionality after years of usage",
  "Replacement or reimbursement, if we can't repair it"
]

lineItemList · object[]

A list of line items with full product information and coverage status

Show child attributes

lineItemList. title · string

The title or name of the product

Example:

"PMC Prophecy5 2-Way Floorstanding Speaker (Pair)"

lineItemList. unitPrice · number<float>

The unit price of the product purchased

Example:

6500

lineItemList. isCovered · boolean

Indicates whether the line item is covered by the warranty

Example:

true

lineItemList. sbCategoryName · string

The SureBright category name for the product

Example:

"Speaker Floorstanding"

lineItemList. quantity · integer

The quantity of the product purchased

Example:

1

lineItemList. description · string

The description of the product

Example:

"High-performance floorstanding speaker pair for immersive audio systems."