Skip to main content
POST
/
partner
/
api
/
v1
/
order
/
whole-system
/
cancel?contractId=
{contractId}
Cancel Contract for Whole System Warranty
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>'
{
  "isError": false,
  "message": "Contract cancelled successfully",
  "contractId": "54a3a238407f426e862a0a11cab11164"
}

​
Headers

HeaderDescriptionRequired
X-SureBright-Access-TokenAccess token for authenticationYes

​
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

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"