---
title: "Get Lead Offers"
method: GET
path: "/leads/offers"
tags: ["Leads"]
---

# Get Lead Offers

`GET /leads/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.

## Query parameters

- `storeId` string, uuid, required
- `transactionId` string, required
- `limit` integer
- `cursor` string
- `locale` string
- `removeMarketing` 'true' | 'false'
- `region` string, ISO 3166-1
- `userLocation` string

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

Returns lead offers with available protection plans

- object — Batch lead offers response
  - `offers` object[]
    - `plans` object
      - `recommended` 'adh' | 'base' | 'roadhazard' — The protection plan type that Extend recommends the merchant displays to the user. Possible values include `base` (for mechanical and electrical failures/defects), or `adh` (for accidents such as drop or liquid damage). The recommended protection plan type will be accessible in this response as a key on this plans object.
      - `adh` object[]
        - `id` string — Unique identifier for a warranty Plan
        - `price` number — The offer price, in base units
        - `currencyCode` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD'
        - `contract` object — Additional information about this extended warranty contract
          - `coverage_starts` string — Describes when the contract term begins, relative to the manufacturer’s warranty length. For example, “immediate” means coverage starts immediately on the purchase date, and “after” means coverage starts after the manufacturer’s warranty has expired
          - `coverage_includes` string — Possible values include “base”, which means the extended warranty is a base plan covering mechanical and electrical failures through normal use, or “adh”, which means the plan includes coverage for accidental damage (i.e. “Accidental Damage in Handling”)
          - `service_type` string — This is the claims resolution service the plan includes. Responses include “replacement” (the damaged item is replaced by a new or refurbished equivalent), “repair_depot” (the customer mails the damaged item to a repair facility), or “repair_onsite” (a repair technician goes out to the customer’s home to repair the item)
          - `replacement_type` string — Indicates whether the damaged item will be replaced by a “new” or “refurbished” item
          - `deductible` number — The amount of the deductible charged to the customer during a claim, if there is one. For most Extend protection plans, there is no deductible
          - `term_length` number — The length of the extended warranty coverage, in months
          - `category` string — An item mapped to the Extend SDK is placed in a specific category, such as, consumer_electronics, misc, computer, tire, etc
        - `imageUrl` string, uri — The imageUrl for the warranty plan. Use this as the product image for the warranty plan SKU(s) in your store
        - `title` string — The name of the warranty plan
        - `url` string — A link to the extended warranty plan terms and information. Any offer display must include a “Learn More” or “See Plan Details” call-to-action that enables the customer to see exactly what the warranty plan covers
      - `base` object[]
        - `id` string — Unique identifier for a warranty Plan
        - `price` number — The offer price, in base units
        - `currencyCode` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD'
        - `contract` object — Additional information about this extended warranty contract
          - `coverage_starts` string — Describes when the contract term begins, relative to the manufacturer’s warranty length. For example, “immediate” means coverage starts immediately on the purchase date, and “after” means coverage starts after the manufacturer’s warranty has expired
          - `coverage_includes` string — Possible values include “base”, which means the extended warranty is a base plan covering mechanical and electrical failures through normal use, or “adh”, which means the plan includes coverage for accidental damage (i.e. “Accidental Damage in Handling”)
          - `service_type` string — This is the claims resolution service the plan includes. Responses include “replacement” (the damaged item is replaced by a new or refurbished equivalent), “repair_depot” (the customer mails the damaged item to a repair facility), or “repair_onsite” (a repair technician goes out to the customer’s home to repair the item)
          - `replacement_type` string — Indicates whether the damaged item will be replaced by a “new” or “refurbished” item
          - `deductible` number — The amount of the deductible charged to the customer during a claim, if there is one. For most Extend protection plans, there is no deductible
          - `term_length` number — The length of the extended warranty coverage, in months
          - `category` string — An item mapped to the Extend SDK is placed in a specific category, such as, consumer_electronics, misc, computer, tire, etc
        - `imageUrl` string, uri — The imageUrl for the warranty plan. Use this as the product image for the warranty plan SKU(s) in your store
        - `title` string — The name of the warranty plan
        - `url` string — A link to the extended warranty plan terms and information. Any offer display must include a “Learn More” or “See Plan Details” call-to-action that enables the customer to see exactly what the warranty plan covers
      - `roadhazard` object[]
        - `id` string — Unique identifier for a warranty Plan
        - `price` number — The offer price, in base units
        - `currencyCode` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD'
        - `contract` object — Additional information about this extended warranty contract
          - `coverage_starts` string — Describes when the contract term begins, relative to the manufacturer’s warranty length. For example, “immediate” means coverage starts immediately on the purchase date, and “after” means coverage starts after the manufacturer’s warranty has expired
          - `coverage_includes` string — Possible values include “base”, which means the extended warranty is a base plan covering mechanical and electrical failures through normal use, or “adh”, which means the plan includes coverage for accidental damage (i.e. “Accidental Damage in Handling”)
          - `service_type` string — This is the claims resolution service the plan includes. Responses include “replacement” (the damaged item is replaced by a new or refurbished equivalent), “repair_depot” (the customer mails the damaged item to a repair facility), or “repair_onsite” (a repair technician goes out to the customer’s home to repair the item)
          - `replacement_type` string — Indicates whether the damaged item will be replaced by a “new” or “refurbished” item
          - `deductible` number — The amount of the deductible charged to the customer during a claim, if there is one. For most Extend protection plans, there is no deductible
          - `term_length` number — The length of the extended warranty coverage, in months
          - `category` string — An item mapped to the Extend SDK is placed in a specific category, such as, consumer_electronics, misc, computer, tire, etc
        - `imageUrl` string, uri — The imageUrl for the warranty plan. Use this as the product image for the warranty plan SKU(s) in your store
        - `title` string — The name of the warranty plan
        - `url` string — A link to the extended warranty plan terms and information. Any offer display must include a “Learn More” or “See Plan Details” call-to-action that enables the customer to see exactly what the warranty plan covers
    - `product` object
      - `listPrice` number, required — The base retail price of the product (in cents)
      - `title` string — Product name
      - `imageUrl` string, uri — A url pointing to the primary image for the product
    - `marketing` object
      - `adh` object
        - `planId` string
        - `locale` string
        - `offerTypeButtons` object
          - `buttonTermLengthYears` string
          - `headlineCTA` string
          - `learnMoreButtonText` string
        - `offerTypeModal` object
          - `learnMoreButtonText` string
          - `acceptButton` string
          - `benefit1` string
          - `benefit1Icon` string
          - `benefit2` string
          - `benefit2Icon` string
          - `benefit3` string
          - `benefit3Icon` string
          - `buttonLiteralProtectionPlan` string
          - `buttonTermLengthYears` string
          - `declineButton` string
          - `footerLegal` string
          - `headline` string
          - `headlineMobile` string
          - `planBannerBestSeller` string
          - `planBannerBestValue` string
          - `planDetailsLinkText` string
        - `offerTypeCTA` object
          - `button` string
        - `learnMoreModal` object
          - `button` string
          - `backgroundImageUrl` string
          - `coverageBullet1` string
          - `coverageBullet2` string
          - `coverageBullet2Mobile` string
          - `coverageBullet3` string
          - `coverageBullet3Mobile` string
          - `coverageBulletsHeading` string
          - `headline` string
          - `headlineMobile` string
          - `planDetailsLinkText` string
          - `whyExtend1` string
          - `whyExtend1Icon` string
          - `whyExtend2` string
          - `whyExtend2Icon` string
          - `whyExtendHeading` string
        - `aftermarketModal` object
          - `headline` string
          - `purchaseInfo1` string
          - `purchaseInfo2` string
          - `purchaseInfo3` string
          - `purchaseInfo4` string
        - `aftermarketModalConsumed` object
          - `bullet1` string
          - `bullet2` string
          - `button` string
          - `headline` string
        - `aftermarketModalExpired` object
          - `bullet1` string
          - `bullet2` string
          - `button` string
          - `headline` string
      - `base` object
        - `planId` string
        - `locale` string
        - `offerTypeButtons` object
          - `buttonTermLengthYears` string
          - `headlineCTA` string
          - `learnMoreButtonText` string
        - `offerTypeModal` object
          - `learnMoreButtonText` string
          - `acceptButton` string
          - `benefit1` string
          - `benefit1Icon` string
          - `benefit2` string
          - `benefit2Icon` string
          - `benefit3` string
          - `benefit3Icon` string
          - `buttonLiteralProtectionPlan` string
          - `buttonTermLengthYears` string
          - `declineButton` string
          - `footerLegal` string
          - `headline` string
          - `headlineMobile` string
          - `planBannerBestSeller` string
          - `planBannerBestValue` string
          - `planDetailsLinkText` string
        - `offerTypeCTA` object
          - `button` string
        - `learnMoreModal` object
          - `button` string
          - `backgroundImageUrl` string
          - `coverageBullet1` string
          - `coverageBullet2` string
          - `coverageBullet2Mobile` string
          - `coverageBullet3` string
          - `coverageBullet3Mobile` string
          - `coverageBulletsHeading` string
          - `headline` string
          - `headlineMobile` string
          - `planDetailsLinkText` string
          - `whyExtend1` string
          - `whyExtend1Icon` string
          - `whyExtend2` string
          - `whyExtend2Icon` string
          - `whyExtendHeading` string
        - `aftermarketModal` object
          - `headline` string
          - `purchaseInfo1` string
          - `purchaseInfo2` string
          - `purchaseInfo3` string
          - `purchaseInfo4` string
        - `aftermarketModalConsumed` object
          - `bullet1` string
          - `bullet2` string
          - `button` string
          - `headline` string
        - `aftermarketModalExpired` object
          - `bullet1` string
          - `bullet2` string
          - `button` string
          - `headline` string
      - `roadhazard` object
        - `planId` string
        - `locale` string
        - `offerTypeButtons` object
          - `buttonTermLengthYears` string
          - `headlineCTA` string
          - `learnMoreButtonText` string
        - `offerTypeModal` object
          - `learnMoreButtonText` string
          - `acceptButton` string
          - `benefit1` string
          - `benefit1Icon` string
          - `benefit2` string
          - `benefit2Icon` string
          - `benefit3` string
          - `benefit3Icon` string
          - `buttonLiteralProtectionPlan` string
          - `buttonTermLengthYears` string
          - `declineButton` string
          - `footerLegal` string
          - `headline` string
          - `headlineMobile` string
          - `planBannerBestSeller` string
          - `planBannerBestValue` string
          - `planDetailsLinkText` string
        - `offerTypeCTA` object
          - `button` string
        - `learnMoreModal` object
          - `button` string
          - `backgroundImageUrl` string
          - `coverageBullet1` string
          - `coverageBullet2` string
          - `coverageBullet2Mobile` string
          - `coverageBullet3` string
          - `coverageBullet3Mobile` string
          - `coverageBulletsHeading` string
          - `headline` string
          - `headlineMobile` string
          - `planDetailsLinkText` string
          - `whyExtend1` string
          - `whyExtend1Icon` string
          - `whyExtend2` string
          - `whyExtend2Icon` string
          - `whyExtendHeading` string
        - `aftermarketModal` object
          - `headline` string
          - `purchaseInfo1` string
          - `purchaseInfo2` string
          - `purchaseInfo3` string
          - `purchaseInfo4` string
        - `aftermarketModalConsumed` object
          - `bullet1` string
          - `bullet2` string
          - `button` string
          - `headline` string
        - `aftermarketModalExpired` object
          - `bullet1` string
          - `bullet2` string
          - `button` string
          - `headline` string
    - `lead` object — Enriched lead object returned in batch lead offers response
      - `leadToken` string — Unique identifier for the lead
      - `purchasePrice` number — The purchase price amount in base units
      - `formattedPurchasePrice` string — The formatted purchase price
      - `listPrice` number — The list price amount in base units
      - `offerPriceType` string — The offer price type configured for the store
      - `quantity` number — The amount of line items purchased
      - `quantityConsumed` number — The number of units that have been used to create contracts
      - `status` 'live' | 'consumed' | 'expired' — The current status of the lead
      - `referenceId` string — The merchant's product reference ID
      - `productTitle` string — The name of the product
      - `transactionDate` number — The date of the transaction in milliseconds since epoch
      - `transactionId` string — The merchant's transaction or order ID
      - `formattedListPrice` string — The formatted list price with currency symbol
      - `imageUrl` string — URL of the product image
      - `category` string — The product category
  - `limit` number — The page size limit
  - `nextPageCursor` string — Cursor for fetching the next page of results

## Other responses

- `400` — The request to the endpoint was invalid

---

[API](https://skmtc.dev/extend/apis/leads-api.md) · [All operations](https://skmtc.dev/extend/apis/leads-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/extend/leads-api/revisions/76403e33d7d6/schema)