By Url

This endpoint fetches all warranty quotes for the product category to which product in the sent URL belongs.

GET /api/v1/quote/listWarrantyQuotes?storeId={storeId}&country={country}&productUrl={PRODUCT_URL}

Try it

List Quotes by URL

cURL

curl --request GET \
  --url 'https://{HOST_NAME}/api/v1/quote/listWarrantyQuotes?storeId={storeId}&country={country}&productUrl={PRODUCT_URL}'

200

{
  "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3",
  "warrantyQuoteItemList": [
    {
      "warrantyTenure": 2,
      "warrantyPrice": 64.99,
      "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5"
    }
  ],
  "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": [
        "Protection against everyday spills (food, beverages, human or pet biological stains, cosmetics, etc)."
      ]
    }
  ],
  "lowerPrice": 0,
  "upperPrice": 499.99,
  "tncLink": "https://customer.surebright.com/t-c/098e0e696f20839479dfe4a2804756233d32130f068441e24c6c0dbbc790677ff9718e04396a18dac753d0cf92bcaf63a26d2b666e5326475d0b2ed7475ad7fc",
  "productImageURL": "<https://cdn.shopify.com/s/files/1/0254/6227/6182/products/bedbathandimage.jpg?v=1664467971>"
}

Headers

Header	Description	Required
X-SureBright-Access-Token	Access token for authentication	No

Country and State Codes

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

Query Parameters

storeId · string · required

A unique identifier for a store will be shared as part of the integration kit.

Example:

"ecca4210-09a4-446c-ad87-5e65bd50df12"

country · string · required

The country code of the identified customer location

Example:

"US"

state · string

The state code of the identified customer location

Example:

"AL"

productUrl · string · required

Base64 encoded URL containing the product page that is shown to the customer

Example:

"aHR0cHM6Ly93d3cubWVkaWNhbGVzaG9wLmNvbS9xdWlja2llLXE1MC1yLWNhcmJvbi1mb2xkaW5nLXBvd2VyLXdoZWVsY2hhaXI="

Response

200

application/json

Quotes Found

warrantyQuoteId · string · required

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

Example:

"929d14dd-2937-4290-9818-8fca2a00a9a3"

warrantyQuoteItemList · object[] · required

A list of warranty offers generated for this particular request

Show child attributes

warrantyQuoteItemList. warrantyTenure · integer

Duration of the warranty in years

Example:

2

warrantyQuoteItemList. warrantyPrice · number<float>

Price of the warranty

Example:

64.99

warrantyQuoteItemList. warrantyQuoteItemId · string

Unique identifier for the warranty quote item

Example:

"8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5"

coverageWidgetHeading · string · required

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

Example:

"Add premium product protection"

coveragePopupHeading · string · required

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[] · required

List of coverage options grouped under different sections

Show child attributes

coverageList. coverageItemType · enum<string>

Available options: COVERAGE_OPTION, WHY_SUREBRIGHT

Example:

"COVERAGE_OPTION"

coverageList. coverageItemTitle · string

Example:

"Your warranty plan provides,"

coverageList. coverageItemList · string[]

Example:

[
  "Protection against everyday spills (food, beverages, human or pet biological stains, cosmetics, etc)."
]

lowerPrice · number<float>

Example:

0

upperPrice · number<float>

Example:

499.99

tncLink · string

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

Example:

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

productImageURL · string

Link of the product image that can be show as part of the warranty offer UI

Example:

"<https://cdn.shopify.com/s/files/1/0254/6227/6182/products/bedbathandimage.jpg?v=1664467971>"