Skip to main content

Get Warranty ID by External Order ID

You can retrieve warranty IDs associated with the externalOrderId that you sent.

Request

curl --location --request GET '<BASE_URL>/individual-customer-products/external-order-id/{externalOrderId}'
--header 'Content-Type: application/json'
--header 'Authorization: <jwtToken>'

Path Variables

ParameterTypeRequired
Description
externalOrderIdStringYesThe externalOrderId value you sent when the warranty was created

Response

Returns the list of warranty IDs (individualCustomerProductId) created with that externalOrderId.

[
1,
2,
3
]
Multiple IDs

This endpoint always returns a list, and that list can hold more than one ID. The API does not enforce uniqueness of externalOrderId, so if the same value was sent in several warranty requests, every warranty created with it is returned here. Do not assume the list has exactly one element. See External Order ID uniqueness.

No Match

If no warranty exists for the given externalOrderId, the service responds with HTTP 200 and an empty list ([]), not with a 404.