For all price bands of a category

Retrieves a list of warranty quotes for all price bands based on Category. The response includes price bands details and warranty quotes details.

GET /quote/api/quote/category/listQuotes?payload={payload}

Try it

List Categories

cURL

curl --request GET \
  --url 'https://{HOST_NAME}/quote/api/quote/category/listQuotes?payload={payload}'

200

{
  "storeCategoryId": "ecca4210-09a4-446c-ad87-5e65bd50df12",
  "sbCategoryId": "4c3103e4-38dc-4171-96e5-b4b77ab0e96f",
  "country": "US",
  "platform": "SHOPIFY",
  "sbProductId": "643bc477-0eec-4da1-946a-38ff7d1292c9",
  "storeParentId": "ecca4210-09a4-446c-ad87-5e65bd50df12",
  "allowDynamicPolicyPricing": true,
  "platformOrderDetails": null,
  "quoteId": "33f21a29-95ca-4150-b5df-afe36f5ef537",
  "quoteItemList": [
    {
      "quoteId": "33f21a29-95ca-4150-b5df-afe36f5ef537",
      "quoteItemId": "33f21a29-95ca-4150-b5df-afe36f5ef537",
      "lowerPrice": 749.99,
      "upperPrice": 999.99,
      "coverageYears": "1",
      "policyPrice": "79",
      "storeProductVariantPrice": "899.99",
      "country": "US",
      "isActive": true
    }
  ],
  "coverageType": "AD",
  "coverageList": [
    {
      "coverageItemType": "COVERAGE_OPTION",
      "coverageItemTitle": "Your warranty plan provides",
      "coverageItemList": [
        "Protection against everyday spills (food, beverages, human or pet biological stains, cosmetics, etc)."
      ]
    }
  ],
  "policyId": "1234567890",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

Note

The payload parameter must be sent as a Base64-encoded query string for secure transmission.

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

payload · string · required

A Base64-encoded query string used for secure transmission. It includes the storeParentId, country, province, visitId, storeCategoryList, and platform details.

Example: Original JSON payload before Base64 encoding

{
  "storeParentId": "13612f29-8ec5-49ad-bab1-5ab09b51367e",
  "country": "US",
  "province": "",
  "visitId": "3d99a4ae-5cf0-4d87-8436-46c0cdc03676",
  "storeCategoryList": [
    {
      "storeCategoryId": "07b1dcb3-fbe5-46c6-b42f-66d82e89f2a7",
      "sbCategoryId": "290f8a04-0464-4140-904b-8fa33df9cbd9",
      "sbProductId": "643bc477-0eec-4da1-946a-38ff7d1292c9",
      "active": true
    }
  ],
  "platform": "POST_PURCHASE"
}

Example:

"ewogICJzdG9yZVBhcmVudElkIjogIjEzNjEyZjI5LThlYzUtNDlhZC1iYWIxLTVhYjA5YjUxMzY3ZSIsCiAgImNvdW50cnkiOiAiVVMiLAogICJwcm92aW5jZSI6ICIiLAogICJ2aXNpdElkIjogIjNkOTlhNGFlLTVjZjAtNGQ4Ny04NDM2LTQ2YzBjZGMwMzY3NiIsCiAgInN0b3JlQ2F0ZWdvcnlMaXN0IjogWwogICAgewogICAgICAic3RvcmVDYXRlZ29yeUlkIjogIjA3YjFkY2IzLWZiZTUtNDZjNi1iNDJmLTY2ZDgyZTg5ZjJhNyIsCiAgICAgICJzYkNhdGVnb3J5SWQiOiAiMjkwZjhhMDQtMDQ2NC00MTQwLTkwNGItOGZhMzNkZjljYmQ5IiwKICAgICAgInNiUHJvZHVjdElkIjogIjY0M2JjNDc3LTBlZWMtNGRhMS05NDZhLTM4ZmY3ZDEyOTJjOSIsCiAgICAgICJhY3RpdmUiOiB0cnVlCiAgICB9CiAgXSwKICAicGxhdGZvcm0iOiAiUE9TVF9QVVJDSEFTRSIKfQ%27"

storeId · string · required

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

Example:

"[e-mail]"

platform · string · required

The platform of the merchant's store

Example:

"POST_PURCHASE"

storeParentId · string · required

Unique identifier for the store parent

Example:

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

storeCategoryList · object[] · required

An array containing store category details used for identifying product categories within a store. Each object represents a category and includes IDs and status.

Show child attributes

storeCategoryList. storeCategoryId · string

Unique identifier for the store category

Example:

"07b1dcb3-fbe5-46c6-b42f-66d82e89f2a7"

storeCategoryList. sbCategoryId · string

Unique identifier for the SureBright category

Example:

"290f8a04-0464-4140-904b-8fa33df9cbd9"

storeCategoryList. sbProductId · string

Unique identifier for the product

Example:

"643bc477-0eec-4da1-946a-38ff7d1292c9"

storeCategoryList. active · boolean

Example:

true

Example:

{
  "storeCategoryList": [
    {
      "storeCategoryId": "07b1dcb3-fbe5-46c6-b42f-66d82e89f2a7",
      "sbCategoryId": "290f8a04-0464-4140-904b-8fa33df9cbd9",
      "sbProductId": "643bc477-0eec-4da1-946a-38ff7d1292c9",
      "active": true
    }
  ]
}

country · string · required

The country code of the identified customer location

Example:

"US"

visitId · string · required

Unique identifier of the visitor

Example:

"33f21a29-95ca-4150-b5df-afe36f5ef537"

province · string

The province code corresponding to the customer’s location — relevant only for Canada stores.

Response

200

application/json

Successful response

storeCategoryId · string

A unique identifier for a store category

Example:

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

sbCategoryId · string

Unique identifier for the surebright category

Example:

"4c3103e4-38dc-4171-96e5-b4b77ab0e96f"

country · string

The country code of the identified customer location

Example:

"US"

platform · string

The platform of the merchant's store

Example:

"SHOPIFY"

sbProductId · string

Unique identifier for the product

Example:

"643bc477-0eec-4da1-946a-38ff7d1292c9"

storeParentId · string

Unique identifier for the store

Example:

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

allowDynamicPolicyPricing · boolean

Indicates if dynamic policy pricing is allowed

Example:

true

platformOrderDetails · object

The platform order details

Example:

null

quoteId · string

Unique identifier for the quote

Example:

"33f21a29-95ca-4150-b5df-afe36f5ef537"

quoteItemList · object[]

A list of quote item details

Show child attributes

quoteItemList. quoteId · string

Unique identifier for the quote

Example:

"33f21a29-95ca-4150-b5df-afe36f5ef537"

quoteItemList. quoteItemId · string

Unique identifier for the quote item

Example:

"33f21a29-95ca-4150-b5df-afe36f5ef537"

quoteItemList. lowerPrice · number

The lower price of the quote item

Example:

749.99

quoteItemList. upperPrice · number

The upper price of the quote item

Example:

999.99

quoteItemList. coverageYears · string

The number of years of coverage in years

Example:

"1"

quoteItemList. policyPrice · string

The price of the policy product

Example:

"79"

quoteItemList. storeProductVariantPrice · string

The price of the product variant

Example:

"899.99"

quoteItemList. country · string

The country code of the identified customer location

Example:

"US"

quoteItemList. isActive · boolean

Indicates if the quote item is active

Example:

true

coverageType · string

Represents the type of policy coverage associated with a product

Example:

"AD"

coverageList · object[]

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)."
]

policyId · string

Unique identifier for the policy

Example:

"1234567890"

createdAt · string

The date and time the quote was created

Example:

"2021-01-01T00:00:00Z"

updatedAt · string

The date and time the quote was updated

Example:

"2021-01-01T00:00:00Z"