Product Pricing API v0 reference

AmazonSPAPI

# Overview

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

# Version information

Version : v0

# Operations

getPricing
getCompetitivePricing
getListingOffers
getItemOffers
getItemOffersBatch
getListingOffersBatch

# Paths

# getPricing

GET /products/pricing/v0/price

# Description

Returns pricing information for a seller's offer listings based on seller SKU or ASIN.

Usage Plan:

Rate (requests per second) Burst
10 20

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 (opens new window).

# Parameters

Type Name Description Schema
Query MarketplaceId
required
A marketplace identifier. Specifies the marketplace for which prices are returned. string
Query Asins
optional
A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace.
Max count : 20
< string > array
Query Skus
optional
A list of up to twenty seller SKU values used to identify items in the given marketplace.
Max count : 20
< string > array
Query ItemType
required
Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. enum (ItemType)
Query ItemCondition
optional
Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. enum (ItemCondition)
Query OfferType
optional
Indicates whether to request pricing information for the seller's B2C or B2B offers. Default is B2C. enum (OfferType)

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetPricingResponse
400 Request 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 ID.
GetPricingResponse
401 The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetPricingResponse
403 Indicates 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 ID.
GetPricingResponse
404 The 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 ID.
GetPricingResponse
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetPricingResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetPricingResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetPricingResponse

# getCompetitivePricing

GET /products/pricing/v0/competitivePrice

# Description

Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN.

Usage Plan:

Rate (requests per second) Burst
10 20

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 (opens new window).

# Parameters

Type Name Description Schema
Query MarketplaceId
required
A marketplace identifier. Specifies the marketplace for which prices are returned. string
Query Asins
optional
A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace.
Max count : 20
< string > array
Query Skus
optional
A list of up to twenty seller SKU values used to identify items in the given marketplace.
Max count : 20
< string > array
Query ItemType
required
Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. Possible values: Asin, Sku. enum (ItemType)
Query CustomerType
optional
Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer. enum (CustomerType)

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetPricingResponse
400 Request 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 ID.
GetPricingResponse
401 The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetPricingResponse
403 Indicates 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 ID.
GetPricingResponse
404 The 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 ID.
GetPricingResponse
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetPricingResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetPricingResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetPricingResponse

# getListingOffers

GET /products/pricing/v0/listings/{SellerSKU}/offers

# Description

Returns the lowest priced offers for a single SKU listing.

Usage Plan:

Rate (requests per second) Burst
5 10

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 (opens new window).

# Parameters

Type Name Description Schema
Query MarketplaceId
required
A marketplace identifier. Specifies the marketplace for which prices are returned. string
Query ItemCondition
required
Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. enum (ItemCondition)
Path SellerSKU
required
Identifies an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. string
Query CustomerType
optional
Indicates whether to request Consumer or Business offers. Default is Consumer. enum (CustomerType)

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetOffersResponse
400 Request 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 ID.
GetOffersResponse
401 The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetOffersResponse
403 Indicates 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 ID.
GetOffersResponse
404 The 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 ID.
GetOffersResponse
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetOffersResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetOffersResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetOffersResponse

# getItemOffers

GET /products/pricing/v0/items/{Asin}/offers

# Description

Returns the lowest priced offers for a single item based on ASIN.

Usage Plan:

Rate (requests per second) Burst
5 10

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 (opens new window).

# Parameters

Type Name Description Schema
Query MarketplaceId
required
A marketplace identifier. Specifies the marketplace for which prices are returned. string
Query ItemCondition
required
Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. enum (ItemCondition)
Path Asin
required
The Amazon Standard Identification Number (ASIN) of the item. string
Query CustomerType
optional
Indicates whether to request Consumer or Business offers. Default is Consumer. enum (CustomerType)

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetOffersResponse
400 Request 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 ID.
GetOffersResponse
401 The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetOffersResponse
403 Indicates 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 ID.
GetOffersResponse
404 The 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 ID.
GetOffersResponse
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetOffersResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetOffersResponse
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetOffersResponse

# getItemOffersBatch

POST /batches/products/pricing/v0/itemOffers

# Description

Returns the lowest priced offers for a batch of items based on ASIN.

Usage Plan:

Rate (requests per second) Burst
.5 1

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 (opens new window).

# Parameters

Type Name Description Schema
Body getItemOffersBatchRequestBody
required
The request associated with the getItemOffersBatch API call. GetItemOffersBatchRequest

# Responses

HTTP Code Description Schema
200 Indicates that requests were run in batch. Check the batch response status lines for information on whether a batch request succeeded.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetItemOffersBatchResponse
400 Request 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 ID.
Errors
401 The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
Errors
403 Indicates 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 ID.
Errors
404 The 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 ID.
Errors
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
Errors
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
Errors
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
Errors

# getListingOffersBatch

POST /batches/products/pricing/v0/listingOffers

# Description

Returns the lowest priced offers for a batch of listings by SKU.

Usage Plan:

Rate (requests per second) Burst
.5 1

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 (opens new window).

# Parameters

Type Name Description Schema
Body getListingOffersBatchRequestBody
required
The request associated with the getListingOffersBatch API call. GetListingOffersBatchRequest

# Responses

HTTP Code Description Schema
200 Indicates that requests were run in batch. Check the batch response status lines for information on whether a batch request succeeded.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetListingOffersBatchResponse
400 Request 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 ID.
Errors
401 The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
Errors
403 Indicates 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 ID.
Errors
404 The 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 ID.
Errors
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
Errors
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
Errors
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
Errors

# Definitions

# GetItemOffersBatchRequest

The request associated with the getItemOffersBatch API call.

Name Description Schema
requests
optional
A list of getItemOffers batched requests to run. ItemOffersRequestList

# GetListingOffersBatchRequest

The request associated with the getListingOffersBatch API call.

Name Description Schema
requests
optional
A list of getItemOffers batched requests to run. ListingOffersRequestList

# ListingOffersRequestList

A list of getItemOffers batched requests to run.

Type : < ListingOffersRequest > array

Min items : 1
Max items : 20

# ItemOffersRequestList

A list of getItemOffers batched requests to run.

Type : < ItemOffersRequest > array

Min items : 1
Max items : 20

# BatchOffersRequestParams

Name Description Schema
MarketplaceId
required
A marketplace identifier. Specifies the marketplace for which prices are returned. MarketplaceId
ItemCondition
required
- ItemCondition
CustomerType
optional
- CustomerType

# ItemOffersRequest

Polymorphism : Composition

Name Description Schema
uri
required
The full URI corresponding to the API intended for request, including path parameter substitutions. string
method
required
The HTTP method associated with the individual APIs being called as part of the batch request. HttpMethod
headers
optional
A mapping of additional HTTP headers to send/receive for the individual batch request. HttpRequestHeaders
MarketplaceId
required
A marketplace identifier. Specifies the marketplace for which prices are returned. MarketplaceId
ItemCondition
required
- ItemCondition
CustomerType
optional
- CustomerType

# ListingOffersRequest

Polymorphism : Composition

Name Description Schema
uri
required
The full URI corresponding to the API intended for request, including path parameter substitutions. string
method
required
The HTTP method associated with the individual APIs being called as part of the batch request. HttpMethod
headers
optional
A mapping of additional HTTP headers to send/receive for the individual batch request. HttpRequestHeaders
MarketplaceId
required
A marketplace identifier. Specifies the marketplace for which prices are returned. MarketplaceId
ItemCondition
required
- ItemCondition
CustomerType
optional
- CustomerType

# GetItemOffersBatchResponse

The response associated with the getItemOffersBatch API call.

Name Description Schema
responses
optional
A list of getItemOffers batched responses. ItemOffersResponseList

# GetListingOffersBatchResponse

The response associated with the getListingOffersBatch API call.

Name Description Schema
responses
optional
A list of getListingOffers batched responses. ListingOffersResponseList

# ItemOffersResponseList

A list of getItemOffers batched responses.

Type : < ItemOffersResponse > array

Min items : 1
Max items : 20

# ListingOffersResponseList

A list of getListingOffers batched responses.

Type : < ListingOffersResponse > array

Min items : 1
Max items : 20

# BatchOffersResponse

Name Description Schema
headers
optional
A mapping of additional HTTP headers to send/receive for the individual batch request. HttpResponseHeaders
status
optional
The HTTP status line associated with the response. For more information, consult RFC 2616 (opens new window). GetOffersHttpStatusLine
body
required
The response schema for the getListingOffers and getItemOffers operations. GetOffersResponse

# ItemOffersRequestParams

Polymorphism : Composition

Name Description Schema
MarketplaceId
required
A marketplace identifier. Specifies the marketplace for which prices are returned. MarketplaceId
ItemCondition
required
- ItemCondition
CustomerType
optional
- CustomerType
Asin
optional
The Amazon Standard Identification Number (ASIN) of the item. This is the same Asin passed as a request parameter. string

# ItemOffersResponse

Polymorphism : Composition

Name Description Schema
headers
optional
A mapping of additional HTTP headers to send/receive for the individual batch request. HttpResponseHeaders
status
optional
The HTTP status line associated with the response. For more information, consult RFC 2616 (opens new window). GetOffersHttpStatusLine
body
required
The response schema for the getListingOffers and getItemOffers operations. GetOffersResponse
request
required
- ItemOffersRequestParams

# ListingOffersRequestParams

Polymorphism : Composition

Name Description Schema
MarketplaceId
required
A marketplace identifier. Specifies the marketplace for which prices are returned. MarketplaceId
ItemCondition
required
- ItemCondition
CustomerType
optional
- CustomerType
SellerSKU
required
The seller stock keeping unit (SKU) of the item. This is the same SKU passed as a path parameter. string

# ListingOffersResponse

Polymorphism : Composition

Name Description Schema
headers
optional
A mapping of additional HTTP headers to send/receive for the individual batch request. HttpResponseHeaders
status
optional
The HTTP status line associated with the response. For more information, consult RFC 2616 (opens new window). GetOffersHttpStatusLine
body
required
The response schema for the getListingOffers and getItemOffers operations. GetOffersResponse
request
optional
- ListingOffersRequestParams

# Errors

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

Name Description Schema
errors
required
One or more unexpected errors occurred during the operation. ErrorList

# GetPricingResponse

The response schema for the getPricing and getCompetitivePricing operations.

Name Description Schema
payload
optional
The payload for the getPricing and getCompetitivePricing operations. PriceList
errors
optional
One or more unexpected errors occurred during the operation. ErrorList

# GetOffersResponse

The response schema for the getListingOffers and getItemOffers operations.

Name Description Schema
payload
optional
The payload for the getListingOffers and getItemOffers operations. GetOffersResult
errors
optional
One or more unexpected errors occurred during the operation. ErrorList

# PriceList

Type : < Price > array

Max items : 20

# GetOffersResult

Name Description Schema
MarketplaceID
required
A marketplace identifier. string
ASIN
optional
The Amazon Standard Identification Number (ASIN) of the item. string
SKU
optional
The stock keeping unit (SKU) of the item. string
ItemCondition
required
The condition of the item. ConditionType
status
required
The status of the operation. string
Identifier
required
Metadata that identifies the item. ItemIdentifier
Summary
required
Pricing information about the item. Summary
Offers
required
A list of offer details. The list is the same length as the TotalOfferCount in the Summary or 20, whichever is less. OfferDetailList

# HttpRequestHeaders

A mapping of additional HTTP headers to send/receive for the individual batch request.

Type : < string, string > map

# HttpResponseHeaders

A mapping of additional HTTP headers to send/receive for the individual batch request.

Type : < string, string > map

# GetOffersHttpStatusLine

The HTTP status line associated with the response. For more information, consult RFC 2616 (opens new window).

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

# HttpMethod

The HTTP method associated with the individual APIs being called as part of the batch request.

Type : enum

Value Description
GET GET
PUT PUT
PATCH PATCH
DELETE DELETE
POST POST

# BatchRequest

Common properties of batch requests against individual APIs.

Name Description Schema
uri
required
The full URI corresponding to the API intended for request, including path parameter substitutions. string
method
required
The HTTP method associated with the individual APIs being called as part of the batch request. HttpMethod
headers
optional
A mapping of additional HTTP headers to send/receive for the individual batch request. HttpRequestHeaders

# Price

Name Description Schema
status
required
The status of the operation. string
SellerSKU
optional
The seller stock keeping unit (SKU) of the item. string
ASIN
optional
The Amazon Standard Identification Number (ASIN) of the item. string
Product
optional
An item. Product

# Product

An item.

Name Description Schema
Identifiers
required
Specifies the identifiers used to uniquely identify an item. IdentifierType
AttributeSets
optional
A list of product attributes if they are applicable to the product that is returned. AttributeSetList
Relationships
optional
A list that contains product variation information, if applicable. RelationshipList
CompetitivePricing
optional
Competitive pricing information for the item. CompetitivePricingType
SalesRankings
optional
A list of sales rank information for the item, by category. SalesRankList
Offers
optional
A list of offers. OffersList

# IdentifierType

Specifies the identifiers used to uniquely identify an item.

Name Description Schema
MarketplaceASIN
required
Indicates the item is identified by MarketPlaceId and ASIN. ASINIdentifier
SKUIdentifier
optional
Indicates the item is identified by MarketPlaceId, SellerId, and SellerSKU. SellerSKUIdentifier

# ASINIdentifier

Name Description Schema
MarketplaceId
required
A marketplace identifier. string
ASIN
required
The Amazon Standard Identification Number (ASIN) of the item. string

# SellerSKUIdentifier

Name Description Schema
MarketplaceId
required
A marketplace identifier. string
SellerId
required
The seller identifier submitted for the operation. string
SellerSKU
required
The seller stock keeping unit (SKU) of the item. string

# AttributeSetList

A list of product attributes if they are applicable to the product that is returned.

Type : < object > array

# RelationshipList

A list that contains product variation information, if applicable.

Type : < object > array

# CompetitivePricingType

Competitive pricing information for the item.

Name Description Schema
CompetitivePrices
required
A list of competitive pricing information. CompetitivePriceList
NumberOfOfferListings
required
The number of active offer listings for the item that was submitted. The listing count is returned by condition, one for each listing condition value that is returned. NumberOfOfferListingsList
TradeInValue
optional
The trade-in value of the item in the trade-in program. MoneyType

# CompetitivePriceList

A list of competitive pricing information.

Type : < CompetitivePriceType > array

# CompetitivePriceType

Name Description Schema
CompetitivePriceId
required
The pricing model for each price that is returned.

Possible values:

  • 1 - New Buy Box Price.

  • 2 - Used Buy Box Price.
  • string
    Price
    required
    Pricing information for a given CompetitivePriceId value. PriceType
    condition
    optional
    Indicates the condition of the item whose pricing information is returned. Possible values are: New, Used, Collectible, Refurbished, or Club. string
    subcondition
    optional
    Indicates the subcondition of the item whose pricing information is returned. Possible values are: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. string
    offerType
    optional
    Indicates the type of customer that the offer is valid for.

    When the offer type is B2C in a quantity discount, the seller is winning the Buy Box because others do not have inventory at that quantity, not because they have a quantity discount on the ASIN.
    OfferCustomerType
    quantityTier
    optional
    Indicates at what quantity this price becomes active. integer (int32)
    quantityDiscountType
    optional
    Indicates the type of quantity discount this price applies to. QuantityDiscountType
    sellerId
    optional
    The seller identifier for the offer. string
    belongsToRequester
    optional
    Indicates whether or not the pricing information is for an offer listing that belongs to the requester. The requester is the seller associated with the SellerId that was submitted with the request. Possible values are: true and false. boolean

    # NumberOfOfferListingsList

    The number of active offer listings for the item that was submitted. The listing count is returned by condition, one for each listing condition value that is returned.

    Type : < OfferListingCountType > array

    # OfferListingCountType

    The number of offer listings with the specified condition.

    Name Description Schema
    Count
    required
    The number of offer listings. integer (int32)
    condition
    required
    The condition of the item. string

    # MoneyType

    Name Description Schema
    CurrencyCode
    optional
    The currency code in ISO 4217 format. string
    Amount
    optional
    The monetary value. number

    # SalesRankList

    A list of sales rank information for the item, by category.

    Type : < SalesRankType > array

    # SalesRankType

    Name Description Schema
    ProductCategoryId
    required
    Identifies the item category from which the sales rank is taken. string
    Rank
    required
    The sales rank of the item within the item category. integer (int32)

    # PriceType

    Name Description Schema
    LandedPrice
    optional
    The value calculated by adding ListingPrice + Shipping - Points. Note that if the landed price is not returned, the listing price represents the product with the lowest landed price. MoneyType
    ListingPrice
    required
    The listing price of the item including any promotions that apply. MoneyType
    Shipping
    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

    # OffersList

    A list of offers.

    Type : < OfferType > array

    # OfferType

    Indicates whether to request pricing information for the seller's B2C or B2B offers. Default is B2C.

    Type : enum

    Value Description
    B2C B2C
    B2B B2B

    # OfferCustomerType

    Type : enum

    Value Description
    B2C B2C
    B2B B2B

    # QuantityDiscountPriceType

    Contains pricing information that includes special pricing when buying in bulk.

    Name Description Schema
    quantityTier
    required
    Indicates at what quantity this price becomes active. integer (int32)
    quantityDiscountType
    required
    Indicates the type of quantity discount this price applies to. QuantityDiscountType
    listingPrice
    required
    The price at this quantity tier. MoneyType

    # QuantityDiscountType

    Type : enum

    Value Description
    QUANTITY_DISCOUNT Quantity Discount

    # Points

    Name Description Schema
    PointsNumber
    optional
    The number of points. integer (int32)
    PointsMonetaryValue
    optional
    The monetary value of the points. MoneyType

    # ConditionType

    Indicates the condition of the item. Possible values: New, Used, Collectible, Refurbished, Club.

    Type : enum

    Value Description
    New New
    Used Used
    Collectible Collectible
    Refurbished Refurbished
    Club Club

    # ItemIdentifier

    Information that identifies an item.

    Name Description Schema
    MarketplaceId
    required
    A marketplace identifier. Specifies the marketplace from which prices are returned. string
    ASIN
    optional
    The Amazon Standard Identification Number (ASIN) of the item. string
    SellerSKU
    optional
    The seller stock keeping unit (SKU) of the item. string
    ItemCondition
    required
    The condition of the item. ConditionType

    # Summary

    Contains price information about the product, including the LowestPrices and BuyBoxPrices, the ListPrice, the SuggestedLowerPricePlusShipping, and NumberOfOffers and NumberOfBuyBoxEligibleOffers.

    Name Description Schema
    TotalOfferCount
    required
    The number of unique offers contained in NumberOfOffers. integer (int32)
    NumberOfOffers
    optional
    A list that contains the total number of offers for the item for the given conditions and fulfillment channels. NumberOfOffers
    LowestPrices
    optional
    A list of the lowest prices for the item. LowestPrices
    BuyBoxPrices
    optional
    A list of item prices. BuyBoxPrices
    ListPrice
    optional
    The list price of the item as suggested by the manufacturer. MoneyType
    CompetitivePriceThreshold
    optional
    This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price. MoneyType
    SuggestedLowerPricePlusShipping
    optional
    The suggested lower price of the item, including shipping and Amazon Points. The suggested lower price is based on a range of factors, including historical selling prices, recent Buy Box-eligible prices, and input from customers for your products. MoneyType
    SalesRankings
    optional
    A list that contains the sales rank of the item in the given product categories. SalesRankList
    BuyBoxEligibleOffers
    optional
    A list that contains the total number of offers that are eligible for the Buy Box for the given conditions and fulfillment channels. BuyBoxEligibleOffers
    OffersAvailableTime
    optional
    When the status is ActiveButTooSoonForProcessing, this is the time when the offers will be available for processing. string (date-time)

    # BuyBoxEligibleOffers

    Type : < OfferCountType > array

    # BuyBoxPrices

    Type : < BuyBoxPriceType > array

    # LowestPrices

    Type : < LowestPriceType > array

    # NumberOfOffers

    Type : < OfferCountType > array

    # OfferCountType

    The total number of offers for the specified condition and fulfillment channel.

    Name Description Schema
    condition
    optional
    Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. string
    fulfillmentChannel
    optional
    Indicates whether the item is fulfilled by Amazon or by the seller. FulfillmentChannelType
    OfferCount
    optional
    The number of offers in a fulfillment channel that meet a specific condition. integer (int32)

    # FulfillmentChannelType

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

    Type : enum

    Value Description
    Amazon Fulfilled by Amazon.
    Merchant Fulfilled by the seller.

    # LowestPriceType

    Name Description Schema
    condition
    required
    Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. string
    fulfillmentChannel
    required
    Indicates whether the item is fulfilled by Amazon or by the seller. string
    offerType
    optional
    Indicates the type of customer that the offer is valid for. OfferCustomerType
    quantityTier
    optional
    Indicates at what quantity this price becomes active. integer (int32)
    quantityDiscountType
    optional
    Indicates the type of quantity discount this price applies to. QuantityDiscountType
    LandedPrice
    required
    The value calculated by adding ListingPrice + Shipping - Points. MoneyType
    ListingPrice
    required
    The price of the item. MoneyType
    Shipping
    required
    The shipping cost. MoneyType
    Points
    optional
    The number of Amazon Points offered with the purchase of an item. Points

    # BuyBoxPriceType

    Name Description Schema
    condition
    required
    Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. string
    offerType
    optional
    Indicates the type of customer that the offer is valid for.

    When the offer type is B2C in a quantity discount, the seller is winning the Buy Box because others do not have inventory at that quantity, not because they have a quantity discount on the ASIN.
    OfferCustomerType
    quantityTier
    optional
    Indicates at what quantity this price becomes active. integer (int32)
    quantityDiscountType
    optional
    Indicates the type of quantity discount this price applies to. QuantityDiscountType
    LandedPrice
    required
    The value calculated by adding ListingPrice + Shipping - Points. MoneyType
    ListingPrice
    required
    The price of the item. MoneyType
    Shipping
    required
    The shipping cost. MoneyType
    Points
    optional
    The number of Amazon Points offered with the purchase of an item. Points
    sellerId
    optional
    The seller identifier for the offer. string

    # OfferDetailList

    Type : < OfferDetail > array

    Max items : 20

    # OfferDetail

    Name Description Schema
    MyOffer
    optional
    When true, this is the seller's offer. boolean
    offerType
    optional
    Indicates the type of customer that the offer is valid for. OfferCustomerType
    SubCondition
    required
    The subcondition of the item. Subcondition values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. string
    SellerId
    optional
    The seller identifier for the offer. string
    ConditionNotes
    optional
    Information about the condition of the item. string
    SellerFeedbackRating
    optional
    Information about the seller's feedback, including the percentage of positive feedback, and the total number of ratings received. SellerFeedbackType
    ShippingTime
    required
    The maximum time within which the item will likely be shipped once an order has been placed. DetailedShippingTimeType
    ListingPrice
    required
    The price of the item. MoneyType
    quantityDiscountPrices
    optional
    - < QuantityDiscountPriceType > array
    Points
    optional
    The number of Amazon Points offered with the purchase of an item. Points
    Shipping
    required
    The shipping cost. MoneyType
    ShipsFrom
    optional
    The state and country from where the item is shipped. ShipsFromType
    IsFulfilledByAmazon
    required
    When true, the offer is fulfilled by Amazon. boolean
    PrimeInformation
    optional
    Amazon Prime information. PrimeInformationType
    IsBuyBoxWinner
    optional
    When true, the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime. boolean
    IsFeaturedMerchant
    optional
    When true, the seller of the item is eligible to win the Buy Box. boolean

    # PrimeInformationType

    Amazon Prime information.

    Name Description Schema
    IsPrime
    required
    Indicates whether the offer is an Amazon Prime offer. boolean
    IsNationalPrime
    required
    Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed. boolean

    # SellerFeedbackType

    Information about the seller's feedback, including the percentage of positive feedback, and the total number of ratings received.

    Name Description Schema
    SellerPositiveFeedbackRating
    optional
    The percentage of positive feedback for the seller in the past 365 days. number (double)
    FeedbackCount
    required
    The number of ratings received about the seller. integer (int64)

    # ErrorList

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

    Type : < Error > array

    # DetailedShippingTimeType

    The time range in which an item will likely be shipped once an order has been placed.

    Name Description Schema
    minimumHours
    optional
    The minimum time, in hours, that the item will likely be shipped after the order has been placed. integer (int64)
    maximumHours
    optional
    The maximum time, in hours, that the item will likely be shipped after the order has been placed. integer (int64)
    availableDate
    optional
    The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping. string
    availabilityType
    optional
    Indicates whether the item is available for shipping now, or on a known or an unknown date in the future. If known, the availableDate property indicates the date that the item will be available for shipping. Possible values: NOW, FUTURE_WITHOUT_DATE, FUTURE_WITH_DATE. enum (AvailabilityType)

    # ShipsFromType

    The state and country from where the item is shipped.

    Name Description Schema
    State
    optional
    The state from where the item is shipped. string
    Country
    optional
    The country from where the item is shipped. string

    # MarketplaceId

    A marketplace identifier. Specifies the marketplace for which prices are returned.

    Type : string

    # ItemCondition

    Type : enum

    For use with the operation(s): getPricing, getListingOffers Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club.

    Value Description
    New New
    Used Used
    Collectible Collectible
    Refurbished Refurbished
    Club Club

    For use with the operation(s): getItemOffers Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club.

    Value Description
    New New
    Used Used
    Collectible Collectible
    Refurbished Refurbished
    Club Club

    # CustomerType

    Type : enum

    For use with the operation(s): getCompetitivePricing Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer.

    Value Description
    Consumer Consumer
    Business Business

    For use with the operation(s): getListingOffers, getItemOffers Indicates whether to request Consumer or Business offers. Default is Consumer.

    Value Description
    Consumer Consumer
    Business Business

    # Error

    Error response returned when the request is unsuccessful.

    Name Description Schema
    code
    required
    An error code that identifies the type of error that occurred. string
    message
    required
    A message that describes the error condition in a human-readable form. string
    details
    optional
    Additional information that can help the caller understand or fix the issue. string

    # AvailabilityType

    Indicates whether the item is available for shipping now, or on a known or an unknown date in the future. If known, the availableDate property indicates the date that the item will be available for shipping. Possible values: NOW, FUTURE_WITHOUT_DATE, FUTURE_WITH_DATE.

    Type : enum

    Value Description
    NOW The item is available for shipping now.
    FUTURE_WITHOUT_DATE The item will be available for shipping on an unknown date in the future.
    FUTURE_WITH_DATE The item will be available for shipping on a known date in the future.

    # ItemType

    Type : enum

    For use with the operation(s): getPricing Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter.

    Value Description
    Asin The Amazon Standard Identification Number (ASIN).
    Sku The seller SKU.

    For use with the operation(s): getCompetitivePricing Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. Possible values: Asin, Sku.

    Value Description
    Asin The Amazon Standard Identification Number (ASIN).
    Sku The seller SKU.
    Last Updated: 10/11/2022, 9:45:34 PM