Product protection integration

Integration guide — Product Protection (Extended Warranty)

The defining trait of the extended-warranty business is its strong dependency on item attributes: rates differ across product categories. Therefore a product sync step must be added before the standard insurance flow so that warranty plans can be matched accurately.

---

1. Business stages

• Product sync (prerequisite)

  • Warranty quoting depends on item categories and attributes. First push your catalog via product sync; Xcotton then matches warranty plans for the items.

• Get a quote

  • Two ways to obtain plan rates and quotes.

    • Option 1 (recommended): receive the warranty-quote callback. Cache the per-item plan rates locally and compute the displayed quote on the frontend (product page / cart) as item amount × rate. This maximizes page-load and checkout performance.
    • Option 2: call the warranty quote endpoint for a live query.

• Order sync

  • After the customer purchases the warranty, push the order via sync platform order.

• Shipment sync and activation

  • After dispatch, call sync shipment to push the carrier details. Once processed, the extended-warranty policy becomes effective and claims are open. Xcotton can be configured with the service-activated callback to notify you asynchronously. At activation you may receive both the activated callback and the service-state callback (serviceState=3); deduplicate by service-order number.

• Cancellation

  • The warranty can be cancelled only before shipment is synchronized. Call CancelServiceOrder; a serviceOrderId containing PP is a warranty policy. Full cancellation is supported pre-shipment; for partial cancellation pass cancelItems. Cancellation is not supported after shipment; for exceptional cases contact the product and business teams.

---

2. Flow and sequence diagrams

2.1 Extended-warranty business flow

2.2 Extended-warranty interaction sequence