Salesforce Docs Portal

Warranty SPI

POST Warranty Lookup SPI

POST /merchant/spi/sample/endpoint/sa/warranty

Operation ID: checkWarrantyEligibility. Tags: Warranty SPI.

Checks warranty eligibility for merchandise items in the cart.

The POS sends cart context (store address, shipping address, customer profile, and merchandise items) to the merchant's warranty engine. The engine evaluates eligibility rules (jurisdiction, product category, loyalty tier, etc.) and returns a list of available warranty products.

Merchants must implement this endpoint per this specification and configure it in CMS under: CMS > Store Management > Integration > Custom API Connectors > Create

Make sure to create the endpoint in CMS with following details

  1. Under API Config

    • API Key: WARRANTY_LOOKUP
    • API Endpoint: Provide the external endpoint URL

  2. Under JSON Config

    • Integration Type: HTTP_POST
    • JSON Headers: Provide the header for the api. Headers can be Content-Type eg.{"contentType": "application/json"}

Invoke: Called when the associate taps 'Check Warranties' on the POS cart screen. Only merchandise items are sent; warranty SKUs already in the cart are filtered out.

Response:

  • Return eligibleWarrantyList with warranty products when warranties apply
  • Return empty eligibleWarrantyList when no warranties apply
  • Return errorMessage and errorCode on failure (POS will surface the error)

Notes:

  • warrantyProductId must match a product in CMS configured with ProductClass rule WARRANTY_SKU
  • coveredProductIds must reference productId values from the request's cartItemList
  • For CATEGORY_BASED pricing (MVP), quantity should always be 1.

Request body

Media type: application/json. Schema: SpiWarrantyCheckRequest.

Responses

  • default default response.

    Media type: application/json. Schema: SpiWarrantyCheckResponse.