Search Contracts

get

https://api.helloextend.com/contracts/search

This endpoint allows search via querystring params. There are two search versions that can be set using the query string parameter searchVersion equal to 1 or 2. The response for search version 2 is in paginated format.

The search queries for version 1 include:

typeFilter
contractId
customerEmail
customerPhone
productSerialNumber
productTransactionId
sellerId
status
transactionId

The search term sellerId can be paired with any of the other terms to limit contracts by seller in version 1.

The search queries for version 2 include:

limit
cursor
sortKey
sortAsc
typeFilter
containsTransactionId
containsId
containsProductReferenceId
containsCustomerEmail
filterMatchStatuses
transactionDateBegin
transactionDateEnd
productTransactionDateBegin
productTransactionDateEnd
cancelledAtBegin
cancelledAtEnd
refundedAtBegin
refundedAtEnd
updatedAtBegin
updatedAtEnd

sellerId is a required querystring parameter in search version 1.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

typeFilter

string

enum

Filter for including contract types. NOTE - PCRS is the contract type for extended warranty contracts.

contractId

uuid

Unique identifier for an Extend contract.

customerEmail

string

Email of customer who purchased the contract.

customerPhone

string

Phone number of customer who purchased the contract.

merchantCustomerId

string

Unique identifier for the customer in the merchant’s system.

productSerialNumber

string

Serial number of product purchased.

productTransactionId

string

Unique identifier provided by merchant for transaction associated to the product covered by the Extend contract.

sellerId

uuid

Unique identifier for merchant’s store in Extend’s system.

status

string

enum

Status of contract.

transactionId

string

Unique identifier provided by merchant for transaction associated to Extend contract purchased.

sortKey

string

enum

Key to sort contract search results by.

Allowed:

sortAsc

boolean

Sort by ascending values.

containsTransactionId

string

Transaction id to limit search by.

containsId

string

Contract id to limit search by.

containsProductReferenceId

string

Product reference id to limit search by.

containsCustomerEmail

string

Customer email to limit search by.

containsMerchantCustomerId

string

Merchant defined customer id to limit search by.

filterMatchStatuses

string

Contract statuses to filter search results by.

transactionDateBegin

string

Beginning transaction date of warranty/plan to limit search results by in milliseconds. NOTE - This field is formatted as a 13 digit Epoch timestamp.

transactionDateEnd

string

Ending transaction date of warranty/plan to limit search results by in milliseconds. NOTE - This field is formatted as a 13 digit Epoch timestamp.

productTransactionDateBegin

string

Beginning transaction date of product purchased to limit search results by in milliseconds. NOTE - This field is formatted as a 13 digit Epoch timestamp.

productTransactionDateEnd

string

Ending transaction date of product purchased to limit search results by in milliseconds. NOTE - This field is formatted as a 13 digit Epoch timestamp.

cancelledAtBegin

string

Beginning cancellation date of contract to limit search results by in milliseconds. NOTE - This field is formatted as a 13 digit Epoch timestamp.

cancelledAtEnd

string

Ending cancellation date of contract to limit search results by in milliseconds. NOTE - This field is formatted as a 13 digit Epoch timestamp.

refundedAtBegin

string

Beginning refunded date of contract to limit search results by in milliseconds. NOTE - This field is formatted as a 13 digit Epoch timestamp.

refundedAtEnd

string

Ending refunded date of contract to limit search results by in milliseconds. NOTE - This field is formatted as a 13 digit Epoch timestamp.

updatedAtBegin

string

Beginning updated at date of contract to limit search results by in milliseconds. NOTE - This field is formatted as a 13 digit Epoch timestamp.

updatedAtEnd

string

Ending updated at date of contract to limit search results by in milliseconds. NOTE - This field is formatted as a 13 digit Epoch timestamp.

showAll

boolean

Use the value true to return all the product info and plan details.

Headers

Content-Type

string

required

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

X-Extend-Access-Token

string

required

An Extend private API key used to authenticate requests.

string

required

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.

search-version

string

enum

Search version for searching contracts.

Allowed:

Responses

200Successfully returned search result. Note - This is an example response for an extended warranty contract.

400The request to the endpoint was invalid

403Forbidden

404The specified resource was not found