v1
latestOpenAPI 3.0.12026-07-243902.3 MBLeads
Get Lead Offers
Returns protection plan offers for all leads associated with a given store and transaction. Each lead in the response includes the available plans and enriched product details. Results are paginated with a default page size of 25.
get/leads/offers
Query parameters
storeIdstring uuid required
Example:c57ed096-24ef-49a4-a20a-d1b8bf770980
Unique identifier for a store on Extend
transactionIdstring required
Example:123EY1
The transaction ID to fetch leads for
limitinteger
Example:25
Maximum number of offers to return per page. Default and max is 25.
cursorstring
Pagination cursor for fetching the next page of results
localestring
Example:en-US
The locale of the customer. Locale is used to determine the language for display and communication. Locale is formatted as xx-XX: the first two letters denote language (ISO 639-1 standards), and the last two letters denote region (ISO 3166 standards).
removeMarketing'true' | 'false'
When set to 'true', strips marketing content from the response
regionstring ISO 3166-1
Example:US
Your customer's location is used to determine what offer is presented to the customer in your store. Customers in some locations may not be qualified to purchase contracts. Region is used to filter offers by the region where the customer is located (an ISO 3166-1 region code). If this value is not passed in, then we leverage the caller's IP address to determine the customer's region.
userLocationstring
Example:US-CA
The user's location in ISO 3166 format. Overrides CloudFront-derived location.
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).
Acceptstring required
Example:application/json; version=2022-02-01
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 lead offers with available protection plans
Example response
{
"offers": [
{
"plans": {
"recommended": "adh",
"adh": [
{
"id": "10001-misc-elec-adh-replace-1y",
"price": 499,
"currencyCode": "USD",
"contract": {
"coverage_starts": "immediate",
"coverage_includes": "adh",
"service_type": "replace",
"replacement_type": "new",
"deductible": 0,
"term_length": 12,
"category": "consumer_electronics"
},
"title": "Extend Protection Plan - 1 Year",
"url": "https://www.extend.com/warranty-plans",
"imageUrl": "https://sdk.helloextend.com/extend_icon.png"
},
{
"id": "10001-misc-elec-adh-replace-2y",
"price": 799,
"currencyCode": "USD",
"contract": {
"coverage_starts": "immediate",
"coverage_includes": "adh",
"service_type": "replace",
"replacement_type": "new",
"deductible": 0,
"term_length": 24,
"category": "consumer_electronics"
},
"title": "Extend Protection Plan - 2 Years",
"url": "https://www.extend.com/warranty-plans",
"imageUrl": "https://sdk.helloextend.com/extend_icon.png"
},
{
"id": "10001-misc-elec-adh-replace-3y",
"price": 999,
"currencyCode": "USD",
"contract": {
"coverage_starts": "immediate",
"coverage_includes": "adh",
"service_type": "replace",
"replacement_type": "new",
"deductible": 0,
"term_length": 36,
"category": "consumer_electronics"
},
"title": "Extend Protection Plan - 3 Years",
"url": "https://www.extend.com/warranty-plans",
"imageUrl": "https://sdk.helloextend.com/extend_icon.png"
}
],
"base": [],
"roadhazard": []
},
"product": {
"listPrice": 4999,
"title": "Wireless Bluetooth Headphones",
"imageUrl": "https://example.com/products/headphones.jpg"
},
"marketing": {
"adh": {
"planId": "10001-misc-elec-adh-replace-1y",
"locale": "en",
"offerTypeButtons": {
"buttonTermLengthYears": "Years",
"headlineCTA": "Add accident protection offered by",
"learnMoreButtonText": "What's covered?"
},
"offerTypeModal": {
"learnMoreButtonText": "What's covered?",
"acceptButton": "Protect my purchase",
"benefit1": "Repairs or replacements",
"benefit1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon1_clock_base_replace.svg",
"benefit2": "Simple claims process",
"benefit2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon2_shield_base_replace.svg",
"benefit3": "Accident protection",
"benefit3Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon3_glass_adh_replace.svg",
"buttonLiteralProtectionPlan": "Protection Plan",
"buttonTermLengthYears": "Years",
"declineButton": "I don't want protection",
"footerLegal": "Offered by Extend",
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"headlineMobile": "Get protection from accidents with Extend",
"planBannerBestSeller": "Best Seller!",
"planBannerBestValue": "Best Value!",
"planDetailsLinkText": "Plan details & FAQ"
},
"offerTypeCTA": {
"button": "Add accident protection for"
},
"learnMoreModal": {
"button": "Add accident protection for",
"backgroundImageUrl": "https://s3.amazonaws.com/ccspersistenceprod-contentstaticassets04b201d4-1apqb8dyegznm/offers/learnMoreModal-default-1654273334107-learnMoreModal.backgroundImageUrl_Generic_WomanwithBox2.jpg",
"coverageBullet1": "Repairs or replacements at no additional cost",
"coverageBullet2": "Accidental damage such as breaks and drops",
"coverageBullet2Mobile": "Accidental damage such as breaks and drops",
"coverageBullet3": "Extended failure protection",
"coverageBullet3Mobile": "Extended failure protection",
"coverageBulletsHeading": "This plan covers:",
"headline": "Life happens, so we've got you covered. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"headlineMobile": "Life happens. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"planDetailsLinkText": "Plan details & FAQs",
"whyExtend1": "Simple online claims process",
"whyExtend1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_heart_base_replace.svg",
"whyExtend2": "No deductibles",
"whyExtend2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_0_base_replace.svg",
"whyExtendHeading": "Why choose Extend?"
},
"aftermarketModal": {
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"purchaseInfo1": "Protecting your:",
"purchaseInfo2": "Date of purchase:",
"purchaseInfo3": "Product Value:",
"purchaseInfo4": "Quantity purchased:"
},
"aftermarketModalConsumed": {
"bullet1": "Looks like you already purchased an Extend protection plan for this product!",
"bullet2": "In the meantime, why not check out more eligible products from this store?",
"button": "Continue to store",
"headline": "This product is already protected. Nice!"
},
"aftermarketModalExpired": {
"bullet1": "Uh oh, we cannot offer a protection plan for this product because the manufacturer's warranty is expired or about to expire",
"bullet2": "However, you can add an Extend protection plan on any eligible product you purchase today at checkout from this store!",
"button": "Continue to store",
"headline": "We can no longer offer a plan on this product :-("
}
},
"base": {
"planId": "10001-misc-elec-adh-replace-1y",
"locale": "en",
"offerTypeButtons": {
"buttonTermLengthYears": "Years",
"headlineCTA": "Add accident protection offered by",
"learnMoreButtonText": "What's covered?"
},
"offerTypeModal": {
"learnMoreButtonText": "What's covered?",
"acceptButton": "Protect my purchase",
"benefit1": "Repairs or replacements",
"benefit1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon1_clock_base_replace.svg",
"benefit2": "Simple claims process",
"benefit2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon2_shield_base_replace.svg",
"benefit3": "Accident protection",
"benefit3Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon3_glass_adh_replace.svg",
"buttonLiteralProtectionPlan": "Protection Plan",
"buttonTermLengthYears": "Years",
"declineButton": "I don't want protection",
"footerLegal": "Offered by Extend",
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"headlineMobile": "Get protection from accidents with Extend",
"planBannerBestSeller": "Best Seller!",
"planBannerBestValue": "Best Value!",
"planDetailsLinkText": "Plan details & FAQ"
},
"offerTypeCTA": {
"button": "Add accident protection for"
},
"learnMoreModal": {
"button": "Add accident protection for",
"backgroundImageUrl": "https://s3.amazonaws.com/ccspersistenceprod-contentstaticassets04b201d4-1apqb8dyegznm/offers/learnMoreModal-default-1654273334107-learnMoreModal.backgroundImageUrl_Generic_WomanwithBox2.jpg",
"coverageBullet1": "Repairs or replacements at no additional cost",
"coverageBullet2": "Accidental damage such as breaks and drops",
"coverageBullet2Mobile": "Accidental damage such as breaks and drops",
"coverageBullet3": "Extended failure protection",
"coverageBullet3Mobile": "Extended failure protection",
"coverageBulletsHeading": "This plan covers:",
"headline": "Life happens, so we've got you covered. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"headlineMobile": "Life happens. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"planDetailsLinkText": "Plan details & FAQs",
"whyExtend1": "Simple online claims process",
"whyExtend1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_heart_base_replace.svg",
"whyExtend2": "No deductibles",
"whyExtend2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_0_base_replace.svg",
"whyExtendHeading": "Why choose Extend?"
},
"aftermarketModal": {
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"purchaseInfo1": "Protecting your:",
"purchaseInfo2": "Date of purchase:",
"purchaseInfo3": "Product Value:",
"purchaseInfo4": "Quantity purchased:"
},
"aftermarketModalConsumed": {
"bullet1": "Looks like you already purchased an Extend protection plan for this product!",
"bullet2": "In the meantime, why not check out more eligible products from this store?",
"button": "Continue to store",
"headline": "This product is already protected. Nice!"
},
"aftermarketModalExpired": {
"bullet1": "Uh oh, we cannot offer a protection plan for this product because the manufacturer's warranty is expired or about to expire",
"bullet2": "However, you can add an Extend protection plan on any eligible product you purchase today at checkout from this store!",
"button": "Continue to store",
"headline": "We can no longer offer a plan on this product :-("
}
},
"roadhazard": {
"planId": "10001-misc-elec-adh-replace-1y",
"locale": "en",
"offerTypeButtons": {
"buttonTermLengthYears": "Years",
"headlineCTA": "Add accident protection offered by",
"learnMoreButtonText": "What's covered?"
},
"offerTypeModal": {
"learnMoreButtonText": "What's covered?",
"acceptButton": "Protect my purchase",
"benefit1": "Repairs or replacements",
"benefit1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon1_clock_base_replace.svg",
"benefit2": "Simple claims process",
"benefit2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon2_shield_base_replace.svg",
"benefit3": "Accident protection",
"benefit3Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon3_glass_adh_replace.svg",
"buttonLiteralProtectionPlan": "Protection Plan",
"buttonTermLengthYears": "Years",
"declineButton": "I don't want protection",
"footerLegal": "Offered by Extend",
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"headlineMobile": "Get protection from accidents with Extend",
"planBannerBestSeller": "Best Seller!",
"planBannerBestValue": "Best Value!",
"planDetailsLinkText": "Plan details & FAQ"
},
"offerTypeCTA": {
"button": "Add accident protection for"
},
"learnMoreModal": {
"button": "Add accident protection for",
"backgroundImageUrl": "https://s3.amazonaws.com/ccspersistenceprod-contentstaticassets04b201d4-1apqb8dyegznm/offers/learnMoreModal-default-1654273334107-learnMoreModal.backgroundImageUrl_Generic_WomanwithBox2.jpg",
"coverageBullet1": "Repairs or replacements at no additional cost",
"coverageBullet2": "Accidental damage such as breaks and drops",
"coverageBullet2Mobile": "Accidental damage such as breaks and drops",
"coverageBullet3": "Extended failure protection",
"coverageBullet3Mobile": "Extended failure protection",
"coverageBulletsHeading": "This plan covers:",
"headline": "Life happens, so we've got you covered. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"headlineMobile": "Life happens. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"planDetailsLinkText": "Plan details & FAQs",
"whyExtend1": "Simple online claims process",
"whyExtend1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_heart_base_replace.svg",
"whyExtend2": "No deductibles",
"whyExtend2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_0_base_replace.svg",
"whyExtendHeading": "Why choose Extend?"
},
"aftermarketModal": {
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"purchaseInfo1": "Protecting your:",
"purchaseInfo2": "Date of purchase:",
"purchaseInfo3": "Product Value:",
"purchaseInfo4": "Quantity purchased:"
},
"aftermarketModalConsumed": {
"bullet1": "Looks like you already purchased an Extend protection plan for this product!",
"bullet2": "In the meantime, why not check out more eligible products from this store?",
"button": "Continue to store",
"headline": "This product is already protected. Nice!"
},
"aftermarketModalExpired": {
"bullet1": "Uh oh, we cannot offer a protection plan for this product because the manufacturer's warranty is expired or about to expire",
"bullet2": "However, you can add an Extend protection plan on any eligible product you purchase today at checkout from this store!",
"button": "Continue to store",
"headline": "We can no longer offer a plan on this product :-("
}
}
},
"lead": {
"leadToken": "a16dc041-e03a-4c74-b77a-37cbb065e6e7",
"purchasePrice": 2999,
"formattedPurchasePrice": "$29.99",
"listPrice": 3999,
"offerPriceType": "product_list_price",
"quantity": 1,
"referenceId": "SKU-12345",
"productTitle": "Wireless Bluetooth Headphones",
"transactionDate": 1647470325503,
"transactionId": "123EY1",
"formattedListPrice": "$39.99",
"imageUrl": "https://example.com/images/product-12345.jpg",
"category": "Electronics"
}
}
],
"limit": 25,
"nextPageCursor": "eyJpdGVtSWQiOiJMRUFEOjphOTE2YmNjYS0yYjVhLTQ4NTgtOThhYS04OGZmODQxZTdhOTgiLCJzb3J0S2V5IjoiTEVBRDo6YTkxNmJjY2EtMmI1YS00ODU4LTk4YWEtODhmZjg0MWU3YTk4IiwicHJvZHVjdFRyYW5zYWN0aW9uSWQiOiJhNGQ3YTNmOS1mMzJmLTRkNDctOTVhZS0wZWMwNjkxYmM1ZjMiLCJzZWxsZXJJZCI6IjJkNDc4ZWE0LWU1MzMtNDU0YS1hOWExLWRiNTQ1ODE3Njg5YSJ9"
}