Product Pricing API v2022-05-01 reference

Retrieve product pricing and offer information for Amazon Marketplace products.

Overview

The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products.

For more information, see the Product Pricing v2022-05-01 Use Case Guide.

Version information

Version : 2022-05-01

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Operations

getFeaturedOfferExpectedPriceBatch

Paths

POST /batches/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice

Operation: getFeaturedOfferExpectedPriceBatch

Description

Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may change, and different offers may be featured based on other factors, including fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text.

Usage Plan:

Rate (requests per second)Burst
0.0331

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
BodygetFeaturedOfferExpectedPriceBatchRequestBody
required
The request body for the getFeaturedOfferExpectedPriceBatch operation.GetFeaturedOfferExpectedPriceBatchRequest

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetFeaturedOfferExpectedPriceBatchResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP CodeDescriptionSchema
400Request has missing or invalid parameters and cannot be parsed.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string):Unique request reference identifier.
Errors
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
Errors
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
Errors
404The specified resource does not exist.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string):Unique request reference identifier.
Errors
429The frequency of requests was greater than allowed.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
Errors
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
Errors
503Temporary overloading or maintenance of the server.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
Errors

Definitions

GetFeaturedOfferExpectedPriceBatchRequest

The request body for the getFeaturedOfferExpectedPriceBatch operation.

NameDescriptionSchema
requests
optional
A batched list of featured offer expected price requests.FeaturedOfferExpectedPriceRequestList

FeaturedOfferExpectedPriceRequestList

A batched list of featured offer expected price requests.

Type : < FeaturedOfferExpectedPriceRequest > array

Min items : 1

FeaturedOfferExpectedPriceRequest

An individual featured offer expected price request for a particular SKU.

Polymorphism : Composition

NameDescriptionSchema
uri
required
The URI associated with an individual request within a batch. For FeaturedOfferExpectedPrice, this should be '/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice'.string
method
required
The HTTP method associated with an individual request within a batch.HttpMethod
body
optional
Additional HTTP body information associated with an individual request within a batch.HttpBody
headers
optional
A mapping of additional HTTP headers to send/receive for an individual request within a batch.HttpHeaders
marketplaceId
required
A marketplace identifier. Specifies the marketplace for which data is returned.MarketplaceId
sku
required
The seller SKU of the item.Sku

FeaturedOfferExpectedPriceRequestParams

The parameters for an individual request.

NameDescriptionSchema
marketplaceId
required
A marketplace identifier. Specifies the marketplace for which data is returned.MarketplaceId
sku
required
The seller SKU of the item.Sku

GetFeaturedOfferExpectedPriceBatchResponse

The response schema for the getFeaturedOfferExpectedPriceBatch operation.

NameDescriptionSchema
responses
optional
A batched list of featured offer expected price responses.FeaturedOfferExpectedPriceResponseList

FeaturedOfferExpectedPriceResponseList

A batched list of featured offer expected price responses.

Type : < FeaturedOfferExpectedPriceResponse > array

Min items : 1

FeaturedOfferExpectedPriceResponse

Polymorphism : Composition

NameDescriptionSchema
headers
required
A mapping of additional HTTP headers to send/receive for an individual request within a batch.HttpHeaders
status
required
The HTTP status line associated with the response to an individual request within a batch. For more information, consult RFC 2616.HttpStatusLine
request
required
Use these request parameters to map the response back to the request.FeaturedOfferExpectedPriceRequestParams
body
optional
The featured offer expected price response data for a requested SKU.FeaturedOfferExpectedPriceResponseBody

Errors

A list of error responses returned when a request is unsuccessful.

NameDescriptionSchema
errors
required
One or more unexpected errors occurred during the operation.ErrorList

FeaturedOfferExpectedPriceResponseBody

The featured offer expected price response data for a requested SKU.

NameDescriptionSchema
offerIdentifier
required
Metadata that identifies the target offer for which the featured offer expected price result data was computed.OfferIdentifier
featuredOfferExpectedPriceResults
optional
The featured offer expected price results for the requested target offer.FeaturedOfferExpectedPriceResultList
errors
optional
The errors that occurred if the operation was not successful (HTTP status code non-200).ErrorList

FeaturedOfferExpectedPriceResultList

A list of featured offer expected price results for the requested offer.

Type : < FeaturedOfferExpectedPriceResult > array

FeaturedOfferExpectedPriceResult

The featured offer expected price result data for the requested offer.

NameDescriptionSchema
featuredOfferExpectedPrice
optional
The item price at or below which the target offer may be featured.FeaturedOfferExpectedPrice
resultStatus
required
The status of the featured offer expected price computation. Possible values include VALID_FOEP, NO_COMPETING_OFFER, OFFER_NOT_ELIGIBLE, OFFER_NOT_FOUND.string
competingFeaturedOffer
optional
The offer that will likely be the featured offer if the target offer is priced above its featured offer expected price. If the target offer is currently the featured offer, this property will be different than currentFeaturedOffer.FeaturedOffer
currentFeaturedOffer
optional
The offer that is currently the featured offer. If the target offer is not currently featured, this property will be equal to competingFeaturedOffer.FeaturedOffer

FeaturedOfferExpectedPrice

The item price at or below which the target offer may be featured.

NameDescriptionSchema
listingPrice
required
A computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions).MoneyType
points
optional
The number of Amazon Points offered with the purchase of an item, and their monetary value.Points

FeaturedOffer

NameDescriptionSchema
offerIdentifier
required
An offer identifier used to identify the merchant of the featured offer. Since this may not belong to the requester, the SKU field will be omitted.OfferIdentifier
condition
optional
The item condition.Condition
price
optional
The current active price of the offer.Price

HttpHeaders

A mapping of additional HTTP headers to send/receive for an individual request within a batch.

Type : < string, string > map

HttpStatusLine

The HTTP status line associated with the response to an individual request within a batch. For more information, consult RFC 2616.

NameDescriptionSchema
statusCode
optional
The HTTP response Status-Code.
Minimum value : 100
Maximum value : 599
integer
reasonPhrase
optional
The HTTP response Reason-Phase.string

HttpBody

Additional HTTP body information associated with an individual request within a batch.

Type : object

HttpMethod

The HTTP method associated with an individual request within a batch.

Type : enum

ValueDescription
GETGET
PUTPUT
PATCHPATCH
DELETEDELETE
POSTPOST

BatchRequest

The common properties for individual requests within a batch.

NameDescriptionSchema
uri
required
The URI associated with an individual request within a batch. For FeaturedOfferExpectedPrice, this should be '/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice'.string
method
required
The HTTP method associated with an individual request within a batch.HttpMethod
body
optional
Additional HTTP body information associated with an individual request within a batch.HttpBody
headers
optional
A mapping of additional HTTP headers to send/receive for an individual request within a batch.HttpHeaders

BatchResponse

The common properties for responses to individual requests within a batch.

NameDescriptionSchema
headers
required
A mapping of additional HTTP headers to send/receive for an individual request within a batch.HttpHeaders
status
required
The HTTP status line associated with the response to an individual request within a batch. For more information, consult RFC 2616.HttpStatusLine

OfferIdentifier

Identifies an offer from a particular seller on an ASIN.

NameDescriptionSchema
marketplaceId
required
A marketplace identifier.MarketplaceId
sellerId
optional
The seller identifier for the offer.string
sku
optional
The seller stock keeping unit (SKU) of the item. This will only be present for the target offer, which belongs to the requesting seller.string
asin
required
The Amazon identifier for the item.Asin
fulfillmentType
optional
The fulfillment type for the offer.FulfillmentType

MoneyType

NameDescriptionSchema
currencyCode
optional
The currency code in ISO 4217 format.string
amount
optional
The monetary value.number

Price

NameDescriptionSchema
listingPrice
required
The listing price of the item excluding any promotions.MoneyType
shippingPrice
optional
The shipping cost of the product. Note that the shipping cost is not always available.MoneyType
points
optional
The number of Amazon Points offered with the purchase of an item, and their monetary value.Points

Points

NameDescriptionSchema
pointsNumber
optional
The number of points.integer (int32)
pointsMonetaryValue
optional
The monetary value of the points.MoneyType

FulfillmentType

Indicates whether the item is fulfilled by Amazon or by the seller (merchant).

Type : enum

ValueDescription
AFNFulfilled by Amazon.
MFNFulfilled by the seller.

MarketplaceId

A marketplace identifier. Specifies the marketplace for which data is returned.

Type : string

Sku

The seller SKU of the item.

Type : string

Condition

The condition of the item.

Type : enum

ValueDescription
NewNew
UsedUsed
CollectibleCollectible
RefurbishedRefurbished
ClubClub

Asin

The Amazon Standard Identification Number (ASIN) of the item.

Type : string

ErrorList

A list of error responses returned when a request is unsuccessful.

Type : < Error > array

Error

Error response returned when the request is unsuccessful.

NameDescriptionSchema
code
required
An error code that identifies the type of error that occurred.string
message
required
A message that describes the error condition.string
details
optional
Additional information that can help the caller understand or fix the issue.string