v1

latestOpenAPI 3.0.12026-07-243902.3 MB
service-orders

Find service orders associated with a given claim ID or Service Order Id. Must include claimId or serviceOrderId for searching. Cannot search by both claimId and serviceOrderId

get/service-orders/search

Query parameters

claimIdstring uuid
Example:c57ed096-24ef-49a4-a20a-d1b8bf770980

Unique identifier for a claim

includeShippingLabels'true' | 'false'
Example:true
serviceOrderIdstring uuid
Example:c57ed096-24ef-49a4-a20a-d1b8bf770980

Unique identifier for a service order

limitnumber

Amount of results to return

cursornumber

Amount of results to skip

Headers

Content-Typestring required
Example:application/json

Used to indicate the original media type of the resource (prior to any content encoding applied for sending).

X-Extend-Access-Tokenstring required
Example:ExtendAccessToken

An Extend private API key used to authenticate requests.

Acceptstring required
Example:application/json; version=latest

Indicates which content types, expressed as MIME types, the client is able to understand, as well as identifies which API version to use in the request.

Response

Returns an array of service orders associated with a given claim Id or service order Id