v1
latestOpenAPI 3.0.12026-07-243902.3 MBGet Contract by ID
This endpoint retrieves a contract using the Contract ID. Information that can be retrieved for a contract includes coverage, customer, plan, and product details associated to the contract.
Given the new contract type of shipping protection, there are two different response bodies that can be returned. When a shipping protection contract is retrieved, the response body will also include tracking/shipment information and a list of products covered under the shipping protection plan instead of the one product that would be returned with extended warranty contracts. Additional details on the different response bodies is outlined in the successful response examples below.
Path parameters
Unique identifier for Extend contract.
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.
Response
Successfully retrieved contract
Example response
{
"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
}
}