Return a batch of FOEP data for a set of SKUs
Learn how to return a set of responses for up to 40 requests for featured offer extended price data.
Learn how to return a set of responses for up to 40 requests for featured offer extended price data.
To help a seller compete for featured offer placement on the product detail page (for items listed in new condition that ship nationwide), use the getFeaturedOfferExpectedPriceBatch
. To compete for selection as the featured offer, the seller and their listed items must be eligible.
You can help the seller compete by returning the FOEP for a SKU. Because competing offers can change, featured offer status isn't guaranteed. Different offers can be featured based on other factors, including fulfillment capabilities to a specific customer. The getFeaturedOfferExpectedPriceBatch
operation returns batch responses that contain up to 40 FOEP requests. If there are no other competing offers that ship nationwide, Amazon might not return an FOEP value.
Warning
FOEP values are automatically generated, so be sure to carefully verify the calculated values. All sellers using the API are responsible, as the retailer of record for their offers, for setting their prices independently and in compliance with applicable laws and pricing regulations.
The getFeaturedOfferExpectedPriceBatch
operation is available in all marketplaces. sampleLocation
is the representative location for the segment where the offer is featured.You can use sampleLocation
in the request to the getFeaturedOfferExpectedPriceBatch
operation to get the Featured Offer Expected Price (FOEP) for a specific location. This feature is currently available in US, CA, MX, BR, DE, UK, IT, FR, ES, IN, JP, AU, SG marketplaces. For more information about Product Pricing API operations, associated data types, and schemas, refer to the Product Pricing v2022-05-01 API Reference.
Prerequisites
To complete this tutorial, you must have:
- Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
- The Pricing role assigned to your developer profile.
- The Pricing role selected on the app registration page for your application.
Get the FOEP data for a set of SKUs
The getFeaturedOfferExpectedPriceBatch
operation is a batch API. The batch request must use an HTTP POST
method with a body parameter that contains a list or set of individual requests. The response is a batch response that contains the list of individual HTTP responses, where each response maps to one of the original requested SKUs in the batch.
To return FOEP data, call the getFeaturedOfferExpectedPriceBatch
operation.
General recommendations
When to call the getFeaturedOfferExpectedPriceBatch
operation
getFeaturedOfferExpectedPriceBatch
operationIf your seller is subscribed to ANY_OFFER_CHANGED
notifications and receives a notification for an ASIN that they want to compete with for the feature offer, you can request FOEP data.
About the resultStatus
response property
resultStatus
response propertyThe resultStatus
response property indicates if Amazon returned an FOEP value. This also provides the reason why no FOEP value is returned, when applicable. The possible values are:
Result status | Description |
---|---|
VALID_FOEP | The offer was eligible for FOEP. Amazon returned a valid FOEP value. |
NO_COMPETING_OFFER | The offer might be eligible to become featured, but there are no other offers for that ASIN that are also eligible to become the featured offer. |
OFFER_NOT_ELIGIBLE | The offer was not eligible to become the featured offer. |
OFFER_NOT_FOUND | The offer was not found. It might be unbuyable, or the merchant might not be qualified to be featured. |
ASIN_NOT_ELIGIBLE | The ASIN is not eligible for an FOEP value. |
Availability of the getFeaturedOfferExpectedPriceBatch
operation
getFeaturedOfferExpectedPriceBatch
operationUpdated about 21 hours ago