Cancel / Update contracts for Order

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.

PUT /partner/api/v1/order

Try it

Update Warranty

cURL

curl --request PUT \
  --url https://{HOST_NAME}/partner/api/v1/order \
  --header 'Content-Type: application/json' \
  --header 'X-SureBright-Access-Token: <x-surebright-access-token>' \
  --data '
{
  "storeId": "f4c059b2-5b74-4e4c-a3c5-85bc80cf8a09",
  "orderId": "83737121380",
  "orderPurchaseDate": "2024-01-07T10:15:30Z",
  "orderLineItemList": [
    {
      "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d",
      "totalPrice": 3300,
      "quantity": 3,
      "productTitle": "GreatCircleUSA 3-in-1 Wood Chipper - 7HP Engine, 3 Max Branch Capacity",
      "productId": "6673746231399",
      "productSKU": "ALH05",
      "salePrice": 1100,
      "planDetails": {
        "policyPurchaseDate": "2024-01-07T10:15:30Z",
        "policySKU": "SBW-1U-SHAB-2900",
        "policyPrice": 29
      },
      "optionId": "8577825144935",
      "listPrice": 1299,
      "discountAmount": 199,
      "productURL": "https://example.com/products/wood-chipper-alh05"
    }
  ],
  "customerDetails": {
    "firstName": "John",
    "lastName": "Doe",
    "addressLine1": "123 Hathway Street",
    "city": "New York City",
    "state": "NY",
    "country": "US",
    "zipCode": "10005",
    "customerEmail": "[e-mail]",
    "addressLine2": "Apt 4B",
    "mobileNumber": "7872323781"
  },
  "discount": {
    "discountAmount": 10
  },
  "totalOrderValue": 1000,
  "isTestOrder": false,
  "taxAmount": 100
}
'

200

{
  "storeId": "f4c059b2-5b74-4e4c-a3c5-85bc80cf8a09",
  "orderId": "83737121380",
  "contractList": [
    {
      "lineItemId": "374dc3c3-94a3-4b85-a876-8651e461446d",
      "contractId": "abc12345-6789-4abc-bcde-ef1234567890",
      "isCancelled": false
    }
  ]
}

Headers

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

Headers

X-SureBright-Access-Token · string · required

Access token for authentication

Body

application/json

storeId · string · required

A unique identifier for a store will be shared as part of the integration kit

Example:

"f4c059b2-5b74-4e4c-a3c5-85bc80cf8a09"

orderId · string · required

Unique identifier for the complete successful order placed by a customer on the merchant site. This represents the whole order that can have multiple line items of different quantities.

Maximum string length: 48

Example:

"83737121380"

orderPurchaseDate · string<date-time> · required

Date time at which the order was purchased by customer.

Example:

"2024-01-07T10:15:30Z"

orderLineItemList · object[] · required

The lineItemList consists of individual line items representing purchased products and/or products with policies. Each line item is uniquely identified by a lineItemId (String: maximum length 48 characters). The planDetails serve to identify the specific quote option acquired by the customer. OptionId is the combination of product attributes separated by #.

Show child attributes

orderLineItemList. lineItemId · string · required

Maximum string length: 48

Example:

"374dc3c3-94a3-4b85-a876-8651e461446d"

orderLineItemList. totalPrice · number · required

Example:

3300

orderLineItemList. quantity · integer · required

Example:

3

orderLineItemList. productTitle · string · required

Example:

"GreatCircleUSA 3-in-1 Wood Chipper - 7HP Engine, 3 Max Branch Capacity"

orderLineItemList. productId · string · required

Example:

"6673746231399"

orderLineItemList. productSKU · string · required

Example:

"ALH05"

orderLineItemList. salePrice · number · required

Example:

1100

orderLineItemList. planDetails · object

Show child attributes

orderLineItemList.planDetails. policyPurchaseDate · string<date-time> · required

Date time at which the policy was purchased by the customer.

Example:

"2024-01-07T10:15:30Z"

orderLineItemList.planDetails. policySKU · string · required

The SKU id of the policy purchased by the customer, this will only be required if warranty to be selected is based on the policy SKU ids shared with the store

Example:

"SBW-1U-SHAB-2900"

orderLineItemList.planDetails. policyPrice · number · required

The price of policy purchased by the customer.

Example:

29

orderLineItemList. optionId · string

Example:

"8577825144935"

orderLineItemList. listPrice · number

Example:

1299

orderLineItemList. discountAmount · number

Example:

199

orderLineItemList. productURL · string

Example:

"https://example.com/products/wood-chipper-alh05"

customerDetails · object · required

Show child attributes

customerDetails. firstName · string · required

Example:

"John"

customerDetails. lastName · string · required

Example:

"Doe"

customerDetails. addressLine1 · string · required

Example:

"123 Hathway Street"

customerDetails. city · string · required

Example:

"New York City"

customerDetails. state · string · required

ISO 3166-2 code

Example:

"NY"

customerDetails. country · string · required

Country code for USA is US

Example:

"US"

customerDetails. zipCode · string · required

Example:

"10005"

customerDetails. customerEmail · string<email> · required

Example:

"[e-mail]"

customerDetails. addressLine2 · string

Example:

"Apt 4B"

customerDetails. mobileNumber · string

Example:

"7872323781"

discount · object

Show child attributes

discount. discountAmount · number

Example:

10

totalOrderValue · number

Example:

1000

isTestOrder · boolean

Example:

false

taxAmount · number

Example:

100

Response

200

application/json

Warranty created successfully

storeId · string

A unique identifier for a store will be shared as part of the integration kit

Example:

"f4c059b2-5b74-4e4c-a3c5-85bc80cf8a09"

orderId · string

A unique identifier for the complete successful order placed by a customer on the merchant site. This represents the whole order that can have multiple line items of different quantities.

Maximum string length: 48

Example:

"83737121380"

contractList · object[]

The list of contracts generated for each quantity in each line item. If any error in generating a contract, the error code and msg will be added for that item instead of the contract id.

Show child attributes

contractList. lineItemId · string

Example:

"374dc3c3-94a3-4b85-a876-8651e461446d"

contractList. contractId · string

Example:

"abc12345-6789-4abc-bcde-ef1234567890"

contractList. isCancelled · boolean

Example:

false