python-amazon-sp-api 1.9.18__py3-none-any.whl → 2.0.7__py3-none-any.whl

sp_api/asyncio/api/product_fees/product_fees.py

@@ -0,0 +1,194 @@
+from typing import List
+from urllib.parse import quote_plus
+
+from sp_api.base.helpers import sp_endpoint, fill_query_params
+from sp_api.base import ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+from sp_api.util.product_fees import create_fees_body
+
+
+class ProductFees(AsyncBaseClient):
+    """
+    :link: https://github.com/amzn/selling-partner-api-docs/tree/main/references/product-fees-api
+    """
+
+    @sp_endpoint("/products/fees/v0/listings/{}/feesEstimate", method="POST")
+    async def get_product_fees_estimate_for_sku(
+        self,
+        seller_sku,
+        price: float,
+        shipping_price=None,
+        currency="USD",
+        is_fba=False,
+        points: dict = None,
+        marketplace_id: str = None,
+        optional_fulfillment_program: str = None,
+        force_safe_sku: bool = True,
+        **kwargs
+    ) -> ApiResponse:
+        """
+        get_product_fees_estimate_for_sku(self, seller_sku, price: float, shipping_price=None, currency='USD', is_fba=False, points: dict = dict, **kwargs) -> ApiResponse
+
+        Returns fees for sku
+
+        Examples:
+            literal blocks::
+
+                ProductFees().get_product_fees_estimate_for_sku("UmaS1", 10, currency='USD', shipping_price=10, is_fba=False,
+                                                          points={
+                                                              "PointsNumber": 0,
+                                                              "PointsMonetaryValue": {
+                                                                  "CurrencyCode": "USD",
+                                                                  "Amount": 0
+                                                              }
+                                                          })
+
+        Args:
+            seller_sku:
+            price:
+            shipping_price:
+            currency:
+            is_fba:
+            points:
+            marketplace_id: str | Defaults to self.marketplace_id
+            optional_fulfillment_program:
+            force_safe_sku: bool | Force user SKU quote
+            **kwargs:
+
+        Returns:
+            ApiResponse:
+
+        """
+
+        if force_safe_sku:
+            # handle `forward slash` issue in SKU
+            seller_sku = quote_plus(seller_sku)
+
+        kwargs.update(
+            create_fees_body(
+                price=price,
+                shipping_price=shipping_price,
+                currency=currency,
+                is_fba=is_fba,
+                identifier=seller_sku,
+                points=points,
+                marketplace_id=marketplace_id or self.marketplace_id,
+                optional_fulfillment_program=optional_fulfillment_program,
+            )
+        )
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), seller_sku), data=kwargs
+        )
+
+    @sp_endpoint("/products/fees/v0/items/{}/feesEstimate", method="POST")
+    async def get_product_fees_estimate_for_asin(
+        self,
+        asin,
+        price: float,
+        currency="USD",
+        shipping_price=None,
+        is_fba=False,
+        points: dict = None,
+        marketplace_id: str = None,
+        optional_fulfillment_program: str = None,
+        **kwargs
+    ) -> ApiResponse:
+        """
+        get_product_fees_estimate_for_asin(self, asin, price: float, currency='USD', shipping_price=None, is_fba=False,  points: dict = dict, **kwargs) -> ApiResponse
+
+        Returns fees for asin
+
+        Examples:
+            literal blocks::
+
+                ProductFees().get_product_fees_estimate_for_asin("UmaS1", 10, currency='USD', shipping_price=10, is_fba=False,
+                                                           points={
+                                                               "PointsNumber": 0,
+                                                               "PointsMonetaryValue": {
+                                                                   "CurrencyCode": "USD",
+                                                                   "Amount": 0
+                                                               }
+                                                           })
+
+        Args:
+            asin:
+            price:
+            currency:
+            shipping_price:
+            is_fba:
+            points:
+            marketplace_id: str | Defaults to self.marketplace_id
+            optional_fulfillment_program:
+            **kwargs:
+
+        Returns:
+            ApiResponse:
+
+        """
+        kwargs.update(
+            create_fees_body(
+                price=price,
+                shipping_price=shipping_price,
+                currency=currency,
+                is_fba=is_fba,
+                identifier=asin,
+                points=points,
+                marketplace_id=marketplace_id or self.marketplace_id,
+                optional_fulfillment_program=optional_fulfillment_program,
+            )
+        )
+        return await self._request(fill_query_params(kwargs.pop("path"), asin), data=kwargs)
+
+    async def get_product_fees_estimate(self, estimate_requests: List[dict]) -> ApiResponse:
+        """
+        get_product_fees_estimate(self, estimate_requests: List[dict]) -> ApiResponse
+
+        Return fees for multiple products
+
+        Examples:
+            literal blocks::
+
+                ProductFees().get_product_fees_estimate(
+                        [
+                            dict(id_type='ASIN', id_value='B012345678', price=100),
+                            dict(id_type='ASIN', id_value='B012345678', price=50, is_fba=True),
+                        ]
+                    )
+
+
+        Args:
+            estimate_requests: list of dict where the allowed keys are :
+                id_type: str | ASIN or SellerSKU
+                id_value: str
+                price:
+                currency:
+                shipping_price:
+                is_fba:
+                points:
+                marketplace_id: str | Defaults to self.marketplace_id
+                optional_fulfillment_program:
+        """
+        data = []
+        for estimate in estimate_requests:
+            estimate_payload = dict(estimate)
+            marketplace_id = estimate_payload.pop("marketplace_id", None)
+            data.append(
+                dict(
+                    **create_fees_body(
+                        marketplace_id=marketplace_id or self.marketplace_id,
+                        **estimate_payload,
+                    )
+                )
+            )
+        return await self._request(
+            "/products/fees/v0/feesEstimate",
+            data=data,
+            params=dict(method="POST"),
+            wrap_list=True,
+        )
+
+    def _add_marketplaces(self, data):
+        # MarketplaceID is a property of the body's FeesEstimateRequest for this section, and does
+        # not need to be added. Additionally, Client._add_marketplaces will fail as it assumes
+        # data is a dict, which is not the case for get_product_fees_estimate.
+        pass

sp_api/asyncio/api/product_type_definitions/product_type_definitions.py

@@ -0,0 +1,75 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class ProductTypeDefinitions(AsyncBaseClient):
+    """
+    ProductTypeDefinitions SP-API Client
+    :link:
+
+    The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds).
+    """
+
+    @sp_endpoint("/definitions/2020-09-01/productTypes", method="GET")
+    async def search_definitions_product_types(self, **kwargs) -> ApiResponse:
+        """
+        search_definitions_product_types(self, **kwargs) -> ApiResponse
+
+        Search for and return a list of Amazon product types that have definitions available.
+
+        **Usage Plans:**
+
+        ======================================  ==============
+        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. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            key keywords:array |  A comma-delimited list of keywords to search product types by.
+            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/definitions/2020-09-01/productTypes/{}", method="GET")
+    async def get_definitions_product_type(self, productType, **kwargs) -> ApiResponse:
+        """
+        get_definitions_product_type(self, productType, **kwargs) -> ApiResponse
+
+        Retrieve an Amazon product type definition.
+
+        **Usage Plans:**
+
+
+        ======================================  ==============
+        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. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            productType:string | * REQUIRED The Amazon product type name.
+            key sellerId:string |  A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner.
+            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.
+            key productTypeVersion:string |  The version of the Amazon product type to retrieve. Defaults to "LATEST",. Prerelease versions of product type definitions may be retrieved with "RELEASE_CANDIDATE". If no prerelease version is currently available, the "LATEST" live version will be provided.
+            key requirements:string |  The name of the requirements set to retrieve requirements for.
+            key requirementsEnforced:string |  Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates).
+            key locale:string |  Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), productType), params=kwargs
+        )

sp_api/asyncio/api/products/products.py

@@ -0,0 +1,405 @@
+from typing import Optional, List, Dict, Union
+
+from sp_api.base import ApiResponse, Client, fill_query_params, sp_endpoint
+from sp_api.asyncio.base import AsyncBaseClient
+from sp_api.api.products.products_definitions import (
+    GetCompetitiveSummaryBatch,
+    GetFeaturedOfferExpectedPriceBatch,
+    GetItemOffersBatchRequest,
+    GetListingOffersBatchRequest,
+)
+from sp_api.util import ensure_csv
+
+
+class Products(AsyncBaseClient):
+    """
+    :links:
+        https://github.com/amzn/selling-partner-api-docs/blob/main/references/product-pricing-api/productPricingV0.md
+        https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-reference
+    """
+
+    @sp_endpoint("/products/pricing/v0/price", method="GET")
+    async def get_product_pricing_for_skus(
+        self, seller_sku_list: [str], item_condition=None, offer_type=None, **kwargs
+    ) -> ApiResponse:
+        """
+        get_product_pricing_for_skus(self, seller_sku_list: [str], item_condition: str = None, **kwargs) -> ApiResponse
+        Returns pricing information for a seller's offer listings based on SKU.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .5                                      1
+        ======================================  ==============
+
+        Examples:
+            literal blocks::
+
+                Products().get_product_pricing_for_skus(['sku', 'sku1'], MarketplaceId="ATVPDKIKX0DER")
+
+        Args:
+            seller_sku_list: [str]
+            item_condition: str ("New", "Used", "Collectible", "Refurbished", "Club")
+            offer_type: str ("B2C" or "B2B") Default is B2C.
+            **kwargs:
+
+        Returns:
+            ApiResponse:
+        """
+        if item_condition is not None:
+            kwargs["ItemCondition"] = item_condition
+        if offer_type is not None:
+            kwargs["OfferType"] = offer_type
+
+        return self._create_get_pricing_request(seller_sku_list, "Sku", **kwargs)
+
+    @sp_endpoint("/products/pricing/v0/price", method="GET")
+    async def get_product_pricing_for_asins(
+        self, asin_list: [str], item_condition=None, offer_type=None, **kwargs
+    ) -> ApiResponse:
+        """
+        get_product_pricing_for_asins(self, asin_list: [str], item_condition=None, **kwargs) -> ApiResponse
+        Returns pricing information for a seller's offer listings based on ASIN.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .5                                      1
+        ======================================  ==============
+
+        Examples:
+            literal blocks::
+
+                Products().get_product_pricing_for_asins(['asin1', 'asin2'], MarketplaceId="ATVPDKIKX0DER")
+
+        Args:
+            asin_list: [str]
+            item_condition: str | ("New", "Used", "Collectible", "Refurbished", "Club") Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. Available values : New, Used, Collectible, Refurbished, Club
+            offer_type: str ("B2C" or "B2B") Default is B2C.
+        Returns:
+            ApiResponse
+        """
+        if item_condition is not None:
+            kwargs["ItemCondition"] = item_condition
+        if offer_type is not None:
+            kwargs["OfferType"] = offer_type
+
+        return self._create_get_pricing_request(asin_list, "Asin", **kwargs)
+
+    @sp_endpoint("/products/pricing/v0/competitivePrice", method="GET")
+    async def get_competitive_pricing_for_skus(
+        self, seller_sku_list: [str], customer_type=None, **kwargs
+    ) -> ApiResponse:
+        """
+        get_competitive_pricing_for_skus(self, seller_sku_list, **kwargs) -> ApiResponse
+        Returns competitive pricing information for a seller's offer listings based on Seller Sku
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .5                                      1
+        ======================================  ==============
+
+        Examples:
+            literal blocks::
+
+                Products().get_competitive_pricing_for_skus([], MarketplaceId="ATVPDKIKX0DER")
+
+        Args:
+            seller_sku_list: [str]
+            customer_type: Optional (query) str ("Consumer" or "Business") Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer.
+
+        Returns:
+            ApiResponse
+        """
+
+        if customer_type is not None:
+            kwargs["CustomerType"] = customer_type
+
+        return self._create_get_pricing_request(seller_sku_list, "Sku", **kwargs)
+
+    @sp_endpoint("/products/pricing/v0/competitivePrice", method="GET")
+    async def get_competitive_pricing_for_asins(
+        self, asin_list: [str], customer_type=None, **kwargs
+    ) -> ApiResponse:
+        """
+        get_competitive_pricing_for_asins(self, asin_list, **kwargs) -> ApiResponse
+        Returns competitive pricing information for a seller's offer listings based on ASIN
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .5                                      1
+        ======================================  ==============
+
+        Examples:
+            literal blocks::
+
+                Products().get_competitive_pricing_for_asins([], MarketplaceId="ATVPDKIKX0DER")
+
+        Args:
+            asin_list: [str]
+            customer_type: Optional (query) str ("Consumer" or "Business") Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer.
+
+        Returns:
+            ApiResponse
+
+        """
+        if customer_type is not None:
+            kwargs["CustomerType"] = customer_type
+
+        return self._create_get_pricing_request(asin_list, "Asin", **kwargs)
+
+    @sp_endpoint("/products/pricing/v0/listings/{}/offers", method="GET")
+    async def get_listings_offer(
+        self, seller_sku: str, item_condition: str, customer_type: str = None, **kwargs
+    ) -> ApiResponse:
+        """
+        get_listings_offer(self, seller_sku: str, **kwargs) -> ApiResponse
+        Returns the lowest priced offers for a single SKU listing
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       2
+        ======================================  ==============
+
+        Args:
+            key MarketplaceId: Required (query) str
+            item_condition: Required (query) str | ("New", "Used", "Collectible", "Refurbished", "Club") Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. Available values : New, Used, Collectible, Refurbished, Club
+            seller_sku: Required (path) str
+            customer_type: Optional (query) str ("Consumer" or "Business") Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer.
+
+
+        Returns:
+            ApiResponse
+
+        """
+        kwargs["ItemCondition"] = item_condition
+
+        if customer_type is not None:
+            kwargs["CustomerType"] = customer_type
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), seller_sku), params={**kwargs}
+        )
+
+    @sp_endpoint("/products/pricing/v0/items/{}/offers", method="GET")
+    async def get_item_offers(
+        self, asin: str, item_condition: str, customer_type: str = None, **kwargs
+    ) -> ApiResponse:
+        """
+        get_item_offers(self, asin: str, **kwargs) -> ApiResponse
+        Returns the lowest priced offers for a single item based on ASIN
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .5                                      1
+        ======================================  ==============
+
+        Args:
+            key MarketplaceId: Required (query) str
+            item_condition: Required (query) str | ("New", "Used", "Collectible", "Refurbished", "Club") Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. Available values : New, Used, Collectible, Refurbished, Club
+            asin: Required (path) str
+            customer_type: Optional (query) str ("Consumer" or "Business") Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer.
+
+
+        Returns:
+            ApiResponse
+
+        """
+        kwargs["ItemCondition"] = item_condition
+
+        if customer_type is not None:
+            kwargs["CustomerType"] = customer_type
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), asin), params={**kwargs}
+        )
+
+    @sp_endpoint("/batches/products/pricing/v0/itemOffers", method="POST")
+    async def get_item_offers_batch(
+        self,
+        requests_: Optional[Union[List[Dict], GetItemOffersBatchRequest]] = None,
+        **kwargs,
+    ) -> ApiResponse:
+        """
+        get_item_offers_batch(self, requests_: Optional[List[Union[Dict, ItemOffersRequest]]], **kwargs) -> ApiResponse
+        Returns the lowest priced offers for a batch of items based on ASIN.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .5                                       1
+        ======================================  ==============
+
+        Args:
+            requests_: Optional (Body) [dict] The request associated with the getItemOffersBatch API call.
+
+
+        Returns:
+            ApiResponse
+
+        """
+        if isinstance(requests_, GetItemOffersBatchRequest):
+            get_item_offers_batch_request = requests_.to_dict()
+        else:
+            get_item_offers_batch_request = {"requests": requests_}
+
+        return await self._request(
+            kwargs.pop("path"),
+            data=get_item_offers_batch_request,
+            params={**kwargs},
+            add_marketplace=False,
+        )
+
+    @sp_endpoint("/batches/products/pricing/v0/listingOffers", method="POST")
+    async def get_listing_offers_batch(
+        self,
+        requests_: Optional[Union[List[Dict], GetListingOffersBatchRequest]] = None,
+        **kwargs,
+    ) -> ApiResponse:
+        """
+        get_listing_offers_batch(self, requests_: Optional[Union[List[Dict], GetListingOffersBatchRequest]], **kwargs) -> ApiResponse
+        Returns the lowest priced offers for a batch of listings based on ASIN.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .5                                       1
+        ======================================  ==============
+
+        Args:
+            requests_: Optional (Body) [dict] The request associated with the getListingOffersBatch API call.
+
+
+        Returns:
+            ApiResponse
+
+        """
+        if isinstance(requests_, GetListingOffersBatchRequest):
+            get_listing_offers_batch_request = requests_.to_dict()
+        else:
+            get_listing_offers_batch_request = {"requests": requests_}
+
+        return await self._request(
+            kwargs.pop("path"),
+            data=get_listing_offers_batch_request,
+            params={**kwargs},
+            add_marketplace=False,
+        )
+
+    @sp_endpoint('/batches/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice', method='POST')
+    async def get_featured_offer_expected_price_batch(self, requests_: Optional[
+        Union[List[Dict], GetFeaturedOfferExpectedPriceBatch]], **kwargs) -> ApiResponse:
+        """
+        get_featured_offer_expected_price_batch(self, **kwargs) -> ApiResponse
+
+        Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request
+        body. The response for each successful (HTTP status code 200) request in the set includes the computed listing
+        price at or below which a seller can expect to become the featured offer (before applicable promotions).
+        This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing
+        offers may change, and different offers may be featured based on other factors, including fulfillment
+        capabilities to a specific customer. The response to an unsuccessful request includes the available error text.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .033                                    1
+        ======================================  ==============
+
+        Args:
+            requests_: [dict] The request associated with the getFeaturedOfferExpectedPriceBatch API call.
+
+        Returns:
+            ApiResponse:
+        """
+        if isinstance(requests_, GetFeaturedOfferExpectedPriceBatch):
+            get_featured_offer_expected_price_batch_request = requests_.to_dict()
+        else:
+            get_featured_offer_expected_price_batch_request = {"requests": requests_}
+
+        return await self._request(
+            kwargs.pop('path'),
+            data=get_featured_offer_expected_price_batch_request,
+            params={**kwargs},
+            add_marketplace=False
+        )
+
+    @sp_endpoint('/batches/products/pricing/2022-05-01/items/competitiveSummary', method='POST')
+    async def get_competitive_summary_batch(self, requests_: Optional[Union[List[Dict], GetCompetitiveSummaryBatch]], **kwargs) -> ApiResponse:
+        """
+        get_competitive_summary(self, **kwargs) -> ApiResponse
+
+        Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .033                                    1
+        ======================================  ==============
+
+        Args:
+            requests_: The request associated with the getCompetitiveSummary API call.
+
+        Returns:
+            ApiResponse:
+        """
+        if isinstance(requests_, GetCompetitiveSummaryBatch):
+            get_competitive_summary_batch_request = requests_.to_dict()
+        else:
+            get_competitive_summary_batch_request = {"requests": requests_}
+
+        return await self._request(
+            kwargs.pop('path'),
+            data=get_competitive_summary_batch_request,
+            params={**kwargs},
+            add_marketplace=False
+        )
+
+    async def _create_get_pricing_request(self, item_list, item_type, **kwargs):
+        items_csv = ensure_csv(item_list)
+        return await self._request(
+            kwargs.pop("path"),
+            params={
+                **{f"{item_type}s": items_csv},
+                "ItemType": item_type,
+                **(
+                    {"ItemCondition": kwargs.pop("ItemCondition")}
+                    if "ItemCondition" in kwargs
+                    else {}
+                ),
+                **(
+                    {"CustomerType": kwargs.pop("CustomerType")}
+                    if "CustomerType" in kwargs
+                    else {}
+                ),
+                **(
+                    {"OfferType": kwargs.pop("OfferType")}
+                    if "OfferType" in kwargs
+                    else {}
+                ),
+                "MarketplaceId": kwargs.get("MarketplaceId", self.marketplace_id),
+            },
+        )