Product Pricing API v0 reference
Overview
overview
overview
The sell partner API for price help you programmatically retrieve product price and offer information for amazon market product .
Version information interpretation information
translation : v0
contact information
contact : selling collaborator API developer support
contact url : hypertext transfer protocol : //sellercentral.amazon.com/gp/mws/contactus.html
Reading: Product Pricing API v0 reference
License information license information
license : apache license 2.0
license url : hypertext transfer protocol : //www.apache.org/licenses/LICENSE-2.0
URI scheme URI scheme
server : sellingpartnerapi-na.amazon.com
scheme : hypertext transfer protocol
Consumes consume
application/json
Produces grow
application/json
Operations operations
getPricing
getCompetitivePricing
getListingOffers
getItemOffers
getItemOffersBatch
getListingOffersBatch
Paths path
GET /products/pricing/v0/price get /products/pricing/v0/price
Operation: getPricing
Description description
return price data for angstrom seller ‘s offer list based on seller SKU operating room asin .
Usage Plan:
Rate (requests per second) | Burst |
---|---|
0.5 | 1 |
The x-amzn-RateLimit-Limit
reply header return key the usage plan rate limit that exist apply to the requested operation, when available. The table above argue the default rate and collapse value for this operation. selling partner whose business necessitate command gamey throughput whitethorn see high rate and outburst respect than those show here. For more information, see use plan and pace terminus ad quem in the betray collaborator API .
Parameters parameter
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 response
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 |
GET /products/pricing/v0/competitivePrice get /products/pricing/v0/competitivePrice
Operation: getCompetitivePricing
Description description
return competitive pricing data for deoxyadenosine monophosphate seller ‘s offer listing based on seller SKU oregon asin .
Usage Plan:
Rate (requests per second) | Burst |
---|---|
0.5 | 1 |
The x-amzn-RateLimit-Limit
answer header render the custom plan rate limit that equal enforce to the request operation, when available. The postpone above argue the default rate and burst measure for this operation. sell partner whose occupation necessitate ask higher throughput whitethorn determine higher rate and outburst value than those testify here. For more information, learn use plan and rate limit in the sell spouse API .
Parameters parameter
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 response
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 |
GET /products/pricing/v0/listings/{SellerSKU}/offers bring /products/pricing/v0/listings/ { SellerSKU } /offers
Operation: getListingOffers
Description description
recurrence the abject price offer for angstrom single SKU listing .
Usage Plan:
Rate (requests per second) | Burst |
---|---|
1 | 2 |
The x-amzn-RateLimit-Limit
response header fall the custom plan rate limit that be apply to the request operation, when available. The table above indicate the nonpayment rate and outburst value for this operation. selling partner whose business demand command high throughput whitethorn see gamey rate and explode value than those picture here. For more information, see usage design and rate limit in the betray partner API .
Parameters parameter
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 reception
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 |
GET /products/pricing/v0/items/{Asin}/offers get /products/pricing/v0/items/ { asin } /offers
Operation: getItemOffers
Description description
return the last price offer for a single detail based on asin .
Usage Plan:
Rate (requests per second) | Burst |
---|---|
0.5 | 1 |
The x-amzn-RateLimit-Limit
response header revert the use plan rate limit that be use to the request operation, when available. The table above bespeak the default rate and break value for this operation. sell partner whose commercial enterprise need want gamey throughput whitethorn see eminent pace and burst measure than those show here. For more information, see custom plan and pace limit inch the sell spouse API .
Parameters parameter
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 response
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 |
POST /batches/products/pricing/v0/itemOffers post /batches/products/pricing/v0/itemOffers
Operation: getItemOffersBatch
Description description
retort the broken price offer for ampere batch of detail free-base along asin .
Usage Plan:
Rate (requests per second) | Burst |
---|---|
0.5 | 1 |
The x-amzn-RateLimit-Limit
response header return the usage plan rate limit that be apply to the request operation, when available. The table above indicate the default rate and explosion value for this operation. selling partner whose clientele need ask high throughput whitethorn understand high rate and break value than those read here. For more information, go steady use plan and rate limit in the deal collaborator API .
Parameters parameter
Type | Name | Description | Schema |
---|---|---|---|
Body | getItemOffersBatchRequestBody required |
The request associated with the getItemOffersBatch API call. |
GetItemOffersBatchRequest |
Responses reception
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 |
POST /batches/products/pricing/v0/listingOffers post /batches/products/pricing/v0/listingOffers
Operation: getListingOffersBatch
Description description
revert the low price crack for vitamin a batch of list by SKU .
Usage Plan:
Rate (requests per second) | Burst |
---|---|
0.5 | 1 |
The x-amzn-RateLimit-Limit
reply header return the use plan rate limit that be apply to the request operation, when available. The table above argue the default rate and burst value for this operation. sell spouse whose occupation demand want high throughput may watch eminent rate and burst value than those usher here. For more data, determine custom plan and rate limit indium the sell partner API .
Parameters parameter
Type | Name | Description | Schema |
---|---|---|---|
Body | getListingOffersBatchRequestBody required |
The request associated with the getListingOffersBatch API call. |
GetListingOffersBatchRequest |
Responses reaction
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 definition
GetItemOffersBatchRequest GetItemOffersBatchRequest
The request consociate with the getItemOffersBatch
API call .
Name | Description | Schema |
---|---|---|
requests optional |
A list of getListingOffers batched requests to run. |
ItemOffersRequestList |
GetListingOffersBatchRequest GetListingOffersBatchRequest
The request consociate with the getListingOffersBatch
API call .
Name | Description | Schema |
---|---|---|
requests optional |
A list of getListingOffers batched requests to run. |
ListingOffersRequestList |
ListingOffersRequestList ListingOffersRequestList
angstrom number of getListingOffers
batch request to guide .
type : < ListingOffersRequest > align
Min items : one
Max items : twenty
ItemOffersRequestList ItemOffersRequestList
a number of getListingOffers
batch request to run .
type : < ItemOffersRequest > array
Min items : one
Max items : twenty
BatchOffersRequestParams 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 ItemOffersRequest
polymorphism : musical composition
Name | Description | Schema |
---|---|---|
uri required |
The resource path of the operation you are calling in batch without any query parameters.
If you are calling Example: If you are calling Example: |
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 ListingOffersRequest
polymorphism : composition
Name | Description | Schema |
---|---|---|
uri required |
The resource path of the operation you are calling in batch without any query parameters.
If you are calling Example: If you are calling Example: |
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 GetItemOffersBatchResponse
The reply consociate with the getItemOffersBatch
API call .
Name | Description | Schema |
---|---|---|
responses optional |
A list of getItemOffers batched responses. |
ItemOffersResponseList |
GetListingOffersBatchResponse GetListingOffersBatchResponse
The reaction consort with the getListingOffersBatch
API call .
Name | Description | Schema |
---|---|---|
responses optional |
A list of getListingOffers batched responses. |
ListingOffersResponseList |
ItemOffersResponseList ItemOffersResponseList
vitamin a list of getItemOffers
batch response .
character : < ItemOffersResponse > range
Min items : one
Max items : twenty
ListingOffersResponseList ListingOffersResponseList
vitamin a list of getListingOffers
batch reception .
type : < ListingOffersResponse > align
Min items : one
Max items : twenty
BatchOffersResponse 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. | GetOffersHttpStatusLine |
body required |
The response schema for the getListingOffers and getItemOffers operations. |
GetOffersResponse |
ItemOffersRequestParams 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 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. | GetOffersHttpStatusLine |
body required |
The response schema for the getListingOffers and getItemOffers operations. |
GetOffersResponse |
request required |
– | ItemOffersRequestParams |
Read more : Rừng mưa Amazon – Wikipedia tiếng Việt
ListingOffersRequestParams 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 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. | GetOffersHttpStatusLine |
body required |
The response schema for the getListingOffers and getItemOffers operations. |
GetOffersResponse |
request optional |
– | ListingOffersRequestParams |
Errors error
a list of error response hark back when deoxyadenosine monophosphate request constitute unsuccessful .
Name | Description | Schema |
---|---|---|
errors required |
One or more unexpected errors occurred during the operation. | ErrorList |
GetPricingResponse GetPricingResponse
The response schema for the getPricing
and getCompetitivePricing
operation .
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 GetOffersResponse
The reception outline for the getListingOffers
and getItemOffers
process .
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 PriceList
type : < price > array
Max items : twenty
GetOffersResult 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 HttpRequestHeaders
deoxyadenosine monophosphate mapping of extra hypertext transfer protocol header to send/receive for the individual batch request .
type : < drawstring, string > map
HttpResponseHeaders HttpResponseHeaders
ampere function of extra hypertext transfer protocol header to send/receive for the individual batch request .
type : < string, string > map
GetOffersHttpStatusLine GetOffersHttpStatusLine
The hypertext transfer protocol condition line associate with the response. For more information, confer RFC 2616 .
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 HttpMethod
The hypertext transfer protocol method consort with the individual apis constitute call angstrom part of the batch request .
type : enum
Value | Description |
---|---|
GET | GET |
PUT | PUT |
PATCH | PATCH |
DELETE | DELETE |
POST | POST |
BatchRequest BatchRequest
coarse place of batch request against individual apis .
Name | Description | Schema |
---|---|---|
uri required |
The resource path of the operation you are calling in batch without any query parameters.
If you are calling Example: If you are calling Example: |
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 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 product
associate in nursing detail .
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 IdentifierType
assign the identifier secondhand to uniquely identify associate in nursing detail .
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 ASINIdentifier
Name | Description | Schema |
---|---|---|
MarketplaceId required |
A marketplace identifier. | string |
ASIN required |
The Amazon Standard Identification Number (ASIN) of the item. | string |
SellerSKUIdentifier 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 AttributeSetList
deoxyadenosine monophosphate list of product assign if they constitute applicable to the product that be retort .
type : < object > align
RelationshipList RelationshipList
deoxyadenosine monophosphate tilt that hold merchandise variation data, if applicable .
type : < object > array
CompetitivePricingType CompetitivePricingType
competitive price 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 CompetitivePriceList
a number of competitive pricing data .
type : < CompetitivePriceType > array
CompetitivePriceType CompetitivePriceType
Name | Description | Schema |
---|---|---|
CompetitivePriceId required |
The pricing model for each price that is returned.
Possible values: |
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 NumberOfOfferListingsList
The issue of active offer listing for the item that be render. The list count be render aside condition, one for each list condition value that be render .
type : < OfferListingCountType > array
OfferListingCountType OfferListingCountType
The number of offer list with the specify condition .
Name | Description | Schema |
---|---|---|
Count required |
The number of offer listings. | integer (int32) |
condition required |
The condition of the item. | string |
MoneyType MoneyType
Name | Description | Schema |
---|---|---|
CurrencyCode optional |
The currency code in ISO 4217 format. | string |
Amount optional |
The monetary value. | number |
SalesRankList SalesRankList
angstrom list of sale rank and file information for the token, by class .
type : < SalesRankType > array
SalesRankType 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 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 OffersList
deoxyadenosine monophosphate list of extend .
character : < OfferType > array
OfferType OfferType
bespeak whether to request price information for the seller ‘s B2C operating room B2B put up. nonpayment cost B2C .
type : enum
Value | Description |
---|---|
B2C | B2C |
B2B | B2B |
OfferCustomerType OfferCustomerType
type : enum
Value | Description |
---|---|
B2C | B2C |
B2B | B2B |
QuantityDiscountPriceType QuantityDiscountPriceType
contain pricing information that include special price when buy in bulge .
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 QuantityDiscountType
type : enum
Value | Description |
---|---|
QUANTITY_DISCOUNT | Quantity Discount |
Points item
Name | Description | Schema |
---|---|---|
PointsNumber optional |
The number of points. | integer (int32) |
PointsMonetaryValue optional |
The monetary value of the points. | MoneyType |
ConditionType ConditionType
indicate the condition of the token. possible rate : new, use, collectible, refurbish, club .
type : enum
Value | Description |
---|---|
New | New |
Used | Used |
Collectible | Collectible |
Refurbished | Refurbished |
Club | Club |
ItemIdentifier ItemIdentifier
data that identify associate in nursing 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 drumhead
control price information about the product, include 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 BuyBoxEligibleOffers
type : < OfferCountType > array
BuyBoxPrices BuyBoxPrices
type : < BuyBoxPriceType > array
LowestPrices LowestPrices
character : < LowestPriceType > array
NumberOfOffers NumberOfOffers
type : < OfferCountType > align
OfferCountType OfferCountType
The total number of offer for the specify 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 FulfillmentChannelType
indicate whether the detail be carry through aside amazon operating room by the seller ( merchant ) .
type : enum
Value | Description |
---|---|
Amazon | Fulfilled by Amazon. |
Merchant | Fulfilled by the seller. |
LowestPriceType 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 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 OfferDetailList
type : < OfferDetail > array
Max items : twenty
OfferDetail 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 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 SellerFeedbackType
information about the seller ‘s feedback, include the percentage of positive feedback, and the total act of rat receive .
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 ErrorList
ampere list of erroneousness response come back when a request embody abortive .
type : < error > align
DetailedShippingTimeType DetailedShippingTimeType
The time range in which associate in nursing item volition probable be ship once associate in nursing orderliness accept embody place .
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 ShipsFromType
The state and country from where the token be ship .
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 MarketplaceId
adenine marketplace identifier. pin down the marketplace for which price be return .
type : string
ItemCondition ItemCondition
character : enum
For use with the operation(s): getPricing, getListingOffers
filter the propose listing based along item condition. possible rate : new, use, collectible, refurbish, club .
Value | Description |
---|---|
New | New |
Used | Used |
Collectible | Collectible |
Refurbished | Refurbished |
Club | Club |
For use with the operation(s): getItemOffers
filter the extend list to exist see based on item condition. possible values : new, use, collectible, refurbish, club .
Value | Description |
---|---|
New | New |
Used | Used |
Collectible | Collectible |
Refurbished | Refurbished |
Club | Club |
CustomerType CustomerType
type : enum
For use with the operation(s): getCompetitivePricing
argue whether to request pricing information from the point of view of consumer operating room clientele buyer. default equal consumer .
Value | Description |
---|---|
Consumer | Consumer |
Business | Business |
For use with the operation(s): getListingOffers, getItemOffers
bespeak whether to request consumer oregon business propose. default option be consumer .
Value | Description |
---|---|
Consumer | Consumer |
Business | Business |
Error error
error response fall when the request cost abortive .
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 AvailabilityType
bespeak whether the detail constitute available for ship now, oregon on vitamin a known operating room associate in nursing obscure date in the future. If know, the availableDate property indicate the date that the detail will exist available for transportation. possible value : 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. |
Read more : How To Sell on Amazon in 2023: Your 7 Step Guide
ItemType ItemType
type : enum
For use with the operation(s): getPricing
argue whether asin value oregon seller SKU value be use to identify item. If you specify asin, the information in the response volition be dependent on the list of asin you leave in the asin argument. If you specify Sku, the information in the response will be pendent on the tilt 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
argue whether asin value oregon seller SKU value be use to identify detail. If you assign asin, the data in the response will beryllium pendent on the list of asin you provide in the asin argument. If you specify Sku, the data in the response will be dependent along the number of Skus you supply in the Skus parameter. possible respect : asin, Sku .
Value | Description |
---|---|
Asin | The Amazon Standard Identification Number (ASIN). |
Sku | The seller SKU. |