Cancel Contracts for Whole System Warranty

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.

POST /partner/api/v1/order/whole-system/cancel?contractId={contractId}

Cancel Contract for Whole System Warranty

cURL

curl --request POST \
  --url 'https://{HOST_NAME}/partner/api/v1/order/whole-system/cancel?contractId={contractId}' \
  --header 'X-SureBright-Access-Token: <x-surebright-access-token>'

200

{
  "isError": false,
  "message": "Contract cancelled successfully",
  "contractId": "54a3a238407f426e862a0a11cab11164"
}

Headers

Header	Description	Required
X-SureBright-Access-Token	Access token for authentication	Yes

Overview

This endpoint cancels warranty contract for a whole system order.

A contract can only be cancelled within 30 days after the date of sale of purchase.

Headers

X-SureBright-Access-Token · string · required

Access token for authentication

Query Parameters

contractId · string · required

The unique identifier for the warranty contract to be cancelled

Example:

"5233a92bfcc04a77920abfa1fe52194a"

Response

200

application/json

Contract Cancelled Successfully

isError · boolean

Indicates if an error occurred

Example:

false

message · string

Success message

Example:

"Contract cancelled successfully"

contractId · string

The unique identifier for the cancelled warranty contract

Example:

"54a3a238407f426e862a0a11cab11164"