Create Contracts for Whole System Order

curl --request POST \
  --url https://{HOST_NAME}/partner/api/v1/whole-system-order \
  --header 'Content-Type: application/json' \
  --header 'X-SureBright-Access-Token: <x-surebright-access-token>' \
  --data '
{
  "storeId": "test-store-id",
  "warrantyQuoteId": "36eaa6e3-ca1f-4bc1-86da-76caf7a7114d",
  "customerDetails": {
    "customerEmail": "[email protected]",
    "customerFirstName": "John",
    "customerLastName": "Doe",
    "customerAddress1": "1234 Tulip Grove Rd",
    "customerCity": "Nashville",
    "customerState": "TN",
    "customerCountry": "USA",
    "customerZipCode": "37076",
    "customerPhone": "+1 (615) 555-0123",
    "customerAddress2": "Suite 100",
    "addressType": "BILLING"
  },
  "warrantyQuoteItemList": [
    {
      "coverageYears": 2,
      "quotePrice": 40,
      "warrantyQuoteItemId": "a7defcbd-aa07-4e01-9076-c1935af20a98"
    }
  ],
  "lineItemList": [
    {
      "title": "PMC Prophecy5 2-Way Floorstanding Speaker (Pair)",
      "unitPrice": 6500,
      "quantity": 1,
      "isCovered": true,
      "sbCategoryName": "Speaker Floorstanding",
      "description": "High-performance floorstanding speaker pair for immersive audio systems."
    }
  ],
  "partnerProposalId": "9f3e21c6-6bdb-4c7f-9b91-2a4f9a2c7d11"
}
'

{
  "contractIdList": [
    "54a3a238407f426e862a0a11cab11164"
  ],
  "transactionResponse": {
    "isError": false,
    "order": {
      "sourcePlatform": "SERVICE_PORTAL",
      "merchantId": "dc087e7938cc4d6aa6d5ef8e4a09720f",
      "sellerID": "dc087e7938cc4d6aa6d5ef8e4a09720f",
      "sbSalesLeadId": "8c7cee7c-4521-4eb2-9e48-0528035d525f",
      "transactionDate": "2025-12-08T16:24:52.223Z",
      "transactionReason": "1",
      "saleType": "O",
      "customerDetails": {
        "customerEmail": "[email protected]",
        "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"
      },
      "orderId": "dc087e7938cc4d6aa6d5ef8e4a09720f#7a9501126439-46a3-9bad-28019ed511fd",
      "orderItems": [
        {
          "contractStatus": "A",
          "quoteId": "c8152608-83bf-479f-8f59-ee8278ca14c0",
          "quoteItemId": "53ba3d22-3afa-4330-b315-e42e5ef69ffb",
          "termMonths": 24,
          "modelName": "SureBright Whole System Warranty Plan",
          "modelNumber": "8c7cee7c-4521-4eb2-9e48-0528035d525f",
          "manufacturerName": "",
          "policyTax": "0.0",
          "productListPrice": 50,
          "productPurchasePrice": 50,
          "productTax": "0.0",
          "purchaseDate": "2025-12-08",
          "productId": "LEAD_8c7cee7c-4521-4eb2-9e48-0528035d525f",
          "coveredLineItemsList": [
            {
              "Model_Name": "TV",
              "Model_Number": "",
              "Product_Purchase_Price": "50",
              "Product_Tax": "0.0",
              "Quantity": "1",
              "sbCategoryTag": "TV_MONITOR",
              "Product_Condition": "NEW"
            }
          ]
        }
      ],
      "policyPrice": "2",
      "source": "SERVICE_PORTAL",
      "installerWarrantyDuration": "3 Months"
    }
  }
}

POST

partner

api

whole-system-order

Create Contracts for Whole System Order

curl --request POST \
  --url https://{HOST_NAME}/partner/api/v1/whole-system-order \
  --header 'Content-Type: application/json' \
  --header 'X-SureBright-Access-Token: <x-surebright-access-token>' \
  --data '
{
  "storeId": "test-store-id",
  "warrantyQuoteId": "36eaa6e3-ca1f-4bc1-86da-76caf7a7114d",
  "customerDetails": {
    "customerEmail": "[email protected]",
    "customerFirstName": "John",
    "customerLastName": "Doe",
    "customerAddress1": "1234 Tulip Grove Rd",
    "customerCity": "Nashville",
    "customerState": "TN",
    "customerCountry": "USA",
    "customerZipCode": "37076",
    "customerPhone": "+1 (615) 555-0123",
    "customerAddress2": "Suite 100",
    "addressType": "BILLING"
  },
  "warrantyQuoteItemList": [
    {
      "coverageYears": 2,
      "quotePrice": 40,
      "warrantyQuoteItemId": "a7defcbd-aa07-4e01-9076-c1935af20a98"
    }
  ],
  "lineItemList": [
    {
      "title": "PMC Prophecy5 2-Way Floorstanding Speaker (Pair)",
      "unitPrice": 6500,
      "quantity": 1,
      "isCovered": true,
      "sbCategoryName": "Speaker Floorstanding",
      "description": "High-performance floorstanding speaker pair for immersive audio systems."
    }
  ],
  "partnerProposalId": "9f3e21c6-6bdb-4c7f-9b91-2a4f9a2c7d11"
}
'

{
  "contractIdList": [
    "54a3a238407f426e862a0a11cab11164"
  ],
  "transactionResponse": {
    "isError": false,
    "order": {
      "sourcePlatform": "SERVICE_PORTAL",
      "merchantId": "dc087e7938cc4d6aa6d5ef8e4a09720f",
      "sellerID": "dc087e7938cc4d6aa6d5ef8e4a09720f",
      "sbSalesLeadId": "8c7cee7c-4521-4eb2-9e48-0528035d525f",
      "transactionDate": "2025-12-08T16:24:52.223Z",
      "transactionReason": "1",
      "saleType": "O",
      "customerDetails": {
        "customerEmail": "[email protected]",
        "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"
      },
      "orderId": "dc087e7938cc4d6aa6d5ef8e4a09720f#7a9501126439-46a3-9bad-28019ed511fd",
      "orderItems": [
        {
          "contractStatus": "A",
          "quoteId": "c8152608-83bf-479f-8f59-ee8278ca14c0",
          "quoteItemId": "53ba3d22-3afa-4330-b315-e42e5ef69ffb",
          "termMonths": 24,
          "modelName": "SureBright Whole System Warranty Plan",
          "modelNumber": "8c7cee7c-4521-4eb2-9e48-0528035d525f",
          "manufacturerName": "",
          "policyTax": "0.0",
          "productListPrice": 50,
          "productPurchasePrice": 50,
          "productTax": "0.0",
          "purchaseDate": "2025-12-08",
          "productId": "LEAD_8c7cee7c-4521-4eb2-9e48-0528035d525f",
          "coveredLineItemsList": [
            {
              "Model_Name": "TV",
              "Model_Number": "",
              "Product_Purchase_Price": "50",
              "Product_Tax": "0.0",
              "Quantity": "1",
              "sbCategoryTag": "TV_MONITOR",
              "Product_Condition": "NEW"
            }
          ]
        }
      ],
      "policyPrice": "2",
      "source": "SERVICE_PORTAL",
      "installerWarrantyDuration": "3 Months"
    }
  }
}

Headers

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

Overview

This endpoint creates warranty contracts 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 along with the line items to this endpoint to create the contracts

Request Details

warrantyQuoteId - The unique quote ID received from the quote endpoint
warrantyQuoteItemList - The selected warranty plan(s) with coverage years and pricing
lineItemList - The complete list of products with their coverage status (isCovered: true/false)

Response

On success, you will receive:

contractIdList - Array of created contract IDs
transactionResponse - Complete transaction details including order information and customer details

Headers

X-SureBright-Access-Token

string

required

Access token for authentication

Body

application/json

storeId

string

required

A unique identifier for the store

Example:

"test-store-id"

warrantyQuoteId

string

required

The unique identifier for the warranty quote obtained from the List Quotes for Whole System Warranty endpoint

Example:

"36eaa6e3-ca1f-4bc1-86da-76caf7a7114d"

customerDetails

object

required

Customer information for the warranty contract

Show child attributes

customerDetails.customerEmail

string<email>

required

Customer email address

Example:

"[email protected]"

customerDetails.customerFirstName

string

required

Customer first name

Example:

"John"

customerDetails.customerLastName

string

required

Customer last name

Example:

"Doe"

customerDetails.customerAddress1

string

required

Customer primary address line

Example:

"1234 Tulip Grove Rd"

customerDetails.customerCity

string

required

Customer city

Example:

"Nashville"

customerDetails.customerState

string

required

Customer state or province

Example:

"TN"

customerDetails.customerCountry

string

required

Customer country

Example:

"USA"

customerDetails.customerZipCode

string

required

Customer postal/zip code

Example:

"37076"

customerDetails.customerPhone

string

Customer phone number

Example:

"+1 (615) 555-0123"

customerDetails.customerAddress2

string

Customer secondary address line (apt, suite, etc.)

Example:

"Suite 100"

customerDetails.addressType

enum<string>

Type of address

Available options:

BILLING,

SHIPPING

Example:

"BILLING"

warrantyQuoteItemList

object[]

required

List of selected warranty quote items with coverage details

Show child attributes

warrantyQuoteItemList.coverageYears

integer

required

Duration of the warranty coverage in years

Example:

2

warrantyQuoteItemList.quotePrice

number<float>

required

Price of the warranty quote

Example:

40

warrantyQuoteItemList.warrantyQuoteItemId

string

required

Unique identifier for the warranty quote item

Example:

"a7defcbd-aa07-4e01-9076-c1935af20a98"

lineItemList

object[]

required

A list of line items representing the products in the order with coverage status

Show child attributes

lineItemList.title

string

required

The title or name of the product

Example:

"PMC Prophecy5 2-Way Floorstanding Speaker (Pair)"

lineItemList.unitPrice

number<float>

required

The unit price of the product purchased

Example:

6500

lineItemList.quantity

integer

required

The quantity of the product purchased

Example:

1

lineItemList.isCovered

boolean

Indicates whether the line item is covered by the warranty

Example:

true

lineItemList.sbCategoryName

string

The SureBright category name for the product

Example:

"Speaker Floorstanding"

lineItemList.description

string

The description of the product

Example:

"High-performance floorstanding speaker pair for immersive audio systems."

partnerProposalId

string

A unique identifier for the partner's proposal

Example:

"9f3e21c6-6bdb-4c7f-9b91-2a4f9a2c7d11"

Response

Contracts Created Successfully

contractIdList

string[]

List of unique contract IDs created for the warranty

Example:

["54a3a238407f426e862a0a11cab11164"]

transactionResponse

object

Transaction response containing order details

Show child attributes

transactionResponse.isError

boolean

Indicates if an error occurred

Example:

false

transactionResponse.order

object

Order details for the created contract

Show child attributes

transactionResponse.order.sourcePlatform

string

The platform source of the order

Example:

"SERVICE_PORTAL"

transactionResponse.order.merchantId

string

Unique identifier for the merchant

Example:

"dc087e7938cc4d6aa6d5ef8e4a09720f"

transactionResponse.order.sellerID

string

Unique identifier for the seller

Example:

"dc087e7938cc4d6aa6d5ef8e4a09720f"

transactionResponse.order.sbSalesLeadId

string

SureBright sales lead ID associated with the proposal

Example:

"8c7cee7c-4521-4eb2-9e48-0528035d525f"

transactionResponse.order.transactionDate

string<date-time>

Date and time of the transaction

Example:

"2025-12-08T16:24:52.223Z"

transactionResponse.order.transactionReason

string

Reason code for the transaction

Example:

"1"

transactionResponse.order.saleType

string

Type of sale

Example:

"O"

transactionResponse.order.customerDetails

object

Customer information

Show child attributes

transactionResponse.order.customerDetails.customerEmail

string<email>

Customer email address

Example:

"[email protected]"

transactionResponse.order.customerDetails.customerPhone

string

Customer phone number

Example:

"+1 (615) 555-0123"

transactionResponse.order.customerDetails.customerFirstName

string

Customer first name

Example:

"John"

transactionResponse.order.customerDetails.customerLastName

string

Customer last name

Example:

"Doe"

transactionResponse.order.customerDetails.customerAddress1

string

Customer primary address line

Example:

"1234 Tulip Grove Rd"

transactionResponse.order.customerDetails.customerAddress2

string

Customer secondary address line (apt, suite, etc.)

Example:

"Suite 100"

transactionResponse.order.customerDetails.customerCity

string

Customer city

Example:

"Nashville"

transactionResponse.order.customerDetails.customerState

string

Customer state or province

Example:

"TN"

transactionResponse.order.customerDetails.customerCountry

string

Customer country

Example:

"USA"

transactionResponse.order.customerDetails.customerZipCode

string

Customer postal/zip code

Example:

"37076"

transactionResponse.order.customerDetails.addressType

string

Type of address

Example:

"BILLING"

transactionResponse.order.orderId

string

Unique order identifier

Example:

"dc087e7938cc4d6aa6d5ef8e4a09720f#7a9501126439-46a3-9bad-28019ed511fd"

transactionResponse.order.orderItems

object[]

List of order items

Show child attributes

transactionResponse.order.orderItems.contractStatus

string

Status of the contract (A = Active)

Example:

"A"

transactionResponse.order.orderItems.quoteId

string

Quote ID associated with this item

Example:

"c8152608-83bf-479f-8f59-ee8278ca14c0"

transactionResponse.order.orderItems.quoteItemId

string

Quote item ID

Example:

"53ba3d22-3afa-4330-b315-e42e5ef69ffb"

transactionResponse.order.orderItems.termMonths

integer

Term duration in months

Example:

24

transactionResponse.order.orderItems.modelName

string

Name of the warranty plan

Example:

"SureBright Whole System Warranty Plan"

transactionResponse.order.orderItems.modelNumber

string

Model number or sales lead ID

Example:

"8c7cee7c-4521-4eb2-9e48-0528035d525f"

transactionResponse.order.orderItems.manufacturerName

string

Manufacturer name

Example:

""

transactionResponse.order.orderItems.policyTax

string

Tax amount on the policy

Example:

"0.0"

transactionResponse.order.orderItems.productListPrice

number

List price of the product

Example:

50

transactionResponse.order.orderItems.productPurchasePrice

number

Purchase price of the product

Example:

50

transactionResponse.order.orderItems.productTax

string

Tax amount on the product

Example:

"0.0"

transactionResponse.order.orderItems.purchaseDate

string<date>

Date of purchase

Example:

"2025-12-08"

transactionResponse.order.orderItems.productId

string

Product identifier

Example:

"LEAD_8c7cee7c-4521-4eb2-9e48-0528035d525f"

transactionResponse.order.orderItems.coveredLineItemsList

object[]

List of covered line items

Show child attributes

transactionResponse.order.orderItems.coveredLineItemsList.Model_Name

string

Category name of the covered item

Example:

"TV"

transactionResponse.order.orderItems.coveredLineItemsList.Model_Number

string

Model number of the covered item

Example:

""

transactionResponse.order.orderItems.coveredLineItemsList.Product_Purchase_Price

string

Purchase price of the covered item

Example:

"50"

transactionResponse.order.orderItems.coveredLineItemsList.Product_Tax

string

Tax on the covered item

Example:

"0.0"

transactionResponse.order.orderItems.coveredLineItemsList.Quantity

string

Quantity of covered items

Example:

"1"

transactionResponse.order.orderItems.coveredLineItemsList.sbCategoryTag

string

SureBright category tag

Example:

"TV_MONITOR"

transactionResponse.order.orderItems.coveredLineItemsList.Product_Condition

string

Condition of the product

Example:

"NEW"

transactionResponse.order.policyPrice

string

Price of the policy

Example:

"2"

transactionResponse.order.source

string

Source of the order

Example:

"SERVICE_PORTAL"

transactionResponse.order.installerWarrantyDuration

string

Duration of the installer warranty

Example:

"3 Months"

Cancel / Update contracts for Order HTTP Status Codes

⌘I

​Headers

​Overview

​Flow

​Request Details

​Response

Headers

Body

Response

Headers

Overview

Flow

Request Details

Response