python-amazon-sp-api 1.9.60__py3-none-any.whl → 2.0.3__py3-none-any.whl

sp_api/asyncio/api/product_fees/product_fees.py

@@ -0,0 +1,237 @@
+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 Client, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+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(
+            self._create_body(
+                price,
+                shipping_price,
+                currency,
+                is_fba,
+                seller_sku,
+                points,
+                marketplace_id,
+                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(
+            self._create_body(
+                price,
+                shipping_price,
+                currency,
+                is_fba,
+                asin,
+                points,
+                marketplace_id,
+                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 = [dict(**self._create_body(**er)) for er in estimate_requests]
+        return await self._request(
+            "/products/fees/v0/feesEstimate",
+            data=data,
+            params=dict(method="POST"),
+            wrap_list=True,
+        )
+
+    def _create_body(
+        self,
+        price,
+        shipping_price=None,
+        currency="USD",
+        is_fba=False,
+        identifier=None,
+        points: dict = None,
+        marketplace_id: str = None,
+        optional_fulfillment_program: str = None,
+        id_type=None,
+        id_value=None,
+    ):
+        """
+        Create request body
+
+        Args:
+            price:
+            shipping_price:
+            currency:
+            is_fba:
+            identifier:
+            points:
+
+        Returns:
+
+        """
+        body = {
+            "FeesEstimateRequest": {
+                "Identifier": identifier or str(price),
+                "PriceToEstimateFees": {
+                    "ListingPrice": {"Amount": price, "CurrencyCode": currency},
+                    "Shipping": (
+                        {"Amount": shipping_price, "CurrencyCode": currency}
+                        if shipping_price
+                        else None
+                    ),
+                    "Points": points or None,
+                },
+                "IsAmazonFulfilled": is_fba,
+                "OptionalFulfillmentProgram": (
+                    optional_fulfillment_program
+                    if is_fba is True and optional_fulfillment_program
+                    else None
+                ),
+                "MarketplaceId": marketplace_id or self.marketplace_id,
+            }
+        }
+
+        if id_type and id_value:
+            body["IdType"] = id_type
+            body["IdValue"] = id_value
+
+        return body
+
+    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
+        )