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

sp_api/api/feeds/feeds.py

@@ -1,8 +1,9 @@
 import zlib
 
-import requests
+import httpx
 
 from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.util import should_add_marketplace
 
 
 class Feeds(Client):
@@ -34,7 +35,7 @@ class Feeds(Client):
             ApiResponse:
         """
 
-        add_marketplace = not "nextToken" in kwargs
+        add_marketplace = should_add_marketplace(kwargs, "nextToken")
         return self._request(
             kwargs.pop("path"), params=kwargs, add_marketplace=add_marketplace
         )
@@ -185,11 +186,12 @@ class Feeds(Client):
             upload_data = upload_data.encode("iso-8859-1")
         except AttributeError:
             pass
-        upload = requests.put(
-            response.payload.get("url"),
-            data=upload_data,
-            headers={"Content-Type": content_type},
-        )
+        with httpx.Client() as client:
+            upload = client.put(
+                response.payload.get("url"),
+                content=upload_data,
+                headers={"Content-Type": content_type},
+            )
         if 200 <= upload.status_code < 300:
             return response
         from sp_api.base.exceptions import SellingApiException
@@ -240,7 +242,8 @@ class Feeds(Client):
             add_marketplace=False,
         )
         url = response.payload.get("url")
-        doc_response = requests.get(url)
+        with httpx.Client() as client:
+            doc_response = client.get(url)
 
         encoding = (
             doc_response.encoding

sp_api/api/finances/finances.py

@@ -1,10 +1,23 @@
+import enum
+
 from sp_api.base import Client, Marketplaces, ApiResponse
 from sp_api.base import sp_endpoint, fill_query_params
 
+class FinancesVersion(str, enum.Enum):
+    V_0 = "v0"
+    V_2024_06_19 = "2024-06-19"
+    LATEST = "2024-06-19"
+
 
 class Finances(Client):
+    version: FinancesVersion = FinancesVersion.V_0
+
+    def __init__(self, *args, **kwargs):
+        if "version" in kwargs:
+            self.version = kwargs.get("version", FinancesVersion.V_0)
+        super().__init__(*args, **{**kwargs, "version": self.version})
 
-    @sp_endpoint("/finances/v0/orders/{}/financialEvents")
+    @sp_endpoint("/finances/<version>/orders/{}/financialEvents")
     def get_financial_events_for_order(self, order_id, **kwargs) -> ApiResponse:
         """
         get_financial_events_for_order(self, order_id, **kwargs) -> ApiResponse
@@ -25,7 +38,7 @@ class Finances(Client):
             fill_query_params(kwargs.pop("path"), order_id), params={**kwargs}
         )
 
-    @sp_endpoint("/finances/v0/financialEvents")
+    @sp_endpoint("/finances/<version>/financialEvents")
     def list_financial_events(self, **kwargs) -> ApiResponse:
         """
         list_financial_events(self, **kwargs) -> ApiResponse:
@@ -39,7 +52,7 @@ class Finances(Client):
         """
         return self._request(fill_query_params(kwargs.pop("path")), params={**kwargs})
 
-    @sp_endpoint("/finances/v0/financialEventGroups/{}/financialEvents")
+    @sp_endpoint("/finances/<version>/financialEventGroups/{}/financialEvents")
     def list_financial_events_by_group_id(
         self, event_group_id, **kwargs
     ) -> ApiResponse:
@@ -58,7 +71,7 @@ class Finances(Client):
             fill_query_params(kwargs.pop("path"), event_group_id), params={**kwargs}
         )
 
-    @sp_endpoint("/finances/v0/financialEventGroups")
+    @sp_endpoint("/finances/<version>/financialEventGroups")
     def list_financial_event_groups(self, **kwargs) -> ApiResponse:
         """
         list_financial_event_groups(self, **kwargs) -> ApiResponse:
@@ -71,3 +84,16 @@ class Finances(Client):
 
         """
         return self._request(kwargs.pop("path"), params={**kwargs})
+
+    @sp_endpoint("/finances/<version>/transactions")
+    def list_transactions(self, **kwargs) -> ApiResponse:
+        """
+        list_transactions(self, **kwargs) -> ApiResponse:
+
+        Args:
+            **kwargs:
+
+        Returns: ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), params={**kwargs})

sp_api/api/fulfillment_inbound/fulfillment_inbound.py

@@ -4,6 +4,7 @@ from sp_api.base import Client, Marketplaces, ApiResponse
 from sp_api.base import sp_endpoint, fill_query_params
 
 import urllib.parse
+from sp_api.util import ensure_csv
 
 
 class FulfillmentInboundVersion(str, enum.Enum):
@@ -197,6 +198,39 @@ class FulfillmentInbound(Client):
             fill_query_params(kwargs.pop("path"), shipment_id), data={**data, **kwargs}
         )
 
+    @sp_endpoint(
+        "/inbound/fba/<version>/inboundPlans/{}/shipments/{}/name", method="PUT"
+    )
+    def update_shipment_name(self, inboundPlanId, shipmentId, **kwargs):
+        """
+                update_shipment_name(self, inboundPlanId, shipmentId, **kwargs) -> ApiResponse
+
+                Updates the name of an existing shipment.
+
+        **Usage Plan:**
+
+        | Rate (requests per second) | Burst |
+        | ---- | ---- |
+        | 2 | 30 |
+
+        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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+
+                Args:
+
+                    inboundPlanId:string | * REQUIRED Identifier to an inbound plan.
+
+                    shipmentId:string | * REQUIRED Identifier to a shipment. A shipment contains the boxes and units being inbounded.
+
+                    body: | * REQUIRED {'name': {'description': 'A human-readable name to update the shipment name to.'}, 'type': 'string'}
+
+                Returns:
+                    ApiResponse:
+        """
+        return self._request(
+            fill_query_params(kwargs.pop("path"), inboundPlanId, shipmentId),
+            data=kwargs,
+        )
+
     @sp_endpoint("/fba/inbound/<version>/shipments/{}/preorder")
     def preorder(self, shipment_id, **kwargs):
         """
@@ -456,8 +490,7 @@ class FulfillmentInbound(Client):
         Returns:
             ApiResponse
         """
-        if not isinstance(shipment_id_list, str):
-            shipment_id_list = ",".join(shipment_id_list)
+        shipment_id_list = ensure_csv(shipment_id_list)
         return self.get_shipments(
             QueryType="SHIPMENT", ShipmentIdList=shipment_id_list, **kwargs
         )

sp_api/api/inventories/inventories.py

@@ -1,8 +1,8 @@
-from collections import abc
 import urllib
 
 from sp_api.base import Client, Marketplaces, sp_endpoint, ApiResponse
 from sp_api.base.InventoryEnums import InventoryGranularity
+from sp_api.util import normalize_csv_param
 
 
 class Inventories(Client):
@@ -68,11 +68,6 @@ class Inventories(Client):
                 "granularityId": kwargs.get("granularityId", self.marketplace_id),
             }
         )
-        if (
-            "sellerSkus" in kwargs
-            and isinstance(kwargs.get("sellerSkus"), abc.Iterable)
-            and not isinstance(kwargs.get("sellerSkus"), str)
-        ):
-            kwargs.update({"sellerSkus": ",".join(kwargs.get("sellerSkus"))})
+        normalize_csv_param(kwargs, "sellerSkus")
 
         return self._request(kwargs.pop("path"), params=kwargs)

sp_api/api/listings_items/listings_items.py

@@ -1,5 +1,3 @@
-from collections import abc
-
 from sp_api.base import (
     Client,
     sp_endpoint,
@@ -7,6 +5,7 @@ from sp_api.base import (
     ApiResponse,
     IncludedData,
 )
+from sp_api.util import normalize_included_data
 
 
 class ListingsItems(Client):
@@ -65,17 +64,7 @@ class ListingsItems(Client):
         Returns:
             ApiResponse:
         """
-        if (
-            kwargs.get("includedData")
-            and isinstance(kwargs.get("includedData"), abc.Iterable)
-            and not isinstance(kwargs.get("includedData"), str)
-        ):
-            kwargs["includedData"] = ",".join(
-                [
-                    x.value if isinstance(x, IncludedData) else x
-                    for x in kwargs["includedData"]
-                ]
-            )
+        normalize_included_data(kwargs, enum_cls=IncludedData)
 
         return self._request(
             fill_query_params(kwargs.pop("path"), sellerId, sku), params=kwargs
@@ -101,17 +90,7 @@ class ListingsItems(Client):
         Returns:
             ApiResponse:
         """
-        if (
-            kwargs.get("includedData")
-            and isinstance(kwargs.get("includedData"), abc.Iterable)
-            and not isinstance(kwargs.get("includedData"), str)
-        ):
-            kwargs["includedData"] = ",".join(
-                [
-                    x.value if isinstance(x, IncludedData) else x
-                    for x in kwargs["includedData"]
-                ]
-            )
+        normalize_included_data(kwargs, enum_cls=IncludedData)
 
         return self._request(
             fill_query_params(kwargs.pop("path"), sellerId), params=kwargs

sp_api/api/messaging/messaging.py

@@ -466,3 +466,45 @@ class Messaging(Client):
                 "method": kwargs.pop("method"),
             },
         )
+
+    @sp_endpoint("/messaging/v1/orders/{}/messages/invoice", method="POST")
+    def send_invoice(self, order_id, **kwargs) -> ApiResponse:
+        """
+        send_invoice(self, order_id, **kwargs) -> ApiResponse
+
+        Sends a message providing the buyer an invoice
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       5
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            order_id:string | * REQUIRED An Amazon order identifier. This specifies the order for which a message is sent.
+            body: {
+              "attachments": [
+                {
+                  "uploadDestinationId": "string",
+                  "fileName": "string"
+                }
+              ]
+            }
+
+
+        Returns:
+            ApiResponse:
+        """
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
+        )

sp_api/api/orders/orders.py

@@ -1,5 +1,6 @@
 from sp_api.base import sp_endpoint, fill_query_params, ApiResponse, deprecated
 from sp_api.base import Client, Marketplaces
+from sp_api.util import normalize_csv_param
 
 
 class Orders(Client):
@@ -53,6 +54,12 @@ class Orders(Client):
 
 
         """
+        normalize_csv_param(kwargs, "OrderStatuses")
+        normalize_csv_param(kwargs, "MarketplaceIds")
+        normalize_csv_param(kwargs, "FulfillmentChannels")
+        normalize_csv_param(kwargs, "PaymentMethods")
+        normalize_csv_param(kwargs, "AmazonOrderIds")
+
         if "RestrictedResources" in kwargs:
             return self._access_restricted(kwargs)
         return self._request(kwargs.pop("path"), params={**kwargs})

sp_api/api/product_fees/product_fees.py

@@ -3,6 +3,7 @@ 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.util.product_fees import create_fees_body
 
 
 class ProductFees(Client):
@@ -63,15 +64,15 @@ class ProductFees(Client):
             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,
+            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 self._request(
@@ -124,15 +125,15 @@ class ProductFees(Client):
 
         """
         kwargs.update(
-            self._create_body(
-                price,
-                shipping_price,
-                currency,
-                is_fba,
-                asin,
-                points,
-                marketplace_id,
-                optional_fulfillment_program,
+            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 self._request(fill_query_params(kwargs.pop("path"), asin), data=kwargs)
@@ -166,7 +167,18 @@ class ProductFees(Client):
                 marketplace_id: str | Defaults to self.marketplace_id
                 optional_fulfillment_program:
         """
-        data = [dict(**self._create_body(**er)) for er in estimate_requests]
+        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 self._request(
             "/products/fees/v0/feesEstimate",
             data=data,
@@ -174,61 +186,6 @@ class ProductFees(Client):
             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

sp_api/api/products/products.py

@@ -2,14 +2,19 @@ from typing import Optional, List, Dict, Union
 
 from sp_api.base import ApiResponse, Client, fill_query_params, sp_endpoint
 from sp_api.api.products.products_definitions import (
+    GetCompetitiveSummaryBatch,
+    GetFeaturedOfferExpectedPriceBatch,
     GetItemOffersBatchRequest,
     GetListingOffersBatchRequest,
 )
+from sp_api.util import ensure_csv
 
 
 class Products(Client):
     """
-    :link: https://github.com/amzn/selling-partner-api-docs/blob/main/references/product-pricing-api/productPricingV0.md
+    :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")
@@ -300,11 +305,84 @@ class Products(Client):
             add_marketplace=False,
         )
 
+    @sp_endpoint('/batches/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice', method='POST')
+    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 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')
+    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 self._request(
+            kwargs.pop('path'),
+            data=get_competitive_summary_batch_request,
+            params={**kwargs},
+            add_marketplace=False
+        )
+
     def _create_get_pricing_request(self, item_list, item_type, **kwargs):
+        items_csv = ensure_csv(item_list)
         return self._request(
             kwargs.pop("path"),
             params={
-                **{f"{item_type}s": ",".join(item_list)},
+                **{f"{item_type}s": items_csv},
                 "ItemType": item_type,
                 **(
                     {"ItemCondition": kwargs.pop("ItemCondition")}

sp_api/api/products/products_definitions.py

@@ -1,85 +1,11 @@
-from typing import Optional, List, Dict, Union
-from dataclasses import dataclass, asdict
-
-
-@dataclass
-class ItemOffersRequest:
-    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
-    #itemoffersrequest"""
-
-    uri: str
-    method: str
-    MarketplaceId: str
-    ItemCondition: str = None
-    CustomerType: str = None
-    headers: Dict = None
-
-
-@dataclass
-class GetItemOffersBatchRequest:
-    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
-    #getitemoffersbatchrequest"""
-
-    requests: Optional[List[Union[ItemOffersRequest, Dict]]] = None
-
-    def __post_init__(self):
-        self.requests = self.parse_requests(self.requests)
-
-    def to_dict(self):
-        return asdict(self)
-
-    @staticmethod
-    def parse_requests(requests) -> List[ItemOffersRequest]:
-        parsed_requestes = []
-
-        for request in requests:
-            if isinstance(request, Dict):
-                request = ItemOffersRequest(**request)
-
-            if not isinstance(request, ItemOffersRequest):
-                raise TypeError
-
-            parsed_requestes.append(request)
-
-        return parsed_requestes
-
-
-@dataclass
-class ListingOffersRequest:
-    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
-    #listingoffersrequest"""
-
-    uri: str
-    MarketplaceId: str
-    ItemCondition: str
-    method: str = "GET"
-    CustomerType: str = "Consumer"
-
-
-@dataclass
-class GetListingOffersBatchRequest:
-    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
-    #getlistingoffersbatchrequest"""
-
-    requests: Optional[List[Union[ListingOffersRequest, Dict]]] = None
-
-    def __post_init__(self):
-        self.requests = self.parse_requests(self.requests)
-
-    def to_dict(self):
-        return asdict(self)
-
-    @staticmethod
-    def parse_requests(requests) -> List[ListingOffersRequest]:
-        parsed_requestes = []
-
-        for request in requests:
-            if isinstance(request, Dict):
-                request = ListingOffersRequest(**request)
-
-            if not isinstance(request, ListingOffersRequest):
-                raise TypeError
-
-            parsed_requestes.append(request)
-
-        return parsed_requestes
+from sp_api.util.products_definitions import (
+    CompetitiveSummaryIncludedData,
+    ItemOffersRequest,
+    GetItemOffersBatchRequest,
+    ListingOffersRequest,
+    GetListingOffersBatchRequest,
+    FeaturedOfferExpectedPriceRequest,
+    GetFeaturedOfferExpectedPriceBatch,
+    CompetitiveSummaryRequest,
+    GetCompetitiveSummaryBatch,
+)