# SureBright Documentation

## Docs

- [Authentication](https://docs.surebright.com/api-reference/authentication.md): Learn how to authenticate your requests to the SureBright API
- [Cancel Contracts for Whole System Warranty](https://docs.surebright.com/api-reference/endpoint/order/cancel-contract-whole-system-warranty.md): This endpoint cancels an existing warranty contract for a whole system order. Provide the contract ID obtained from the Create Contracts for Whole System Warranty endpoint. The API returns the cancellation status of the warranty contract.
- [Create Contracts for Order](https://docs.surebright.com/api-reference/endpoint/order/create-contract.md): This endpoint is used to create warranty contracts for a specific order. 🛠️ **Contract Creation Logic** Warranty contracts are created in a 1:1 ratio with the quantity of the associated product purchased. The warranty quantity is automatically inferred from the product quantity. Contracts are only created for the exact number of products purchased—warranty coverage cannot exceed or fall short of the product quantity. 🏷️ **Using policySKU** The `policySKU` is a required field that determines the parameters of each warranty contract, including: - Coverage Type (e.g., accidental damage, mechanical breakdown) - Tenure (duration of coverage) - Country (to apply relevant terms and conditions) - Category (product type classification) Merchants must ensure that the appropriate `policySKU` is used for each product to ensure accurate coverage assignment. 🔁 **Handling Updates** If this endpoint is called for an order where contracts already exist: - Existing contracts will be updated if the quantity or details have changed. - Warranty price, tenure, and coverage type are handled automatically based on the provided `policySKU`.
- [Create / Update Contracts for Whole System Warranty](https://docs.surebright.com/api-reference/endpoint/order/create-contract-whole-system-warranty.md): This endpoint creates or updates a warranty contract for a whole system order. Line items, total covered amount, and warranty duration are derived from the sales lead identified by `sbSalesLeadId`. Provide the warranty quote details and customer information; the API returns the contract ID. If a contract already exists for the given sales lead, the existing contract is updated instead of creating a new one.
- [Overview](https://docs.surebright.com/api-reference/endpoint/order/index.md)
- [Cancel / Update contracts for Order](https://docs.surebright.com/api-reference/endpoint/order/update-contract.md): This endpoint is used to create, update, or cancel warranty contracts for a specific order. 🔄 **Updating Line Item Quantities** If the quantity of a product in the original order is changed (e.g., reduced), the corresponding warranty contract quantity is automatically adjusted to match the updated product quantity. To reduce or cancel warranty coverage for a line item, update the `quantity` field inside the relevant `lineItem` object in the `orderLineItemList`. ❌ **Cancelling Line Items** To cancel warranty coverage for a specific line item, set its `quantity` to 0 in the `orderLineItemList`. Once cancelled, a warranty contract cannot be reactivated. This applies to both partial cancellations (some items in the order) and full order cancellations. 🧾 **Handling Full Order Cancellation** For full order cancellations, merchants have two options: - Remove the `planDetails` object entirely from the request payload. - Set the `quantity` of each relevant `lineItem` in `orderLineItemList` to 0. ⚙️ **Automatic Price and Tenure Updates** Any changes to warranty price or tenure (e.g., due to product updates or plan revisions) are handled automatically by the system.
- [Overview](https://docs.surebright.com/api-reference/endpoint/quote/index.md)
- [By Category](https://docs.surebright.com/api-reference/endpoint/quote/list-warranty-quotes-by-category.md): This endpoint retrieves a list of warranty quotes for a specific store and category. The response includes detailed warranty options, pricing, and coverage information.
- [For all price bands of a category](https://docs.surebright.com/api-reference/endpoint/quote/list-warranty-quotes-by-category-for-all-price-bands.md): Retrieves a list of warranty quotes for all price bands based on Category. The response includes price bands details and warranty quotes details.
- [By Product](https://docs.surebright.com/api-reference/endpoint/quote/list-warranty-quotes-by-product.md): This endpoint retrieves a list of warranty quotes for a specific product and its price.
- [By Product Details](https://docs.surebright.com/api-reference/endpoint/quote/list-warranty-quotes-by-product-details.md): This endpoint retrieves a list of warranty quotes based on product details (title, description, and price). The response includes detailed warranty options, pricing, and coverage information similar to other quote endpoints.
- [By Url](https://docs.surebright.com/api-reference/endpoint/quote/list-warranty-quotes-by-url.md): This endpoint fetches all warranty quotes for the product category to which product in the sent URL belongs.
- [For Whole System Warranty](https://docs.surebright.com/api-reference/endpoint/quote/list-warranty-quotes-for-whole-system.md): This endpoint generates warranty quotes for an entire system order. It accepts store, proposal, and detailed line-item information as inputs, along with the installer’s warranty duration. The API returns available warranty offers, product coverage details, and a link to the specific terms and conditions for the warranty-eligible products
- [Overview](https://docs.surebright.com/api-reference/endpoint/store-category/index.md): A Store Category represents a distinct grouping of products within a specific store that are eligible for extended warranty coverage.
- [List Category](https://docs.surebright.com/api-reference/endpoint/store-category/list-category.md): Retrieves a list of store categories based on storeId . The response includes category details, and labels based on the authorization status
- [HTTP Status Codes](https://docs.surebright.com/api-reference/http-status-codes.md)
- [Introduction](https://docs.surebright.com/api-reference/introduction.md)
- [Over the Phone Sales using Draft Order Extension](https://docs.surebright.com/draft-order-guide/shopify-draft-order.md): This document describes how to use Shopify’s Draft Orders to record over the phone sales
- [JavaScript Injection](https://docs.surebright.com/frontend-widget-integration/frontend-widget-kit/javascript-injection.md)
- [Brand Managed Campaign](https://docs.surebright.com/klaviyo-integration/brand-managed-campaign-guide.md): Follow the steps below to configure a Klaviyo Flow that targets customers eligible for warranty upsell emails using your own email templates and messaging
- [Integration Guide](https://docs.surebright.com/klaviyo-integration/integration-guide.md): SureBright enables you to engage customers who did not purchase a warranty at the time of checkout by sending personalized post-purchase emails across multiple channels.
- [Disable/Enable Module](https://docs.surebright.com/magento/disable-guide.md): Guide to disable/enable SureBright module.
- [Installation Guide](https://docs.surebright.com/magento/install-guide.md): Installation guide for SureBright Magento module to enable product and shipping protection on you website. 
- [Re-Install Guide](https://docs.surebright.com/magento/reinstall-guide.md): Re-install guide to disable and re-enable SureBright module for Magento.
- [Business Manager Setup](https://docs.surebright.com/salesforce-commerce-cloud/BusinessManagerSetup.md): Step-by-step guide for setting up SureBright integration in SFCC Business Manager including cartridge upload, metadata import, and catalog configuration.
- [Configuration](https://docs.surebright.com/salesforce-commerce-cloud/Configuration.md): User and API configuration guide for SureBright SFCC integration including user account creation, API client setup, and credential management.
- [FAQs](https://docs.surebright.com/salesforce-commerce-cloud/FAQs.md): Frequently asked questions about SureBright SFCC integration including setup, configuration, and common issues.
- [SFCC Integration Guide](https://docs.surebright.com/salesforce-commerce-cloud/IntegrationGuide.md): Complete guide to onboard SureBright Product Protection within Salesforce Commerce Cloud (SFCC) SFRA store. This guide covers both scenarios: when SureBright gets Business Manager access and when only API access is provided.
- [Jobs](https://docs.surebright.com/salesforce-commerce-cloud/Jobs.md): Data synchronization jobs configuration for SureBright integration including product export and order processing jobs.
- [Testing](https://docs.surebright.com/salesforce-commerce-cloud/Testing.md): Comprehensive testing and validation guide for SureBright SFCC integration including product sync, order processing, and storefront functionality testing.
- [SureBright’s update claim and service status API for Servify](https://docs.surebright.com/servify/update-claim-service-status.md)
- [Create discount excluding SureBright Products](https://docs.surebright.com/shopify/create-discount-excluding-surebright-products.md)
- [Enable SureBright Cart Validator](https://docs.surebright.com/shopify/enable-surebright-cart-validator.md): Prevent unauthorized warranty purchases with built-in fraud protection by enabling the SureBright Cart Validator in your Shopify store.
- [Add Online Sales Channel to any Product](https://docs.surebright.com/shopify/online-sales-channel.md)

## OpenAPI Specs

- [openapi](https://docs.surebright.com/api-reference/openapi.json)