v1

latestOpenAPI 3.0.12026-07-243902.3 MB

Offers

Get Offer information

Returns warranty plans and pricing for a specific product.

get/offers

Query parameters

storeIdstring uuid required

Example:c57ed096-24ef-49a4-a20a-d1b8bf770980

Unique identifier for a store on Extend

productIdstring uuid required

This is the unique identifier that identifies the product. This can be a product SKU, or variant id. A referenceId may contain special characters except for the following: %,\,". Special characters should not be at the end of a referenceId. It must be url encoded if it contains special characters.

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 <a href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'>ISO 3166-1</a> region code). If this value is not passed in, then we leverage the caller’s IP address to determine the customer’s region.

localestring IETF Language Tag

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).

dynamicPricingstring

Example:true

A flag to enable dynamic pricing when retrieving an offer. Merchant must be configured for Purchase Price as the Offer Price Type

pricestring

Example:2400

Override price in terms of the smallest currency unit to retrieve a dynamic offer. Dynamic pricing must be set to true and merchant must be configured for Purchase Price as the Offer Price Type. Note - This field must contain a value when attempting to generate Offer if Store has Offers By Category feature enabled.<p> <ul><li>$19.99 would be 1999</li><li>1.234,56 € would be 123456</li><li>£ 1,999.99 would be 199999</li></ul>

categorystring

Example:electronics

Category of the product in Merchant's catalog. Note - This field must contain a value when attempting to generate Offer if Store has Offers By Category feature enabled. Special characters should not be at the end of a category. It must be url encoded if it contains special characters.

removeMarketingstring boolean

Example:true

This flag is used to remove marketing offers from the response. If this flag is set to true, then marketing offers will not be included in the response.

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.

X-Extend-Client-IPstring

If your server performs Server Side Rendering, please provide the X-Extend-Client-IP header of the customer requesting your content. We use this optional header to determine more granular offer eligibility. If this header is not passed in, then we leverage the caller’s IP address to determine this information.

Response

Returns the information about an offer

Example response

{
  "plans": {
    "recommended": "adh",
    "adh": [
      {
        "id": "AmazingAppliancePlan",
        "price": 199,
        "contract": {
          "coverage_starts": "immediate",
          "coverage_includes": "adh",
          "service_type": "replace",
          "replacement_type": "new",
          "term_length": 36,
          "category": "consumer_electronics"
        },
        "imageUrl": "https://sdk.helloextend.com/extend_icon.png",
        "title": "Extend Protection Plan - AV Receiver"
      }
    ],
    "base": [
      {
        "id": "AmazingAppliancePlan",
        "price": 199,
        "contract": {
          "coverage_starts": "immediate",
          "coverage_includes": "adh",
          "service_type": "replace",
          "replacement_type": "new",
          "term_length": 36,
          "category": "consumer_electronics"
        },
        "imageUrl": "https://sdk.helloextend.com/extend_icon.png",
        "title": "Extend Protection Plan - AV Receiver"
      }
    ],
    "roadhazard": [
      {
        "id": "AmazingAppliancePlan",
        "price": 199,
        "contract": {
          "coverage_starts": "immediate",
          "coverage_includes": "adh",
          "service_type": "replace",
          "replacement_type": "new",
          "term_length": 36,
          "category": "consumer_electronics"
        },
        "imageUrl": "https://sdk.helloextend.com/extend_icon.png",
        "title": "Extend Protection Plan - AV Receiver"
      }
    ]
  },
  "product": {
    "listPrice": 1999,
    "title": "Explosive Tennis Balls",
    "imageUrl": "https://bit.ly/2VN88Jf"
  },
  "marketing": {
    "adh": {
      "planId": "10001-misc-elec-adh-replace-1y",
      "locale": "en",
      "offerTypeButtons": {
        "buttonTermLengthYears": "1"
      }
    },
    "base": {
      "planId": "10001-misc-elec-adh-replace-1y",
      "locale": "en",
      "offerTypeButtons": {
        "buttonTermLengthYears": "1"
      }
    },
    "roadhazard": {
      "planId": "10001-misc-elec-adh-replace-1y",
      "locale": "en",
      "offerTypeButtons": {
        "buttonTermLengthYears": "1"
      }
    }
  }
}