v1
latestOpenAPI 3.0.12026-07-243902.3 MBSearch Contracts
This endpoint allows search via querystring params. <p>The search queries include:</p><ul><li>typeFilter</li><li>contractId</li><li>customerEmail</li><li>customerPhone</li><li>productSerialNumber</li><li>productTransactionId</li><li>sellerId</li><li>status</li><li>transactionId</li></ul><p>The search term sellerId can be paired with any of the other terms to limit contracts by seller.</p><p>sellerId is a required querystring parameter.</p>
Query parameters
Filter for including contract types. NOTE - PCRS is the contract type for extended warranty contracts.
Unique identifier for an Extend contract.
Email of customer who purchased the contract.
Phone number of customer who purchased the contract.
Unique identifier for the customer in the merchant’s system.
Serial number of product purchased.
Unique identifier provided by merchant for transaction associated to the product covered by the Extend contract.
Unique identifier for merchant’s store in Extend’s system.
Status of contract.
Unique identifier provided by merchant for transaction associated to Extend contract purchased.
Use the value <code>true</code> to return all the product info and plan details.
Headers
Used to indicate the original media type of the resource (prior to any content encoding applied for sending).
An Extend private API key used to authenticate requests.
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
Successfully returned search result. Note - This is an example response for an extended warranty contract.
Example response
{
"contracts": [
{
"accountId": "f36feabf-d024-431f-9506-32bfcada1231",
"adminContractId": "1001609401",
"adminSyncError": "Update Error: PcmiError: Contract plan expected price is not set, try re-syncing",
"adminSyncStatus": "synced",
"merchantCustomerId": "c57ed096-24ef-49a4-a20a-d1b8bf770980",
"cancelledAt": 1651787627000,
"createdAt": 1651787624000,
"consumerProfileId": "f36feabf-d024-431f-9506-32bfcada1231",
"coverage": {
"starts": 1651787621000,
"ends": 1683323621000,
"amount": 1999,
"amountRemaining": 1999
},
"customer": {
"billingAddress": {
"address1": "535 Mission Street",
"address2": "11th Floor",
"city": "San Francisco",
"countryCode": "US",
"postalCode": "94526",
"provinceCode": "CA"
},
"email": "bobross@gmail.com",
"name": "Bob Ross",
"phone": "123-456-7890",
"shippingAddress": {
"address1": "535 Mission Street",
"address2": "11th Floor",
"city": "San Francisco",
"countryCode": "US",
"postalCode": "94526",
"provinceCode": "CA"
},
"type": "consumer",
"locale": "en-US",
"region": "US",
"subdivision": "CA"
},
"formId": "1ADJ",
"id": "cc957cb3-3d5d-430b-90a2-9ec96ee4c3cf",
"isProductWarrantabilityVerified": true,
"limitOfLiabilityAmount": 1999,
"limitOfLiabilityAmountType": "product_purchase_price",
"listPrice": 1999,
"orderId": "9778f161-9530-491a-bfdc-5c45214c0a6c",
"lineItemTransactionId": "line-item-txn-12345",
"plan": {
"id": "10001-misc-elec-adh-replace-1y",
"skuId": "EXT123",
"termsId": "154ebea0-6c1b-46a4-b166-032246330526",
"termsVersion": "1",
"version": 1
},
"poNumber": "ABC-123",
"product": {
"fulfillmentDate": 1651787629000,
"listPrice": 3999,
"manufacturerWarrantyLengthLabor": 6,
"manufacturerWarrantyLengthParts": 6,
"purchaseDate": 1651787629000,
"purchasePrice": 3999,
"referenceId": "SKU-123-456",
"reimbursementAmount": 3999,
"serialNumber": "ABCD123456",
"name": "Wireless Headphones",
"transactionId": "6789876212"
},
"purchaseCurrency": "USD",
"purchaseDate": 1651787620000,
"purchasePrice": 1999,
"refundedAt": 1651787679000,
"resellerMerchant": {
"id": "154ebea0-6c1b-46a4-b166-032246330526",
"name": "Acme Reseller Company",
"domain": "https://acme.reseller.com"
},
"saleOrigin": {
"agentId": "sales agent",
"channel": "web",
"locationId": "Store #123",
"platform": "BigCommerce",
"storeAddress": {
"address1": "535 Mission Street",
"address2": "11th Floor",
"city": "San Francisco",
"countryCode": "US",
"postalCode": "94526",
"province": "CA"
}
},
"sellerId": "598b11f3-5514-42f8-bdd5-e13ae866635a",
"sellerName": "Quality Crafts",
"status": "live",
"transactionId": "123928374327464",
"type": "pcrs",
"updatedAt": 1651787679000,
"charitableDonation": {
"id": "598b11f3-5514-42f8-bdd5-e13ae866635a"
},
"contractTermsLink": "https://customers.helloextend.com/en-US/my_plans/cc957cb3-3d5d-430b-90a2-9ec96ee4c3cf",
"planDetails": {
"category": "consumer_electronics",
"coverage_includes": "adh",
"coverage_starts": "immediate",
"pcmi_category": "Replacement",
"pcmi_subcategory": "General Electronic Devices",
"servicer_ids": [
"100000001"
],
"replacement_type": "new",
"service_type": "replace",
"term_length": 12
}
}
]
}