Surebright API Documentation

Introduction :

SureBright's API-first solution empowers merchants to offer product protection plans effortlessly. Using our proprietary technology, SureBright oversees all aspects of warranty offerings, from product categorization to contract sales capture, dynamic UI, and end-to-end customer experiences. Our advanced AI solutions significantly reduce integration and operation time and cost by 95%.

This guide will walk you through the steps to quickly integrate SureBright, ensuring you can provide top-notch product protection to your customers in no time.

To display warranty offers to customers, you have two options: the Frontend Widget or the Barebone Quote APIs. Opting for the Frontend Widget means we take care of the UI, ensuring consistency with your website theme. Any future changes, including UI, pricing adjustments, or new product additions, are handled by us, promoting high customer conversions. The pricing can also be made dynamic and controlled by our pricing engine for increased conversions. Alternatively, the Quote APIs provide you with complete control over these aspects. Our recommendation for most merchants is to go with the Frontend Widget. If you're following this recommendation, you only need to review Sections "A" and "B.2".

A. Front-end Widget Kit

This is the easiest way to show warranty offers for your customers at any predefined point in the consumer purchase journey. The specific locations where the warranty offer will be displayed are determined and agreed upon in advance through mutual discussion. We will manage the majority of the front-end development work, making it easy and resource-light for you. Simply follow the steps below:

A.1 Javascript Injection

Add the following script tag to the header of your site to integrate the library into your website:

<script src="https://[SUREBRIGHT_CDN_URL]/path-to-surebright-library.js"></script>

Once the page loads, initialize Surebright library using initialize method (STORE_ID will be shared as part of integration guide):

Surebright.initialize({
    "storeId": "STORE_ID"
}, function onInitialisation(response){
		console.log("Initialization successful", response.storeId);
});

💡

Look for this message in console logs to ensure that Surebright has been successfully initialized

A.2 Get cart item list (Optional)

SureBright maintains the information on the warranty offer that customers choose for any product they purchase. If needed, you can retrieve these details using the getCartItems method from the injected library mentioned above.

Surebright.getCartItems((response)=> {
		console.log(response.cartItems);
})

Response Example:

{
	"cartItems": [
		{
			"productDetails": {
				"productId": 37524367, // Product bought
				"optionId": 74624944,  
				"productTitle": "108\" W Modern Contemporary Fuax Leather 7-Piece Sectional Recliners - 108\"L*108\"W*38\"H", 
				"productPrice": 2044.99, 
				"productThumbnail" : "https://ak1.ostkcdn.com/images/products/is/images/direct/4831ae85de94463b9ba52e8630189824f79519fd/108%22-W-Modern-Contemporary-Fuax-Leather-7-Piece-Sectional-Recliners.jpg", 
				"quantity": 2
			}, 
			"warrantyDetails": {
				"warrantyProductId": 11707083, 
				"warrantyOptionId": 18215331,
				"warrantyPrice": 59.99, // Policy Price 
				"warrantyTitle": "Guardsman Furniture Professionals Elite 5-year Protection Plan", // Policy Title
				"warrantyImage": "https://ak1.ostkcdn.com/images/products/11707083/T18630036.jpg", 
				"warrantyTenure": 5, 
				 
				"warrantyQuantity": 2, 
				"warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3", 
				"warrantyQuoteItemId": "129d1666-2448-3190-9228-8fca2a00a765"
		}
	}]
}

B. Surebright API Collection

B.0 Authentication

The Surebright API employs private API keys for request authentication, placed in the header 'X-Surebright-Access-Token.' You can access and manage your API key through the Surebright Merchant Portal under Account Settings.

Please ensure the security of your API key, as it holds significant privileges. Avoid sharing your secret API keys in public repositories like GitHub or client-side code.

Remember, all API requests must be conducted over HTTPS. Requests made over plain HTTP will fail, and proper authentication is essential for successful API interactions.

Security Scheme Type	API Key
Header parameter name	X-Surebright-Access-Token

Example Sandbox Request:

curl -X GET \
https://{HOST_NAME}/api/v1/quote/listWarrantyQuotes \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Surebright-Access-Token: {sandbox access token}'

📢

storeId, SUREBRIGHT_CDN_URL, X-Surebright-Access-Token and HOST_NAME will be shared as part of Surebright integration kit for both staging and production environment

B.1 Quote API

A Quote API is called to generate warranty quotes based on certain parameters. These quotes are the warranty offers that your consumers will see in their product purchase journey.

💡

In case you decide to go ahead with Surebright Frontend Widgets, Quote API would not be needed

There are two options of Quote APIs.

Generate Quote by Product URL & price: This API is recommended when you want to obtain a warranty offer specific to a product and its price.

Fetch all the warranty offers/quotes for the product category to which Product in the sent URL belongs (w/o Product Price) : Use this API when you want to retrieve all warranty offers for a product category, regardless of the individual product's price. This option can be useful in reducing API calls when dealing with numerous variants of a product.

💡

Pricing option are always generated in the currency corresponding to country of customer location. When quotes are fetched for US, all prices sent as part of request or response would/should be in USD. If quotes are fetched in Canada, all prices sent as part of request or response would/should be in CAD

B.1.1 Generate Quote by Product URL & price:

The details of the request of this API call are as follows:

Method : GET

EndPoint: /api/v1/quote/listWarrantyQuotes

Header:

X-Surebright-Access-Token	Not Required

Query Params:

Param	Description	Data Type	Mandatory	Example
storeId	A unique identifier for a store will be shared as part of the integration kit.	String	Yes	ecca4210-09a4-446c-ad87-5e65bd50df12
country	The country code of the identified customer location.	Alpha 2 Code	Yes	US
state	The state code of the identified customer location.	Alpha code	No	AL \| NY \| WA
productUrl	The URL containing the product page that is shown to the customer.	text.string	Yes	https://www.bedbathandbeyond.com/Home-Garden/Havenside-Home-Chara-5-piece-Teak-Patio-Dining-Set-with-Cushion/29801306/product.html?option=53149571
price	The price of the product in the currency of the country specified in the above parameter.	Decimal	Yes	230.54

📎

Please refer to appendix at end of document for country and state codes.

The details of the response of this API call are as follows:

Field	Description	Data type	Example	Mandatory
warrantyQuoteId	A unique ID representing this specific return quote in this particular API call.	String	929d14dd-2937-4290-9818-8fca2a00a9a3	Yes
warrantyQuoteItemList	A list of warranty offers generated for this particular request. Each quoteItem contains the “warrantyPrice” (float) for a tenure of “warrantyTenure” (integer) and is identified with a unique identifier “warrantyQuoteItemId”.	list	[ { "warrantyTenure": 2, "warrantyPrice": 64.99, "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5" }, { "warrantyTenure": 3, "warrantyPrice": 74.99, "warrantyQuoteItemId": "78adfa49-b058-4ce5-a65b-afa0c504a7de" } ]	Yes
tncLink	Unique link for legal Terms & Conditions of the warranty for each product Category. T&Cs can be hosted by merchants, and in that case, the value of this attribute can be ignored.	String	https://customer.surebright.com/t-c/<encryptedPolicyId>	No
productImageUrl	Link of the product image that can be shown as part of the warranty offer UI.	Url	https://cdn.shopify.com/s/files/1/0254/6227/6182/products/bedbathandimage.jpg	No
coverageWidgetHeading	Heading for the various tenure options shown to a customer	String	Add premium product protection	Yes
coveragePopupHeading	Title that nudges the customers to buy a warranty for their product purchase.	String	Don’t want to spend extra on this product for the next few years? We've got you covered!	Yes
coverageList	List of coverage options grouped under different sections to summarize coverage and why they should buy this warranty plan.	list	[ { "coverageItemType": "COVERAGE_OPTION", "coverageItemTitle": "Your warranty plan provides,", "coverageItemList": [ "Protection against everyday spills (food, beverages, human or pet biological stains, cosmetics, etc) and accidental stains from items like pens and crayons.", "Repairs for burns or heat caused by household items (excluding fire)", "Coverage for punctures and cuts in fabric, microfiber, and leather.", "Repairs for manufacturing defects in non-motorized mechanisms, springs, and wood frames." ] }, { "coverageItemType": "WHY_SUREBRIGHT", "coverageItemTitle": "Why Surebright ? ", "coverageItemList": [ "$0 Deductible", "Cancel anytime", "24x7 Support and quick online claim filing in under 5 minutes" ] } ]	Yes

Request Example:

curl 'https://{HOST_NAME}/api/v1/quote/listWarrantyQuotes?storeId={storeId}&country=US&productUrl={PRODUCT_URL}&price=235.6

Response Example:

Https status code 200 : Quotes found

{
  "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3",
  "warrantyQuoteItemList": [
    {
      "warrantyTenure": 2,
      "warrantyPrice": 64.99,
      "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5"
    },
    {
      "warrantyTenure": 3,
      "warrantyPrice": 74.99,
      "warrantyQuoteItemId": "78adfa49-b058-4ce5-a65b-afa0c504a7de"
    }
  ],
  "tncLink": "https://customer.surebright.com/t-c/c1a8661621492282a574fb3ff19a5bed119c3bcc96bea784675e0fffc93667d37a0a38efa176a69421e7e013186aaadf482bf066434056578fc29f3d6a2bdc2d",
  "productImageUrl": "https://cdn.shopify.com/s/files/1/0254/6227/6182/products/bedbathandimage.jpg?v=1664467971",
  "coveragePopupHeading": "Don’t want to spend extra on this product for the next few years? We've got you covered!",
	"coverageWidgetHeading": "Add premium product protection",
  "coverageList": [
    {
      "coverageItemType": "COVERAGE_OPTION",
      "coverageItemTitle": "Your warranty plan provides,",
      "coverageItemList": [
        "Protection against everyday spills (food, beverages, human or pet biological stains, cosmetics, etc) and accidental stains from items like pens and crayons.",
        "Repairs for burns or heat caused by household items (excluding fire)",
        "Coverage for punctures and cuts in fabric, microfiber, and leather.",
        "Repairs for manufacturing defects in non-motorized mechanisms, springs, and wood frames."
      ]
    },
    {
      "coverageItemType": "WHY_SUREBRIGHT",
      "coverageItemTitle": "Why Surebright ? ",
      "coverageItemList": [
        "$0 Deductible",
        "Cancel anytime",
        "24x7 Support and quick online claim filing in under 5 minutes"
      ]
    }
  ]
}

Https Status Code 501 : Insufficient Params

{
  "isError": true,
  "errorType": 501,
  "errorMessage": "Insufficient Params. Mandatory Params missing"
}

HTTP Status Codes and corresponding Error Types: Following details are for the HTTP Response Codes and how to understand them

501 : Insufficient Params

502 : Validation failed for Input params

503 : Invalid Url

504 : Product not found

505 : No Quotes found

200: Quotes found

500 : Something unexpectedly went wrong

B.1.2 Fetch all the warranty offers/quotes for the product category to which Product in the sent URL belongs:

The details of the request of this API call are as follows:

Method: GET

EndPoint: /api/v1/storeCategory/listCategoryWarrantyQuotes

Header:

X-Surebright-Access-Token	Not Required

Query Params:

Param	Description	Data Type	Mandatory	Example
storeId	A unique identifier for a store will be shared as part of the integration kit.	String	Yes	ecca4210-09a4-446c-ad87-5e65bd50df12
country	The country code of the identified customer location	Alpha 2 Code	Yes	US
state	The state code of the identified customer location	ISO 3166-2	No	AL \| NY \| WA
productUrl	The URL containing the product page that is shown to the customer	text.string	Yes	https://www.bedbathandbeyond.com/Home-Garden/Havenside-Home-Chara-5-piece-Teak-Patio-Dining-Set-with-Cushion/29801306/product.html?option=53149571

📎

Please refer to appendix at end of document for country and state codes.

The details of the response of this API call are as follows:

Field	Description	Data type	Example	Mandatory
warrantyQuoteList	This provides a list of all warranty offers within the product category to which the specific product belongs. The available warranty offers are determined by the product's price range, indicated by the "lowerPrice" and "upperPrice." The warranty quotes for this range are found in the "quoteList," each containing information such as warranty tenure, price, and a unique ID for identification.	list	[ { "lowerPrice": 0, "upperPrice": 499.99, "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3", "warrantyQuoteList": [ { "warrantyQuoteItemId": "121d14dd-2937-4290-8818-8fca2a00a9b1", "warrantyPrice": 64.99, "warrantyTenure": 2 }, { "warrantyTenure": 3, "warrantyQuoteItemId": "646d14dd-2937-4290-8818-8fca2a00a9b1", "warrantyPrice": 84.99 } ] } ]	Yes
tncLink	Unique link for legal Terms & Conditions of the warranty for each productCategoryId. T&Cs can be hosted by merchants, and in that case, the value of this attribute can be ignored.	String	https://customer.surebright.com/t-c/<policyId>	No
productImageUrl	Link of the product image that can be shown as part of the warranty offer UI.	String	https://cdn.shopify.com/s/files/1/0254/6227/6182/products/bedbathandimage.jpg	No
coverageWidgetHeading	Heading for the various tenure options shown to a customer	String	Add premium product protection	Yes
coveragePopupHeading	Title that nudges the customers to buy a warranty for their product purchasd (to be displayed in the coverage list popup)	String	Don’t want to spend extra on this product for the next few years? We've got you covered!	Yes
coverageList	List of coverage options grouped under different sections to summarize coverage and why they should buy this warranty plan.	list	[ { "coverageItemType": "COVERAGE_OPTION", "coverageItemTitle": "Your warranty plan provides,", "coverageItemList": [ "Protection against everyday spills (food, beverages, human or pet biological stains, cosmetics, etc) and accidental stains from items like pens and crayons.", "Repairs for burns or heat caused by household items (excluding fire)", "Coverage for punctures and cuts in fabric, microfiber, and leather.", "Repairs for manufacturing defects in non-motorized mechanisms, springs, and wood frames." ] }, { "coverageItemType": "WHY_SUREBRIGHT”, "coverageItemTitle": "Why Surebright ? ", "coverageItemList": [ "$0 Deductible", "Cancel anytime", "24x7 Support and quick online claim filing in under 5 minutes" ] } ]	Yes

Request Example:

curl 'https://{HOST_NAME}/api/v1/storeCategory/listCategoryWarrantyQuotes?storeId={storeId}&country=US&productUrl={PRODUCT_URL}

Response Example:

Https status code 200 : Quotes found

{
	 "quoteList": [
    {
			"lowerPrice": 0, 
			"upperPrice": 499.99, 
			"warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3",
			"warrantyQuoteList": [{
				"warrantyQuoteItemId": "121d14dd-2937-4290-8818-8fca2a00a9b1",
	      "warrantyPrice": 64.99, 
				"warrantyTenure": 2
	    },{
	      "warrantyTenure": 3,
				"warrantyQuoteItemId": "646d14dd-2937-4290-8818-8fca2a00a9b1",
	      "warrantyPrice": 84.99
	    }
			]
		}, 
    {
			"lowPrice": 500, 
			"upperPrice": 999.99, 
			"warrantyQuoteId": "129d14dd-2937-4290-9818-8fca2a00a9a3",
			"warrantyQuoteList": [{
				"warrantyQuoteItemId": "abcd14dd-2937-4290-8818-8fca2a00a9b1",
	      "warrantyPrice": 74.99, 
				"warrantyTenure": 2,
	    },
			{
	      "warrantyTenure": 3,
				"warrantyQuoteItemId": "343d14dd-2937-4290-8818-8fca2a00a9b1",
	      "warrantyPrice": 94.99
		  }]
		},
  ],
  "tncLink": "https://customer.surebright.com/t-c/c1a8661621492282a574fb3ff19a5bed119c3bcc96bea784675e0fffc93667d37a0a38efa176a69421e7e013186aaadf482bf066434056578fc29f3d6a2bdc2d",
  "productImageUrl": "https://cdn.shopify.com/s/files/1/0254/6227/6182/products/bedbathandimage.jpg?v=1664467971",
  "coveragePopupHeading": "Don’t want to spend extra on this product for the next few years? We've got you covered!",
	"coverageWidgetHeading": "Add premium product protection",
  "coverageList": [
    {
      "coverageItemType": "COVERAGE_OPTION",
      "coverageItemTitle": "Your warranty plan provides,",
      "coverageItemList": [
        "Protection against everyday spills (food, beverages, human or pet biological stains, cosmetics, etc) and accidental stains from items like pens and crayons.",
        "Repairs for burns or heat caused by household items (excluding fire)",
        "Coverage for punctures and cuts in fabric, microfiber, and leather.",
        "Repairs for manufacturing defects in non-motorized mechanisms, springs, and wood frames."
      ]
    },
    {
      "coverageItemType": "WHY_SUREBRIGHT",
      "coverageItemTitle": "Why Surebright ? ",
      "coverageItemList": [
        "$0 Deductible",
        "Cancel anytime",
        "24x7 Support and quick online claim filing in under 5 minutes"
      ]
    }
  ]
}

Https Status Code 501 : Insufficient Params

{
  "isError": true,
  "errorType": 501,
  "errorMessage": "Insufficient Params. Mandatory Params missing"
}

HTTP Status Codes and corresponding Error Types: Following details are for the HTTP Response Codes and how to understand them

501 : Insufficient Params

502 : Validation failed for Input params

503 : Invalid Url

504 : Product not found

505 : No Quotes found

500 : Something unexpectedly went wrong

200 : Quotes Generated

B.2 Order API

This API is utilized to transmit the sold contract data to us, as well as any associated operations such as order cancellations. Use Order API to create, update or cancel an order as described below. API will,

Generate warranty contracts for an order if the “partnerOrderId” does not exist in Surebright's records.

Update existing warranty contract if the “partnerOrderId” is already associated with an order. If a lower "quantity" is provided than what was initially recorded in the original order, the system will automatically cancel the corresponding warranty contracts.

To cancel a specific line item, include the field "isCancelled: true" as part of the lineItem details.

For details on how to use all of the above operations, please refer to in the formation and examples below.

The details of the request of this API call are as follows:

Method: POST

EndPoint: /api/v1/order

Header:

X-Surebright-Access-Token	Required

Body Params:

Param	Description	Data Type	Mandatory	Example
storeId	A unique identifier for a store will be shared as part of the integration kit.	String	Yes	f4c059b2-5b74-4e4c-a3c5-85bc80cf8a09
partnerOrderId	Unique identifier for the complete successful order placed by a customer on the merchant site. This represents the whole order that can have multiple line items of different quantities.	String (Max length : 48)	Yes	83737121380
orderPurchaseDateTime	Date time at which the order was purchased by customer.	ISO Datetime String	Yes	2024-01-07T10:15:30Z
lineItemList	The lineItemList consists of individual line items representing purchased policies. Each line item is uniquely identified by a lineItemId (String: maximum length 48 characters). The warrantyQuoteId and warrantyQuoteItemId serve to identify the specific quote option acquired by the customer. A line item must include warrantyQuoteItemId and warrantyQuoteId. The unitSalePrice and totalPrice indicate the price at which the policy was purchased by the customer. Please refrain from sending a line item in which no policy sales have been made.	List	Yes	[ { "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d", "policyPurchaseDate": " 2024-01-07T10:15:30Z", "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3", "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5", "totalPrice": 99, "warrantyQuantity": 3, "unitSalePrice": 33, “productTitle”: “Nourison Alpha Floral Modern, Indoor/Outdoor Area Rug”, “productId”: “17338270”, “optionId”: “80400330”, “productSKU”: “ALH05” } ]
customerDetails	The customer details that are required to create contracts for any warranty order. Attributes firstName, lastName, addressLine1, city, state, country, zipCode, and customerEmail are mandatory. The attributes mobileNumber and addressLine2 are optional.	Object (State is ISO 3166-2 code, Country code for USA is US)	Yes	{ "firstName": "John", "lastName": "Doe", "addressLine1": "123 Hathway Street", "addressLine2": "", "city": "New York City", "state": "NY", "country": "US", "zipCode": "10005", "customerEmail": "johndoe@gmail.com", "mobileNumber": “7872323781” }

💡

If multiple quantity is bought for a line item (lineItemList[ELEMENT].quantity > 1) , separate contractId would be generated for each unit.

The details of the response of this API call are as follows:

Field	Description	Data type	Example	Mandatory
storeId	A unique identifier for a store will be shared as part of the integration kit.	String	f4c059b2-5b74-4e4c-a3c5-85bc80cf8a09	Yes
partnerOrderId	A unique identifier for the complete successful order placed by a customer on the merchant site. This represents the whole order that can have multiple line items of different quantities.	String (Max length : 48)	83737121380	Yes
contractList	The list of contracts generated for each quantity in each line item. isCancelled indicates if a contract is currently cancelled or not	list	[ { "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d", "contractId": "eb46a2ba-050f-4d40-9105-02ccd497d99e", "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3", "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5", "isCancelled": false } ]	Yes
errorList	A list of errorType and errorMessage if contract creation fails for a line item.	list	[ { "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d", "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3", "warrantyQuoteItemId": "ab78bc1a-0790-4cd3-a3f9-5ed97bbe59f5" "errorType": 504, "errorMessage": "No quotes found" } ]	Yes

HTTP Status Codes and corresponding Error Types: Following details are for the HTTP Response Codes and how to understand them

501 : Insufficient Params

502 : Validation failed for Input params

503 : Product not found

504 : No Quote found

200: Operation is successful

Example 1 : Create Contracts using warrantyQuoteId and warrantyQuoteItemId for each lineItem

Request:

{
  "storeId": "f4c059b2-5b74-4e4c-a3c5-85bc80cf8a09",
  "partnerOrderId": "83737121380",
  "orderPurchaseDate": "2024-01-07T10:15:30Z",
  "lineItemList": [
    {
      "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d",
      "policyPurchaseDate": "2024-01-07T10:15:30Z",
      "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3",
      "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5",
      "totalWarrantyPrice": 99,
      "warrantyQuantity": 3,
      "unitSaleWarrantyPrice": 33, 
			"productTitle": "Nourison Alpha Floral Modern, Indoor/Outdoor Area Rug", 
			"productId": "17338270", 
			"optionId": "80400330", 
			"productSKU": "ALH05"
    }
  ],
  "customerDetails": {
    "firstName": "John",
    "lastName": "Doe",
    "addressLine1": "123 Hathway Street",
    "addressLine2": "",
    "city": "New York City",
    "state": "NY",
    "country": "US",
    "zipCode": "10005",
    "customerEmail": "johndoe@gmail.com",
    "mobileNumber": “7872323781”
  }
}

Response:

HTTP Status Code: 200

{
  "storeId": "f4c059b2-5b74-4e4c-a3c5-85bc80cf8a09",
  "partnerOrderId": "83737121380",
  "contractList": [
    {
      "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d",
      "contractId": "eb46a2ba-050f-4d40-9105-02ccd497d99e",
      "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3",
      "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5", 
		  "isCancelled": false
    }, 
    {
      "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d",
      "contractId": "ab46a2ba-050f-4d40-9105-02ccd497d99e",
      "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3",
      "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5", 
		  "isCancelled": false
    }, 
    {
      "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d",
      "contractId": "cd46a2ba-050f-4d40-9105-02ccd497d99e",
      "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3",
      "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5", 
		  "isCancelled": false
    }
  ],
  "errorList": [
    {
      "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d",
      "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3",
      "warrantyQuoteItemId": "1278bc1a-0790-4cd3-a3f9-5ed97bbe59f5"
      "errorType": 504,
      "errorMessage": "No quotes found"
    }
  ]
}

Example 2: Cancel a line item

💡

If a contract has been cancelled, it cannot be marked as active again

Request:

{
  "storeId": "f4c059b2-5b74-4e4c-a3c5-85bc80cf8a09",
  "partnerOrderId": "83737121380",
  "orderPurchaseDate": "2024-01-07T10:15:30Z",
  "lineItemList": [
    {
      "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d",
      "policyPurchaseDate": "2024-01-07T10:15:30Z",
      "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3",
      "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5",
      "totalWarrantyPrice": 99,
      "warrantyQuantity": 3,
      "unitWarrantySalePrice": 33, 
			"productTitle": "Nourison Alpha Floral Modern, Indoor/Outdoor Area Rug", 
			"productId": "17338270", 
			"optionId": "80400330", 
			"productSKU": "ALH05", 
      "isCancelled": true
    }
  ],
  "customerDetails": {
    "firstName": "John",
    "lastName": "Doe",
    "addressLine1": "123 Hathway Street",
    "addressLine2": "",
    "city": "New York City",
    "state": "NY",
    "country": "US",
    "zipCode": "10005",
    "customerEmail": "johndoe@gmail.com",
    "mobileNumber": “7872323781”
  }
}

Response:

{
  "storeId": "f4c059b2-5b74-4e4c-a3c5-85bc80cf8a09",
  "partnerOrderId": "83737121380",
  "contractList": [
    {
      "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d",
      "contractId": "eb46a2ba-050f-4d40-9105-02ccd497d99e",
			"warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3",
      "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5",
		  "isCancelled": true
    }, 
    {
      "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d",
      "contractId": "ab46a2ba-050f-4d40-9105-02ccd497d99e",
      "warrantyQuoteId": "929d14dd-2937-4290-9818-8fca2a00a9a3",
      "warrantyQuoteItemId": "8c78bc1a-0790-4cd3-a3f9-5ed97bbe59f5", 
		  "isCancelled": true
    }, 
    {
      "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d",
      "contractId": "cd46a2ba-050f-4d40-9105-02ccd497d99e",
      "warrantyQuoteId": "129d14dd-2937-4290-9818-8fca2a00a9a3",
      "warrantyQuoteItemId": "3478bc1a-0790-4cd3-a3f9-5ed97bbe59f5", 
		  "isCancelled": true
    }
  ],
  "errorList": [
    
  ]
}

Appendix

Alpha 2 Code for Country : https://www.iban.com/country-codes.

Alpha code for US states : https://en.wikipedia.org/wiki/Federal_Information_Processing_Standard_state_code