Create / Update Contracts for Whole System Warranty

Headers#

Header	Description	Required
X-SureBright-Access-Token	Access token for authentication	Yes
Content-Type	application/json	Yes

Overview#

This endpoint creates or updates a warranty contract for a whole system order. It is used after obtaining warranty quotes from the List Quotes for Whole System Warranty endpoint.

Flow#

First, call the List Quotes for Whole System Warranty endpoint to get available warranty quotes for your system order
Select the desired warranty plan from the returned warrantyQuoteItemList
Submit the selected warranty details and customer information to this endpoint. Line items, total covered amount, and warranty duration are read from the sales lead identified by sbSalesLeadId — they do not need to be sent in the request.

Request Details#

sbSalesLeadId - The sales lead Id obtained from the List Quotes API response. The contract's covered line items, purchase price, and warranty duration are derived from this lead.
warrantyQuoteId - The unique quote Id received from the quote endpoint
warrantyQuoteItemId - The unique identifier for the warranty quote item obtained from the quote endpoint

sbSalesLeadId is required and is the source of truth for line items. Generate the lead first via the List Quotes for Whole System Warranty endpoint; do not send a lineItemList — any value is ignored.

Updating Existing Contracts

If a contract already exists for the provided sbSalesLeadId, calling this endpoint will update the existing contract instead of creating a new one:

Updates to line items are not permitted beyond 30 days from the date of sale.
Customer details and other non-line item fields can be updated at any time

Validations#

The endpoint performs the following cross-checks before creating or updating a contract. Each failed check returns the listed error code and short-circuits the request before any side effect.

Check	Error
`sbSalesLeadId` exists and belongs to the requesting `storeId` (lookup is keyed by both)	`515` Sales Lead Not Found
`warrantyQuoteId` matches the `sbQuoteId` carried on the lead's line items	`518` Quote ID Mismatch
The quote document is retrievable from DDB by `warrantyQuoteId`	`513` No Quote Found
The store exists for the requesting `storeId`	`514` Store Not Found
`warrantyQuoteItemId` resolves to an item inside the quote	`519` Quote Item Not Found
`warrantyCoverageYears` equals the resolved quote item's `coverageYears`	`520` Warranty Coverage Years Mismatch
(Existing-contract update path) The contract referenced by the lead's `contractIdList` exists in DDB	`516` Contract Not Found
(Existing-contract update path) Covered line items unchanged once 30 days have elapsed since purchase	`517` Line Items Update Not Allowed

These gates run before any user account creation, contract write, or notification, so a rejected request leaves no partial state behind.

Response#

On success, you will receive:

contractId - The unique identifier for the warranty contract created

POSThttps://{HOST_NAME}/partner/api/v1/order/whole-system

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.

Authorizations

X-SureBright-Access-Tokenstringrequired

Access token for authentication

Body

application/json

json

{
  "storeId": "test-store-id",
  "warrantyQuoteId": "36eaa6e3-ca1f-4bc1-86da-76caf7a7114d",
  "warrantyQuoteItemId": "a7defcbd-aa07-4e01-9076-c1935af20a98",
  "sbSalesLeadId": "9f3e21c6-6bdb-4c7f-9b91-2a4f9a2c7d11",
  "warrantyPrice": 40,
  "warrantyCoverageYears": 2,
  "customerDetails": {
    "customerEmail": "john.doe@example.com",
    "customerPhone": "+1 (615) 555-0123",
    "customerFirstName": "John",
    "customerLastName": "Doe",
    "customerAddress1": "1234 Tulip Grove Rd",
    "customerAddress2": "Suite 100",
    "customerCity": "Nashville",
    "customerState": "TN",
    "customerCountry": "USA",
    "customerZipCode": "37076",
    "addressType": "BILLING"
  }
}

PreviousCancel Contracts for Whole System Warranty Next HTTP Status Codes