Product Fees API v0 Reference
Retrieve estimated fees for a product.
Overview
The Selling Partner API for Product Fees lets you programmatically retrieve estimated fees for a product. You can then account for those fees in your pricing.
Version information
Version : v0
Contact information
Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information
License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme
Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS
Consumes
application/json
Produces
application/json
Operations
getMyFeesEstimateForSKU
getMyFeesEstimateForASIN
getMyFeesEstimates
Paths
POST /products/fees/v0/listings/{SellerSKU}/feesEstimate
Operation: getMyFeesEstimateForSKU
Description
Returns the estimated fees for the item indicated by the specified seller SKU in the marketplace specified in the request body.
Note: The parameters associated with this operation may contain special characters that require URL encoding to call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.
You can call getMyFeesEstimateForSKU
for an item on behalf of a selling partner before the selling partner sets the item's price. The selling partner can then take any estimated fees into account. Each fees estimate request must include an original identifier. This identifier is included in the fees estimate so that you can correlate a fees estimate with the original request.
Note: This identifier value is used to identify an estimate. Actual costs may vary. Search "fees" in Seller Central and consult the store-specific fee schedule for the most up-to-date information.
Note: When sellers use the getMyFeesEstimateForSKU
operation with their SellerSKU
, they get accurate fees based on real item measurements, but only after they've sent their items to Amazon.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
1 | 2 |
The x-amzn-RateLimit-Limit
response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | body required | Request schema. | GetMyFeesEstimateRequest |
Path | SellerSKU required | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | string |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
POST /products/fees/v0/items/{Asin}/feesEstimate
Operation: getMyFeesEstimateForASIN
Description
Returns the estimated fees for the item indicated by the specified ASIN in the marketplace specified in the request body.
You can call getMyFeesEstimateForASIN
for an item on behalf of a selling partner before the selling partner sets the item's price. The selling partner can then take estimated fees into account. Each fees request must include an original identifier. This identifier is included in the fees estimate so you can correlate a fees estimate with the original request.
Note: This identifier value is used to identify an estimate. Actual costs may vary. Search "fees" in Seller Central and consult the store-specific fee schedule for the most up-to-date information.
Note: When using the getMyFeesEstimateForASIN
operation with an ASIN, the fee estimates might be different. This is because these estimates use the item's catalog size, which might not always match the actual size of the item sent to Amazon.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
1 | 2 |
The x-amzn-RateLimit-Limit
response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | body required | Request schema. | GetMyFeesEstimateRequest |
Path | Asin required | The Amazon Standard Identification Number (ASIN) of the item. | string |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
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 identifier. | GetMyFeesEstimateResponse |
POST /products/fees/v0/feesEstimate
Operation: getMyFeesEstimates
Description
Returns the estimated fees for a list of products.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
0.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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | body required | Request for estimated fees for a list of products. | GetMyFeesEstimatesRequest |
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 identifier. | GetMyFeesEstimatesResponse |
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 identifier. | GetMyFeesEstimatesErrorList |
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 identifier. | GetMyFeesEstimatesErrorList |
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 identifier. | GetMyFeesEstimatesErrorList |
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 identifier. | GetMyFeesEstimatesErrorList |
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 identifier. | GetMyFeesEstimatesErrorList |
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 identifier. | GetMyFeesEstimatesErrorList |
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 identifier. | GetMyFeesEstimatesErrorList |
Definitions
GetMyFeesEstimateRequest
Request schema.
Name | Description | Schema |
---|---|---|
FeesEstimateRequest optional | A product, marketplace, and proposed price used to request estimated fees. | FeesEstimateRequest |
GetMyFeesEstimatesRequest
Request for estimated fees for a list of products.
Type : < FeesEstimateByIdRequest > array
FeesEstimateByIdRequest
A product, marketplace, and proposed price used to request estimated fees.
Name | Description | Schema |
---|---|---|
FeesEstimateRequest optional | A product, marketplace, and proposed price used to request estimated fees. | FeesEstimateRequest |
IdType required | The type of product identifier used in a FeesEstimateByIdRequest . | IdType |
IdValue required | The item identifier. | string |
FeesEstimateRequest
A product, marketplace, and proposed price used to request estimated fees.
Name | Description | Schema |
---|---|---|
MarketplaceId required | A marketplace identifier. | string |
IsAmazonFulfilled optional | When true, the offer is fulfilled by Amazon. | boolean |
PriceToEstimateFees required | The product price that the fee estimate is based on. | PriceToEstimateFees |
Identifier required | A unique identifier provided by the caller to track this request. | string |
OptionalFulfillmentProgram optional | An optional enrollment program to return the estimated fees when the offer is fulfilled by Amazon (IsAmazonFulfilled is set to true). | OptionalFulfillmentProgram |
GetMyFeesEstimateResponse
Name | Description | Schema |
---|---|---|
payload optional | The payload for the operation. | GetMyFeesEstimateResult |
errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
GetMyFeesEstimateResult
Response schema.
Name | Description | Schema |
---|---|---|
FeesEstimateResult optional | The item's estimated fees. | FeesEstimateResult |
GetMyFeesEstimatesResponse
Estimated fees for a list of products.
Type : < FeesEstimateResult > array
Points
Name | Schema |
---|---|
PointsNumber optional | integer (int32) |
PointsMonetaryValue optional | MoneyType |
GetMyFeesEstimatesErrorList
A list of error responses returned when a request is unsuccessful.
Name | Schema |
---|---|
errors required | < Error > array |
ErrorList
A list of error responses returned when a request is unsuccessful.
Type : < Error > array
Error
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. | string |
details optional | Additional details that can help the caller understand or fix the issue. | string |
FeesEstimateResult
An item identifier and the estimated fees for the item.
Name | Description | Schema |
---|---|---|
Status optional | The status of the fee request. Possible values: Success, ClientError, ServiceError. | string |
FeesEstimateIdentifier optional | Information used to identify a fees estimate request. | FeesEstimateIdentifier |
FeesEstimate optional | The total estimated fees for an item and a list of details. | FeesEstimate |
Error optional | An error object with a type, code, and message. | FeesEstimateError |
FeesEstimateIdentifier
An item identifier, marketplace, time of request, and other details that identify an estimate.
Name | Description | Schema |
---|---|---|
MarketplaceId optional | A marketplace identifier. | string |
SellerId optional | The seller identifier. | string |
IdType optional | The type of product identifier used in a FeesEstimateByIdRequest . | IdType |
IdValue optional | The item identifier. | string |
IsAmazonFulfilled optional | When true, the offer is fulfilled by Amazon. | boolean |
PriceToEstimateFees optional | The item price on which the fee estimate is based. | PriceToEstimateFees |
SellerInputIdentifier optional | A unique identifier provided by the caller to track this request. | string |
OptionalFulfillmentProgram optional | An optional enrollment program to return the estimated fees when the offer is fulfilled by Amazon (IsAmazonFulfilled is set to true). | OptionalFulfillmentProgram |
PriceToEstimateFees
Price information for an item, used to estimate fees.
FeesEstimate
The total estimated fees for an item and a list of details.
Name | Description | Schema |
---|---|---|
TimeOfFeesEstimation required | The time at which the fees were estimated. This defaults to the time the request is made. | string (date-time) |
TotalFeesEstimate optional | Total estimated fees for a given item, price, and fulfillment channel. | MoneyType |
FeeDetailList optional | A list of other fees that contribute to a given fee. | FeeDetailList |
FeeDetailList
A list of other fees that contribute to a given fee.
Type : < FeeDetail > array
FeesEstimateError
An unexpected error occurred during this operation.
Name | Description | Schema |
---|---|---|
Type required | An error type, identifying either the receiver or the sender as the originator of the error. | string |
Code required | An error code that identifies the type of error that occurred. | string |
Message required | A message that describes the error condition. | string |
Detail required | Additional information that can help the caller understand or fix the issue. | FeesEstimateErrorDetail |
FeesEstimateErrorDetail
Additional information that can help the caller understand or fix the issue.
Type : < object > array
FeeDetail
The type of fee, fee amount, and other details.
Name | Description | Schema |
---|---|---|
FeeType required | The type of fee charged to a seller. | string |
FeeAmount required | The amount charged for a given fee. | MoneyType |
FeePromotion optional | The promotion amount for a given fee. | MoneyType |
TaxAmount optional | The tax amount for a given fee. | MoneyType |
FinalFee required | The final fee amount for a given fee. | MoneyType |
IncludedFeeDetailList optional | A list of other fees that contribute to a given fee. | IncludedFeeDetailList |
IncludedFeeDetailList
A list of other fees that contribute to a given fee.
Type : < IncludedFeeDetail > array
IncludedFeeDetail
The type of fee, fee amount, and other details.
Name | Description | Schema |
---|---|---|
FeeType required | The type of fee charged to a seller. | string |
FeeAmount required | The amount charged for a given fee. | MoneyType |
FeePromotion optional | The promotion amount for a given fee. | MoneyType |
TaxAmount optional | The tax amount for a given fee. | MoneyType |
FinalFee required | The final fee amount for a given fee. | MoneyType |
MoneyType
Name | Description | Schema |
---|---|---|
CurrencyCode optional | The currency code in ISO 4217 format. | string |
Amount optional | The monetary value. | number |
OptionalFulfillmentProgram
An optional enrollment program to return the estimated fees when the offer is fulfilled by Amazon (IsAmazonFulfilled is set to true).
Type : enum
Value | Description |
---|---|
FBA_CORE | Returns the standard Amazon fulfillment fees for the offer. This is the default. |
FBA_SNL | Returns the FBA Small and Light (SNL) fees for the offer. The SNL program offers reduced fulfillment costs on qualified items. To check item eligibility for the SNL program, use the getSmallAndLightEligibilityBySellerSKU operation of the FBA Small And Light API. Note: The FBA Small and Light program sunset in the US and EU regions on September 26, 2023. The program will be deprecated in the JP region on March 31, 2024 and sunset on April 1, 2024. APIs announcing deprecation will no longer be supported after their deprecation date. Calls to deprecated APIs will fail beginning on their sunset date. For more information, refer to FBA Small and Light program deprecation. |
FBA_EFN | Returns the cross-border European Fulfillment Network fees across EU countries for the offer. |
IdType
The type of product identifier used in a FeesEstimateByIdRequest
.
Type : enum
Value | Description |
---|---|
ASIN | An Amazon Standard Identification Number (ASIN) of a listings item. |
SellerSKU | A selling partner provided identifier for an Amazon listing. |
Updated 4 months ago