Class: Peddler::APIs::ProductFeesV0

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/product_fees_v0.rb

Overview

Selling Partner API for Product Fees

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.

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #parser, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#endpoint_uri, #http, #initialize, #meter, #retriable, #sandbox, #sandbox?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_my_fees_estimate_for_asin(body, asin, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

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.

Parameters:

  • body (Hash) —

    The request body schema for the getMyFeesEstimates operation

  • asin (String) —

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

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

Returns:



70
71
72
73
74
 
# File 'lib/peddler/apis/product_fees_v0.rb', line 70

def get_my_fees_estimate_for_asin(body, asin, rate_limit: 1.0)
  path = "/products/fees/v0/items/#{percent_encode(asin)}/feesEstimate"

  meter(rate_limit).post(path, body:)
end

#get_my_fees_estimate_for_sku(body, seller_sku, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

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.

Parameters:

  • body (Hash) —

    The request body schema for the getMyFeesEstimates operation

  • seller_sku (String) —

    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.

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

Returns:



43
44
45
46
47
 
# File 'lib/peddler/apis/product_fees_v0.rb', line 43

def get_my_fees_estimate_for_sku(body, seller_sku, rate_limit: 1.0)
  path = "/products/fees/v0/listings/#{percent_encode(seller_sku)}/feesEstimate"

  meter(rate_limit).post(path, body:)
end

#get_my_fees_estimates(body, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns the estimated fees for a list of products.

Parameters:

  • body (Hash) —

    The request body schema for the getMyFeesEstimates operation

  • rate_limit (Float) (defaults to: 0.5) —

    Requests per second

Returns:



82
83
84
85
86
 
# File 'lib/peddler/apis/product_fees_v0.rb', line 82

def get_my_fees_estimates(body, rate_limit: 0.5)
  path = "/products/fees/v0/feesEstimate"

  meter(rate_limit).post(path, body:)
end