python-amazon-sp-api 2.0.15__py3-none-any.whl → 2.1.3__py3-none-any.whl

sp_api/asyncio/api/orders/orders_v0.py

@@ -10,47 +10,19 @@ class OrdersV0(AsyncBaseClient):
     async def get_orders(self, **kwargs) -> ApiResponse:
         """
         get_orders(self, **kwargs) -> ApiResponse
-        Returns orders created or updated during the time frame indicated by the specified parameters.
-        You can also apply a range of filtering criteria to narrow the list of orders returned.
-        If NextToken is present, that will be used to retrieve the orders instead of other criteria.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       1
-        ======================================  ==============
-
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response.
+        
         Examples:
             literal blocks::
-
-                Orders().get_orders(CreatedAfter='TEST_CASE_200', MarketplaceIds=["ATVPDKIKX0DER"])
-
+            
+                await OrdersV0().get_orders()
+        
         Args:
-            key CreatedAfter: date
-            key CreatedBefore: date
-            key LastUpdatedAfter: date
-            key LastUpdatedBefore: date
-            key OrderStatuses: [str]
-            key MarketplaceIds: [str]
-            key FulfillmentChannels: [str]
-            key PaymentMethods: [str]
-            key BuyerEmail: str
-            key SellerOrderId: str
-            key MaxResultsPerPage: int
-            key EasyShipShipmentStatuses: [str]
-            key NextToken: str
-            key AmazonOrderIds: [str]
-            key RestrictedResources: [str]
-
+            **kwargs:
+        
         Returns:
-            ApiResponse:
-
-
+            ApiResponse
         """
         normalize_csv_param(kwargs, "OrderStatuses")
         normalize_csv_param(kwargs, "MarketplaceIds")
@@ -65,34 +37,21 @@ class OrdersV0(AsyncBaseClient):
     @sp_endpoint("/orders/v0/orders/{}")
     async def get_order(self, order_id: str, **kwargs) -> ApiResponse:
         """
-        get_order(self, order_id: str, **kwargs) -> ApiResponse
-        Returns the order indicated by the specified order ID.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       1
-        ======================================  ==============
-
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        get_order(self, order_id, **kwargs) -> ApiResponse
+        
+        Returns the order that you specify.
+        
         Examples:
             literal blocks::
-
-                Orders().get_order('TEST_CASE_200')
-
+            
+                await OrdersV0().get_order("value")
+        
         Args:
-            order_id: str
-            key RestrictedResources: [str]
+            order_id:  | required
             **kwargs:
-
+        
         Returns:
-            ApiResponse:
-
-
+            ApiResponse
         """
         if "RestrictedResources" in kwargs:
             kwargs.update(
@@ -108,44 +67,22 @@ class OrdersV0(AsyncBaseClient):
     @sp_endpoint("/orders/v0/orders/{}/orderItems")
     async def get_order_items(self, order_id: str, **kwargs) -> ApiResponse:
         """
-        get_order_items(self, order_id: str, **kwargs) -> ApiResponse
-
-        Returns detailed order item information for the order indicated by the specified order ID.
-        If NextToken is provided, it's used to retrieve the next page of order items.
-
-        Note: When an order is in the Pending state (the order has been placed but payment has not been authorized),
-        the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or
-        promotions for the order items in the order.
-        After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped,
-        Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes,
-        shipping charges, gift status and promotions for the order items in the order.
-
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       1
-        ======================================  ==============
-
-
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        get_order_items(self, order_id, **kwargs) -> ApiResponse
+        
+        Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items.
+                        __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order.
+        
         Examples:
             literal blocks::
-
-                Orders().get_order_items('TEST_CASE_200')
-
+            
+                await OrdersV0().get_order_items("value")
+        
         Args:
-            order_id: str
-            key RestrictedResources: [str]
+            order_id:  | required
             **kwargs:
-
+        
         Returns:
-            ApiResponse:
-
+            ApiResponse
         """
         if "RestrictedResources" in kwargs:
             kwargs.update(
@@ -160,26 +97,18 @@ class OrdersV0(AsyncBaseClient):
     async def get_order_address(self, order_id, **kwargs) -> ApiResponse:
         """
         get_order_address(self, order_id, **kwargs) -> ApiResponse
-
-        Returns the shipping address for the order indicated by the specified order ID.
-
-        :note: To get useful information from this method, you need to have access to PII.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       1
-        ======================================  ==============
-
+        
+        Returns the shipping address for the order that you specify.
+        
         Examples:
-            Orders().get_order_address('TEST_CASE_200')
-
+            literal blocks::
+            
+                await OrdersV0().get_order_address("value")
+        
         Args:
-            order_id: str
+            order_id:  | required
             **kwargs:
-
+        
         Returns:
             ApiResponse
         """
@@ -190,33 +119,21 @@ class OrdersV0(AsyncBaseClient):
     @sp_endpoint("/orders/v0/orders/{}/buyerInfo")
     async def get_order_buyer_info(self, order_id: str, **kwargs) -> ApiResponse:
         """
-        get_order_buyer_info(self, order_id: str, **kwargs) -> ApiResponse
-        Returns buyer information for the order indicated by the specified order ID.
-
-        :note: To get useful information from this method, you need to have access to PII.
-
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       1
-        ======================================  ==============
-
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        get_order_buyer_info(self, order_id, **kwargs) -> ApiResponse
+        
+        Returns buyer information for the order that you specify.
+        
         Examples:
-            Orders().get_order_buyer_info('TEST_CASE_200')
-
+            literal blocks::
+            
+                await OrdersV0().get_order_buyer_info("value")
+        
         Args:
-            order_id: str
+            order_id:  | required
             **kwargs:
-
+        
         Returns:
-            GetOrderBuyerInfoResponse:
-
+            ApiResponse
         """
         return await self._request(
             fill_query_params(kwargs.pop("path"), order_id), params={**kwargs}
@@ -225,29 +142,19 @@ class OrdersV0(AsyncBaseClient):
     @sp_endpoint("/orders/v0/orders/{}/orderItems/buyerInfo")
     async def get_order_items_buyer_info(self, order_id: str, **kwargs) -> ApiResponse:
         """
-        get_order_items_buyer_info(self, order_id: str, **kwargs) -> ApiResponse
-
-        Returns buyer information in the order items of the order indicated by the specified order ID.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       1
-        ======================================  ==============
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        get_order_items_buyer_info(self, order_id, **kwargs) -> ApiResponse
+        
+        Returns buyer information for the order items in the order that you specify.
+        
         Examples:
             literal blocks::
-
-                Orders().get_order_items_buyer_info('TEST_CASE_200')
-
+            
+                await OrdersV0().get_order_items_buyer_info("value")
+        
         Args:
-            order_id: str
-            key NextToken: str | retrieve data by next token
-
+            order_id:  | required
+            **kwargs:
+        
         Returns:
             ApiResponse
         """
@@ -258,24 +165,29 @@ class OrdersV0(AsyncBaseClient):
     @sp_endpoint("/orders/v0/orders/{}/shipment", method="POST")
     async def update_shipment_status(self, order_id: str, **kwargs) -> ApiResponse:
         """
-        update_shipment_status(self, order_id: str, **kwargs) -> ApiResponse
-        Update the shipment status.
+        update_shipment_status(self, order_id, **kwargs) -> ApiResponse
+        
+        Update the shipment status for an order that you specify.
+        
         **Usage Plan:**
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         5                                       15
         ======================================  ==============
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
         Examples:
             literal blocks::
-                Orders().update_shipment_status(
-                    order_id='123-1234567-1234567',
-                    marketplaceId='ATVPDKIKX0DER',
-                    shipmentStatus='ReadyForPickup'
-                )
+            
+                await OrdersV0().update_shipment_status("value")
+        
         Args:
-            order_id: str
+            orderId: object | required An Amazon-defined order identifier, in 3-7-7 format.
+            payload: UpdateShipmentStatusRequest | required The request body for the `updateShipmentStatus` operation.
+        
         Returns:
             ApiResponse
         """
@@ -288,40 +200,29 @@ class OrdersV0(AsyncBaseClient):
     @sp_endpoint("/orders/v0/orders/{}/shipmentConfirmation", method="POST")
     async def confirm_shipment(self, order_id: str, **kwargs) -> ApiResponse:
         """
-        confirm_shipment(self, order_id: str, **kwargs) -> ApiResponse
+        confirm_shipment(self, order_id, **kwargs) -> ApiResponse
+        
         Updates the shipment confirmation status for a specified order.
+        
         **Usage Plan:**
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         2                                       10
         ======================================  ==============
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
         Examples:
             literal blocks::
-                Orders().confirm_shipment(
-                    order_id='123-1234567-1234567',
-                    marketplaceId='ATVPDKIKX0DER',
-                    packageDetail={
-                        'packageReferenceId': '0001',
-                        'carrierCode': 'DHL',
-                        "shippingMethod": 'Paket',
-                        'trackingNumber': '1234567890',
-                        'shipDate': '2023-03-19T12:00:00Z',
-                        'orderItems': [
-                            {
-                                'orderItemId': '123456789',
-                                'quantity': 1
-                            },
-                            {
-                                'orderItemId': '2345678901',
-                                'quantity': 2
-                            },
-                        ]
-                    }
-                )
+            
+                await OrdersV0().confirm_shipment("value")
+        
         Args:
-            order_id: str
+            orderId: object | required An Amazon-defined order identifier, in 3-7-7 format.
+            payload: ConfirmShipmentRequest | required Request body of `confirmShipment`.
+        
         Returns:
             ApiResponse
         """
@@ -359,3 +260,70 @@ class OrdersV0(AsyncBaseClient):
             self.restricted_data_token = None
         return r
 
+
+
+
+
+
+
+
+    @sp_endpoint("/orders/v0/orders/{}/regulatedInfo", method="GET")
+    async def get_order_regulated_info(self, orderId, **kwargs) -> ApiResponse:
+        """
+        get_order_regulated_info(self, orderId, **kwargs) -> ApiResponse
+        
+        Returns regulated information for the order that you specify.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.5                                     30
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                await OrdersV0().get_order_regulated_info("value")
+        
+        Args:
+            orderId: object | required The Amazon order identifier in 3-7-7 format.
+        
+        Returns:
+            ApiResponse
+        """
+        return await self._request(fill_query_params(kwargs.pop("path"), orderId), params=kwargs)
+
+    @sp_endpoint("/orders/v0/orders/{}/regulatedInfo", method="PATCH")
+    async def update_verification_status(self, orderId, **kwargs) -> ApiResponse:
+        """
+        update_verification_status(self, orderId, **kwargs) -> ApiResponse
+        
+        Updates (approves or rejects) the verification status of an order containing regulated products.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.5                                     30
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                await OrdersV0().update_verification_status("value")
+        
+        Args:
+            orderId: object | required The Amazon order identifier in 3-7-7 format.
+            payload: UpdateVerificationStatusRequest | required The request body for the `updateVerificationStatus` operation.
+        
+        Returns:
+            ApiResponse
+        """
+        return await self._request(fill_query_params(kwargs.pop("path"), orderId), data=kwargs)

sp_api/asyncio/api/product_fees/product_fees.py

@@ -27,37 +27,39 @@ class ProductFees(AsyncBaseClient):
         **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
-
+        get_product_fees_estimate_for_sku(self, seller_sku, price, shipping_price, currency, is_fba, points, marketplace_id, optional_fulfillment_program, force_safe_sku, **kwargs) -> ApiResponse
+        
+        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](https://developer-docs.amazon.com/sp-api/docs/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](https://sellercentral.amazon.com/) 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.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       2
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
         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
-                                                              }
-                                                          })
-
+            
+                await ProductFees().get_product_fees_estimate_for_sku("value", "value", "value", "value", "value", "value", "value", "value", "value")
+        
         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:
-
+            body: GetMyFeesEstimateRequest | required The request body schema for the getMyFeesEstimates operation
+            SellerSKU: object | required 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.
+        
         Returns:
-            ApiResponse:
-
+            ApiResponse
         """
 
         if force_safe_sku:
@@ -94,36 +96,37 @@ class ProductFees(AsyncBaseClient):
         **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
-
+        get_product_fees_estimate_for_asin(self, asin, price, currency, shipping_price, is_fba, points, marketplace_id, optional_fulfillment_program, **kwargs) -> ApiResponse
+        
+        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](https://sellercentral.amazon.com/) 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.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       2
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
         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
-                                                               }
-                                                           })
-
+            
+                await ProductFees().get_product_fees_estimate_for_asin("value", "value", "value", "value", "value", "value", "value", "value")
+        
         Args:
-            asin:
-            price:
-            currency:
-            shipping_price:
-            is_fba:
-            points:
-            marketplace_id: str | Defaults to self.marketplace_id
-            optional_fulfillment_program:
-            **kwargs:
-
+            body: GetMyFeesEstimateRequest | required The request body schema for the getMyFeesEstimates operation
+            Asin: object | required The Amazon Standard Identification Number (ASIN) of the item.
+        
         Returns:
-            ApiResponse:
-
+            ApiResponse
         """
         kwargs.update(
             create_fees_body(
@@ -139,34 +142,56 @@ class ProductFees(AsyncBaseClient):
         )
         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:
+    @sp_endpoint("/products/fees/v0/feesEstimate", method="POST")
+    async def get_my_fees_estimates(
+        self, estimate_requests: List[dict], **kwargs
+    ) -> ApiResponse:
         """
-        get_product_fees_estimate(self, estimate_requests: List[dict]) -> ApiResponse
+        get_my_fees_estimates(self, estimate_requests, **kwargs) -> ApiResponse
+        
+        Returns the estimated fees for a list of products.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.5                                     1
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                await ProductFees().get_my_fees_estimates("value")
+        
+        Args:
+            body: GetMyFeesEstimatesRequest | required The request body schema for the getMyFeesEstimates operation
+        
+        Returns:
+            ApiResponse
+        """
+        kwargs.pop("path", None)
+        kwargs.pop("method", None)
+        return await self.get_product_fees_estimate(estimate_requests)
 
+    async def get_product_fees_estimate(self, estimate_requests: List[dict]) -> ApiResponse:
+        """
+        get_product_fees_estimate(self, estimate_requests) -> 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),
-                        ]
-                    )
-
-
+            
+                await ProductFees().get_product_fees_estimate("value")
+        
         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:
+            estimate_requests:  | required
+        
+        Returns:
+            ApiResponse
         """
         data = []
         for estimate in estimate_requests:
@@ -184,6 +209,7 @@ class ProductFees(AsyncBaseClient):
             "/products/fees/v0/feesEstimate",
             data=data,
             params=dict(method="POST"),
+            add_marketplace=False,
             wrap_list=True,
         )