SureBright

By Category

Note#

All quote inputs go inside the payload JSON, which is sent Base64-encoded (UTF-8) as a query parameter. Send quoteSyncMode=SYNC when you will record an order with the returned quoteId and quoteItemId.

Headers#

No authentication header is needed for this endpoint.

Country and State Codes#

GEThttps://{HOST_NAME}/quote/api/quote/category/listQuotes

Lists warranty quote options for one or more products, by category and product price. Each quoteItemList entry carries a quoteId and quoteItemId; send these in planDetails when recording the order.

Query parameters

payloadstringrequired

Base64-encoded (UTF-8) JSON object. All quote inputs go inside this object, not as separate query parameters.

| Field | Type | Required | Description |
|---|---|---|---|
| country | string | Yes | Alpha-2 country code of the customer, e.g. US |
| visitId | string | Yes | Any unique identifier for the shopper session |
| platform | string | Yes | Calling platform, e.g. OFFLINE_PORTAL |
| storeParentId | string | Yes, unless storeId is sent | Unique identifier for the store parent. Required when quoting by sbCategoryId |
| storeId | string | Yes, unless storeParentId is sent | A unique identifier for a store |
| province | string | No | State or province code of the customer |
| storeCategoryList | array | Yes | One entry per product to quote. Must not be empty |
| storeCategoryList[].sbCategoryId | string | sbCategoryId or storeCategoryId | SureBright category ID from List Categories |
| storeCategoryList[].storeCategoryId | string | sbCategoryId or storeCategoryId | Store category ID from List Categories |
| storeCategoryList[].productPrice | number | Yes | Price of the product being protected |
| storeCategoryList[].sbProductId | string | No | SureBright product ID |
| storeCategoryList[].manufacturerWarrantyDuration | integer | No | Manufacturer warranty, in months |

Example: JSON before Base64 encoding

json
{
  "storeParentId": "13612f29-8ec5-49ad-bab1-5ab09b51367e",
  "country": "US",
  "visitId": "3d99a4ae-5cf0-4d87-8436-46c0cdc03676",
  "platform": "OFFLINE_PORTAL",
  "storeCategoryList": [
    {
      "sbCategoryId": "4c3103e4-38dc-4171-96e5-b4b77ab0e96f",
      "productPrice": 199.99
    }
  ]
}
Example
eyJzdG9yZVBhcmVudElkIjoiMTM2MTJmMjktOGVjNS00OWFkLWJhYjEtNWFiMDliNTEzNjdlIiwiY291bnRyeSI6IlVTIiwidmlzaXRJZCI6IjNkOTlhNGFlLTVjZjAtNGQ4Ny04NDM2LTQ2YzBjZGMwMzY3NiIsInBsYXRmb3JtIjoiT0ZGTElORV9QT1JUQUwiLCJzdG9yZUNhdGVnb3J5TGlzdCI6W3sic2JDYXRlZ29yeUlkIjoiNGMzMTAzZTQtMzhkYy00MTcxLTk2ZTUtYjRiNzdhYjBlOTZmIiwicHJvZHVjdFByaWNlIjoxOTkuOTl9XX0=
quoteSyncModestring

Send SYNC to save the quote before the response returns, so its quoteId and quoteItemId can be used to record an order straight away.

Example: SYNC
PreviousOverviewNext By Product