python-amazon-sp-api 1.7.5__py3-none-any.whl → 2.0.10__py3-none-any.whl

sp_api/api/orders/orders.py

@@ -1,13 +1,62 @@
-from sp_api.base import sp_endpoint, fill_query_params, ApiResponse, deprecated
-from sp_api.base import Client, Marketplaces
+from __future__ import annotations
+
+import enum
+from typing import Any, Literal, overload
+
+from sp_api.base import ApiResponse, Client, Marketplaces, deprecated, fill_query_params, sp_endpoint
+from sp_api.util import normalize_csv_param
+
+from .orders_2026_01_01 import OrdersV20260101
+
+
+class OrdersVersion(str, enum.Enum):
+    V0 = "v0"  # legacy
+    V_2026_01_01 = "2026-01-01"
+    LATEST = "2026-01-01"
 
 
 class Orders(Client):
-    """
+    """Orders API client.
+
+    This class implements the legacy Orders API **v0**.
+
+    If you pass version "2026-01-01" (or :class:`OrdersVersion.V_2026_01_01`)
+    to the constructor, :meth:`__new__` returns an instance of
+    :class:`~sp_api.api.orders.orders_2026_01_01.OrdersV20260101` instead.
+
     :link: https://github.com/amzn/selling-partner-api-docs/tree/main/references/orders-api
     """
 
-    @sp_endpoint('/orders/v0/orders')
+    @overload
+    def __new__(
+        cls,
+        *args: Any,
+        version: Literal[OrdersVersion.V_2026_01_01, "2026-01-01"],
+        **kwargs: Any,
+    ) -> OrdersV20260101: ...
+
+    @overload
+    def __new__(
+        cls,
+        *args: Any,
+        version: str | OrdersVersion | None = None,
+        **kwargs: Any,
+    ) -> "Orders": ...
+
+    def __new__(
+        cls,
+        *args: Any,
+        version: str | OrdersVersion | None = None,
+        **kwargs: Any,
+    ):
+        if cls is Orders:
+            v = version if version is not None else kwargs.get("version")
+            if v in (OrdersVersion.V_2026_01_01, OrdersVersion.LATEST, "2026-01-01"):
+                kwargs.pop("version", None)
+                return OrdersV20260101(*args, **kwargs)
+        return super().__new__(cls)
+
+    @sp_endpoint("/orders/v0/orders")
     def get_orders(self, **kwargs) -> ApiResponse:
         """
         get_orders(self, **kwargs) -> ApiResponse
@@ -53,11 +102,17 @@ class Orders(Client):
 
 
         """
-        if 'RestrictedResources' in kwargs:
+        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})
+        return self._request(kwargs.pop("path"), params={**kwargs})
 
-    @sp_endpoint('/orders/v0/orders/{}')
+    @sp_endpoint("/orders/v0/orders/{}")
     def get_order(self, order_id: str, **kwargs) -> ApiResponse:
         """
         get_order(self, order_id: str, **kwargs) -> ApiResponse
@@ -89,12 +144,18 @@ class Orders(Client):
 
 
         """
-        if 'RestrictedResources' in kwargs:
-            kwargs.update({'original_path': fill_query_params(kwargs.get('path'), order_id)})
+        if "RestrictedResources" in kwargs:
+            kwargs.update(
+                {"original_path": fill_query_params(kwargs.get("path"), order_id)}
+            )
             return self._access_restricted(kwargs)
-        return self._request(fill_query_params(kwargs.pop('path'), order_id), params={**kwargs}, add_marketplace=False)
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id),
+            params={**kwargs},
+            add_marketplace=False,
+        )
 
-    @sp_endpoint('/orders/v0/orders/{}/orderItems')
+    @sp_endpoint("/orders/v0/orders/{}/orderItems")
     def get_order_items(self, order_id: str, **kwargs) -> ApiResponse:
         """
         get_order_items(self, order_id: str, **kwargs) -> ApiResponse
@@ -136,12 +197,16 @@ class Orders(Client):
             ApiResponse:
 
         """
-        if 'RestrictedResources' in kwargs:
-            kwargs.update({'original_path': fill_query_params(kwargs.get('path'), order_id)})
+        if "RestrictedResources" in kwargs:
+            kwargs.update(
+                {"original_path": fill_query_params(kwargs.get("path"), order_id)}
+            )
             return self._access_restricted(kwargs)
-        return self._request(fill_query_params(kwargs.pop('path'), order_id), params={**kwargs})
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id), params={**kwargs}
+        )
 
-    @sp_endpoint('/orders/v0/orders/{}/address')
+    @sp_endpoint("/orders/v0/orders/{}/address")
     def get_order_address(self, order_id, **kwargs) -> ApiResponse:
         """
         get_order_address(self, order_id, **kwargs) -> ApiResponse
@@ -168,9 +233,11 @@ class Orders(Client):
         Returns:
             ApiResponse
         """
-        return self._request(fill_query_params(kwargs.pop('path'), order_id), params={**kwargs})
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id), params={**kwargs}
+        )
 
-    @sp_endpoint('/orders/v0/orders/{}/buyerInfo')
+    @sp_endpoint("/orders/v0/orders/{}/buyerInfo")
     def get_order_buyer_info(self, order_id: str, **kwargs) -> ApiResponse:
         """
         get_order_buyer_info(self, order_id: str, **kwargs) -> ApiResponse
@@ -201,9 +268,11 @@ class Orders(Client):
             GetOrderBuyerInfoResponse:
 
         """
-        return self._request(fill_query_params(kwargs.pop('path'), order_id), params={**kwargs})
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id), params={**kwargs}
+        )
 
-    @sp_endpoint('/orders/v0/orders/{}/orderItems/buyerInfo')
+    @sp_endpoint("/orders/v0/orders/{}/orderItems/buyerInfo")
     def get_order_items_buyer_info(self, order_id: str, **kwargs) -> ApiResponse:
         """
         get_order_items_buyer_info(self, order_id: str, **kwargs) -> ApiResponse
@@ -232,9 +301,11 @@ class Orders(Client):
         Returns:
             ApiResponse
         """
-        return self._request(fill_query_params(kwargs.pop('path'), order_id), params=kwargs)
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id), params=kwargs
+        )
 
-    @sp_endpoint('/orders/v0/orders/{}/shipment', method='POST')
+    @sp_endpoint("/orders/v0/orders/{}/shipment", method="POST")
     def update_shipment_status(self, order_id: str, **kwargs) -> ApiResponse:
         """
         update_shipment_status(self, order_id: str, **kwargs) -> ApiResponse
@@ -258,9 +329,13 @@ class Orders(Client):
         Returns:
             ApiResponse
         """
-        return self._request(fill_query_params(kwargs.pop('path'), order_id), res_no_data=True, data=kwargs)
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id),
+            res_no_data=True,
+            data=kwargs,
+        )
 
-    @sp_endpoint('/orders/v0/orders/{}/shipmentConfirmation', method='POST')
+    @sp_endpoint("/orders/v0/orders/{}/shipmentConfirmation", method="POST")
     def confirm_shipment(self, order_id: str, **kwargs) -> ApiResponse:
         """
         confirm_shipment(self, order_id: str, **kwargs) -> ApiResponse
@@ -300,27 +375,37 @@ class Orders(Client):
         Returns:
             ApiResponse
         """
-        return self._request(fill_query_params(kwargs.pop('path'), order_id), add_marketplace=False, res_no_data=True,
-                             data=kwargs)
-
-    @sp_endpoint('/tokens/2021-03-01/restrictedDataToken', method='POST')
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id),
+            add_marketplace=False,
+            res_no_data=True,
+            data=kwargs,
+        )
+
+    @sp_endpoint("/tokens/2021-03-01/restrictedDataToken", method="POST")
     def _get_token(self, **kwargs):
-        data_elements = kwargs.pop('RestrictedResources')
+        data_elements = kwargs.pop("RestrictedResources")
 
-        restricted_resources = [{
-            "method": "GET",
-            "path": kwargs.get('original_path'),
-            "dataElements": data_elements
-        }]
+        restricted_resources = [
+            {
+                "method": "GET",
+                "path": kwargs.get("original_path"),
+                "dataElements": data_elements,
+            }
+        ]
 
-        return self._request(kwargs.pop('path'), data={'restrictedResources': restricted_resources, **kwargs})
+        return self._request(
+            kwargs.pop("path"),
+            data={"restrictedResources": restricted_resources, **kwargs},
+        )
 
     def _access_restricted(self, kwargs):
-        if 'original_path' not in kwargs:
-            kwargs.update({'original_path': kwargs['path']})
+        if "original_path" not in kwargs:
+            kwargs.update({"original_path": kwargs["path"]})
         token = self._get_token(**kwargs).payload
-        self.restricted_data_token = token['restrictedDataToken']
-        r = self._request(kwargs.pop('original_path'), params={**kwargs})
+        self.restricted_data_token = token["restrictedDataToken"]
+        r = self._request(kwargs.pop("original_path"), params={**kwargs})
         if not self.keep_restricted_data_token:
             self.restricted_data_token = None
         return r
+

sp_api/api/orders/orders_2026_01_01.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+from typing import Any
+
+from sp_api.base import ApiResponse, Client, fill_query_params, sp_endpoint
+from sp_api.util import normalize_csv_param
+
+
+class OrdersV20260101(Client):
+    """Orders API (version 2026-01-01).
+
+    This is a newer Orders API version that uses different endpoints/parameters
+    than the legacy v0 Orders API implemented by :class:`sp_api.api.orders.orders.Orders`.
+
+    Model source:
+    https://github.com/amzn/selling-partner-api-models/blob/main/models/orders-api-model/orders_2026-01-01.json
+    """
+
+    @sp_endpoint("/orders/2026-01-01/orders")
+    def search_orders(self, **kwargs: Any) -> ApiResponse:
+        """Search orders.
+
+        Corresponds to GET /orders/2026-01-01/orders (operationId: searchOrders).
+
+        Notes:
+        - Parameters are lowerCamelCase in this version (e.g. createdAfter).
+        - List parameters can be passed as Python lists; they will be normalized
+          into a comma-delimited string.
+        """
+
+        normalize_csv_param(kwargs, "fulfillmentStatuses")
+        normalize_csv_param(kwargs, "marketplaceIds")
+        normalize_csv_param(kwargs, "fulfilledBy")
+        normalize_csv_param(kwargs, "includedData")
+
+        return self._request(kwargs.pop("path"), params={**kwargs})
+
+    @sp_endpoint("/orders/2026-01-01/orders/{}")
+    def get_order(self, order_id: str, **kwargs: Any) -> ApiResponse:
+        """Get order by orderId.
+
+        Corresponds to GET /orders/2026-01-01/orders/{orderId} (operationId: getOrder).
+
+        Args:
+            order_id: The Amazon order identifier.
+            includedData: Optional list of datasets to include in the response.
+        """
+
+        normalize_csv_param(kwargs, "includedData")
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id),
+            params={**kwargs},
+            add_marketplace=False,
+        )

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):
@@ -10,11 +11,20 @@ class ProductFees(Client):
     :link: https://github.com/amzn/selling-partner-api-docs/tree/main/references/product-fees-api
     """
 
-    @sp_endpoint('/products/fees/v0/listings/{}/feesEstimate', method='POST')
-    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:
+    @sp_endpoint("/products/fees/v0/listings/{}/feesEstimate", method="POST")
+    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
 
@@ -50,17 +60,38 @@ class ProductFees(Client):
         """
 
         if force_safe_sku:
-            #handle `forward slash` issue in 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 self._request(fill_query_params(kwargs.pop('path'), seller_sku), data=kwargs)
-
-    @sp_endpoint('/products/fees/v0/items/{}/feesEstimate', method='POST')
-    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:
+        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 self._request(
+            fill_query_params(kwargs.pop("path"), seller_sku), data=kwargs
+        )
+
+    @sp_endpoint("/products/fees/v0/items/{}/feesEstimate", method="POST")
+    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
 
@@ -93,9 +124,19 @@ class ProductFees(Client):
             ApiResponse:
 
         """
-        kwargs.update(self._create_body(price, shipping_price, currency, is_fba, asin, points, marketplace_id, optional_fulfillment_program))
-        return self._request(fill_query_params(kwargs.pop('path'), asin), data=kwargs)
-
+        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 self._request(fill_query_params(kwargs.pop("path"), asin), data=kwargs)
 
     def get_product_fees_estimate(self, estimate_requests: List[dict]) -> ApiResponse:
         """
@@ -126,57 +167,24 @@ class ProductFees(Client):
                 marketplace_id: str | Defaults to self.marketplace_id
                 optional_fulfillment_program:
         """
-        data = [
-            dict(
-                **self._create_body(**er)
+        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,
+                    )
+                )
             )
-            for er in estimate_requests
-        ]
-        return 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
-
+        return 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

sp_api/api/product_type_definitions/product_type_definitions.py

@@ -6,13 +6,12 @@ from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
 class ProductTypeDefinitions(Client):
     """
     ProductTypeDefinitions SP-API Client
-    :link: 
+    :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')
+    @sp_endpoint("/definitions/2020-09-01/productTypes", method="GET")
     def search_definitions_product_types(self, **kwargs) -> ApiResponse:
         """
         search_definitions_product_types(self, **kwargs) -> ApiResponse
@@ -36,11 +35,10 @@ class ProductTypeDefinitions(Client):
         Returns:
             ApiResponse:
         """
-    
-        return self._request(kwargs.pop('path'),  params=kwargs)
-    
 
-    @sp_endpoint('/definitions/2020-09-01/productTypes/{}', method='GET')
+        return self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/definitions/2020-09-01/productTypes/{}", method="GET")
     def get_definitions_product_type(self, productType, **kwargs) -> ApiResponse:
         """
         get_definitions_product_type(self, productType, **kwargs) -> ApiResponse
@@ -70,6 +68,7 @@ class ProductTypeDefinitions(Client):
         Returns:
             ApiResponse:
         """
-    
-        return self._request(fill_query_params(kwargs.pop('path'), productType), params=kwargs)
-    
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), productType), params=kwargs
+        )