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

sp_api/api/shipping/shippingV2.py

@@ -1,7 +1,7 @@
 import enum
 import os
 import urllib.parse
-from datetime import datetime
+from datetime import datetime, timezone
 
 from sp_api.base import (
     Client,
@@ -60,7 +60,7 @@ class Shipping(Client):
             "host": self.endpoint[8:],
             "user-agent": self.user_agent,
             "x-amz-access-token": self.restricted_data_token or self.auth.access_token,
-            "x-amz-date": datetime.utcnow().strftime("%Y%m%dT%H%M%SZ"),
+            "x-amz-date": datetime.now(timezone.utc).strftime("%Y%m%dT%H%M%SZ"),
             "content-type": "application/json",
             "x-amzn-shipping-business-id": self.amzn_shipping_business.value,
         }
@@ -69,179 +69,30 @@ class Shipping(Client):
     def get_rates(self, **kwargs) -> ApiResponse:
         """
         get_rates(self, **kwargs) -> ApiResponse
-
+        
         Returns the available shipping service offerings.
-
+        
         **Usage Plan:**
-
-        ======================================
-        Rate (requests per second)
-        ======================================
-        5
-        ======================================
-
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        80                                      100
+        ======================================  ==============
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Shipping().get_rates()
+        
         Args:
-            body: {
-                "shipTo": {
-                    "name": "string",
-                    "addressLine1": "string",
-                    "addressLine2": "string",
-                    "addressLine3": "string",
-                    "companyName": "string",
-                    "stateOrRegion": "string",
-                    "city": "string",
-                    "countryCode": "st",
-                    "postalCode": "string",
-                    "email": "string",
-                    "phoneNumber": "string",
-                    "geocode": {
-                        "latitude": "string",
-                        "longitude": "string"
-                    }
-                },
-                "shipFrom": {
-                    "name": "string",
-                    "addressLine1": "string",
-                    "addressLine2": "string",
-                    "addressLine3": "string",
-                    "companyName": "string",
-                    "stateOrRegion": "string",
-                    "city": "string",
-                    "countryCode": "st",
-                    "postalCode": "string",
-                    "email": "string",
-                    "phoneNumber": "string",
-                    "geocode": {
-                        "latitude": "string",
-                        "longitude": "string"
-                    }
-                },
-                "returnTo": {
-                    "name": "string",
-                    "addressLine1": "string",
-                    "addressLine2": "string",
-                    "addressLine3": "string",
-                    "companyName": "string",
-                    "stateOrRegion": "string",
-                    "city": "string",
-                    "countryCode": "st",
-                    "postalCode": "string",
-                    "email": "string",
-                    "phoneNumber": "string",
-                    "geocode": {
-                        "latitude": "string",
-                        "longitude": "string"
-                    }
-                },
-                "shipDate": "2019-08-24T14:15:22Z",
-                "shipperInstruction": {
-                    "deliveryNotes": "string"
-                },
-                "packages": [
-                    {
-                        "dimensions": {
-                            "length": 0,
-                            "width": 0,
-                            "height": 0,
-                            "unit": "CENTIMETER"
-                        },
-                        "weight": {
-                            "unit": "KILOGRAM",
-                            "value": 0
-                        },
-                        "insuredValue":{
-                            "value": 0.00,
-                            "unit": "EUR",
-                        },
-                        "isHazmat": False,
-                        "sellerDisplayName": "string",
-                        "charges": [
-                            {
-                                "amount": {
-                                    "value": 0.00,
-                                    "unit": "EUR",
-                                },
-                                "chargeType": "TAX"
-                            }
-                        ],
-                        "packageClientReferenceId": "string",
-                        "items": [
-                            {
-                                "itemValue": {
-                                    "value": 0.00,
-                                    "unit": "EUR",
-                                },
-                                "description": "string",
-                                "itemIdentifier": "string",
-                                "quantity": 1,
-                                "weight": {
-                                    "value": 0.00,
-                                    "unit": "KILOGRAM",
-                                },
-                                "liquidVolume": {
-                                    "value": 0.00,
-                                    "unit": "ML",
-                                },
-                                "isHazmat": False,
-                                "dangerousGoodsDetails": {
-                                    "unitedNationsRegulatoryId": "string",
-                                    "transportationRegulatoryClass": "string",
-                                    "packingGroup": "III",
-                                    "packingInstruction": "PI965_SECTION_IA",
-                                },
-                                "productType": "string",
-                                "invoiceDetails": {
-                                    "invoiceNumber": "string",
-                                    "invoiceDate": "2019-08-24T14:15:22Z"
-                                },
-                                "serialNumbers": ["string"],
-                                "directFulfillmentItemIdentifiers": {
-                                    "lineItemID": "string",
-                                    "pieceNumber": "string"
-                                }
-                            }
-                        ]
-                    }
-                ],
-                "valueAddedServicesDetails": {
-                    "collectOnDelivery": {
-                        "amount": {
-                            "value": 0.00,
-                            "unit": "EUR",
-                        }
-                    }
-                },
-                "taxDetails": [
-                    {
-                        "taxType": "GST",
-                        "taxRegistrationNumber": "string"
-                    }
-                ],
-                "channelDetails": {
-                    "channelType": "EXTERNAL",
-                    "amazonOrderDetails": {
-                        "orderId": "string"
-                    },
-                    "amazonShipmentDetails": {
-                        "shipmentId": "string"
-                    }
-                },
-                "clientReferenceDetails": [
-                    {
-                        "clientReferenceType": "IntegratorShipperId",
-                        "clientReferenceId": "string"
-                    }
-                ],
-                "shipmentType": "FORWARD",
-                "destinationAccessPointDetails": {
-                    "accessPointId": "string",
-                }
-            }
-
+            body: GetRatesRequest | required GetRatesRequest body
+            x-amzn-shipping-business-id: object |  Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
@@ -250,47 +101,33 @@ class Shipping(Client):
     def purchase_shipment(self, **kwargs) -> ApiResponse:
         """
         purchase_shipment(self, **kwargs) -> ApiResponse
-
+        
         Purchases a shipping service and returns purchase related details and documents.
-
-        Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider for channelType as EXTERNAL which is for OFF-Amazon volume. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to "TOKEN_EXPIRED". If you receive this error response, you must get the rates for the shipment again.
-
+        
+        Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to "TOKEN_EXPIRED". If you receive this error response, you must get the rates for the shipment again.
+        
         **Usage Plan:**
-
-        ======================================
-        Rate (requests per second)
-        ======================================
-        5
-        ======================================
-
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        80                                      100
+        ======================================  ==============
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Shipping().purchase_shipment()
+        
         Args:
-            body: {
-                "requestToken": "string",
-                "rateId": "string",
-                "requestedDocumentSpecification": {
-                    "format": "ZPL",
-                    "size": {
-                        "width": 4,
-                        "length": 6,
-                        "unit": "INCH"
-                    },
-                    "dpi": 203,
-                    "pageLayout": "DEFAULT",
-                    "needFileJoining": False,
-                    "requestedDocumentTypes": ["LABEL"]
-                },
-                "requestedValueAddedServices": [
-                    {
-                        "id": "string"
-                    }
-                ],
-                "additionalInputs": {}
-            }
-
+            body: PurchaseShipmentRequest | required PurchaseShipmentRequest body
+            x-amzn-IdempotencyKey: object |  A unique value which the server uses to recognize subsequent retries of the same request.
+            x-amzn-shipping-business-id: object |  Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
         return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
 
@@ -298,187 +135,30 @@ class Shipping(Client):
     def one_click_shipment(self, **kwargs) -> ApiResponse:
         """
         one_click_shipment(self, **kwargs) -> ApiResponse
-
+        
         Purchases a shipping service identifier and returns purchase-related details and documents.
-
+        
         **Usage Plan:**
-
-        ======================================
-        Rate (requests per second)
-        ======================================
-        5
-        ======================================
-
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        80                                      100
+        ======================================  ==============
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Shipping().one_click_shipment()
+        
         Args:
-            body: {
-                "shipTo": {
-                    "name": "string",
-                    "addressLine1": "string",
-                    "addressLine2": "string",
-                    "addressLine3": "string",
-                    "companyName": "string",
-                    "stateOrRegion": "string",
-                    "city": "string",
-                    "countryCode": "st",
-                    "postalCode": "string",
-                    "email": "string",
-                    "phoneNumber": "string",
-                    "geocode": {
-                        "latitude": "string",
-                        "longitude": "string"
-                    }
-                },
-                "shipFrom": {
-                    "name": "string",
-                    "addressLine1": "string",
-                    "addressLine2": "string",
-                    "addressLine3": "string",
-                    "companyName": "string",
-                    "stateOrRegion": "string",
-                    "city": "string",
-                    "countryCode": "st",
-                    "postalCode": "string",
-                    "email": "string",
-                    "phoneNumber": "string",
-                    "geocode": {
-                        "latitude": "string",
-                        "longitude": "string"
-                    }
-                },
-                "returnTo": {
-                    "name": "string",
-                    "addressLine1": "string",
-                    "addressLine2": "string",
-                    "addressLine3": "string",
-                    "companyName": "string",
-                    "stateOrRegion": "string",
-                    "city": "string",
-                    "countryCode": "st",
-                    "postalCode": "string",
-                    "email": "string",
-                    "phoneNumber": "string",
-                    "geocode": {
-                        "latitude": "string",
-                        "longitude": "string"
-                    }
-                },
-                "shipDate": "2019-08-24T14:15:22Z",
-                "packages": [
-                    {
-                        "dimensions": {
-                            "length": 0,
-                            "width": 0,
-                            "height": 0,
-                            "unit": "CENTIMETER"
-                        },
-                        "weight": {
-                            "unit": "KILOGRAM",
-                            "value": 0
-                        },
-                        "insuredValue":{
-                            "value": 0.00,
-                            "unit": "EUR",
-                        },
-                        "isHazmat": False,
-                        "sellerDisplayName": "string",
-                        "charges": [
-                            {
-                                "amount": {
-                                    "value": 0.00,
-                                    "unit": "EUR",
-                                },
-                                "chargeType": "TAX"
-                            }
-                        ],
-                        "packageClientReferenceId": "string",
-                        "items": [
-                            {
-                                "itemValue": {
-                                    "value": 0.00,
-                                    "unit": "EUR",
-                                },
-                                "description": "string",
-                                "itemIdentifier": "string",
-                                "quantity": 1,
-                                "weight": {
-                                    "value": 0.00,
-                                    "unit": "KILOGRAM",
-                                },
-                                "liquidVolume": {
-                                    "value": 0.00,
-                                    "unit": "ML",
-                                },
-                                "isHazmat": False,
-                                "dangerousGoodsDetails": {
-                                    "unitedNationsRegulatoryId": "string",
-                                    "transportationRegulatoryClass": "string",
-                                    "packingGroup": "III",
-                                    "packingInstruction": "PI965_SECTION_IA",
-                                },
-                                "productType": "string",
-                                "invoiceDetails": {
-                                    "invoiceNumber": "string",
-                                    "invoiceDate": "2019-08-24T14:15:22Z"
-                                },
-                                "serialNumbers": ["string"],
-                                "directFulfillmentItemIdentifiers": {
-                                    "lineItemID": "string",
-                                    "pieceNumber": "string"
-                                }
-                            }
-                        ]
-                    }
-                ],
-                "valueAddedServicesDetails": [
-                    "id": "string",
-                    "amount": {
-                        "value": 0.00,
-                        "unit": "EUR",
-                    },
-                ],
-                "taxDetails": [
-                    {
-                        "taxType": "GST",
-                        "taxRegistrationNumber": "string"
-                    }
-                ],
-                "channelDetails": {
-                    "channelType": "EXTERNAL",
-                    "amazonOrderDetails": {
-                        "orderId": "string"
-                    },
-                    "amazonShipmentDetails": {
-                        "shipmentId": "string"
-                    }
-                },
-                "labelSpecifications": {
-                    "format": "ZPL",
-                    "size": {
-                        "width": 4,
-                        "length": 6,
-                        "unit": "INCH"
-                    },
-                    "dpi": 203,
-                    "pageLayout": "DEFAULT",
-                    "needFileJoining": False,
-                    "requestedDocumentTypes": ["LABEL"]
-                },
-                "serviceSelection": {
-                    "serviceId": ["prime-premium-uk-mfn", "std-uk-mfn", "econ-uk-mfn"]
-                },
-                "shipperInstruction": {
-                    "deliveryNotes": "string"
-                },
-                "destinationAccessPointDetails": {
-                    "accessPointId": "string"
-                }
-
-            }
-
+            body: OneClickShipmentRequest | required OneClickShipmentRequest body
+            x-amzn-shipping-business-id: object |  Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
         return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
 
@@ -486,25 +166,31 @@ class Shipping(Client):
     def get_tracking(self, **kwargs) -> ApiResponse:
         """
         get_tracking(self, **kwargs) -> ApiResponse
-
+        
         Returns tracking information for a purchased shipment.
-
+        
         **Usage Plan:**
-
-        ======================================
-        Rate (requests per second)
-        ======================================
-        5
-        ======================================
-
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        80                                      100
+        ======================================  ==============
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Shipping().get_tracking()
+        
         Args:
-            key trackingId:string | * REQUIRED  A carrier-generated tracking identifier originally returned by the purchaseShipment operation.
-            key carrierId:string | * REQUIRED  A carrier identifier originally returned by the getRates operation for the selected rate.
-
+            key trackingId: object | required A carrier-generated tracking identifier originally returned by the purchaseShipment operation.
+            key carrierId: object | required A carrier identifier originally returned by the getRates operation for the selected rate.
+            x-amzn-shipping-business-id: object |  Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
         return self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)
 
@@ -512,27 +198,33 @@ class Shipping(Client):
     def get_shipment_documents(self, shipmentId, **kwargs) -> ApiResponse:
         """
         get_shipment_documents(self, shipmentId, **kwargs) -> ApiResponse
-
+        
         Returns the shipping documents associated with a package in a shipment.
-
+        
         **Usage Plan:**
-
-        ======================================
-        Rate (requests per second)
-        ======================================
-        5
-        ======================================
-
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        80                                      100
+        ======================================  ==============
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Shipping().get_shipment_documents("value")
+        
         Args:
-            shipmentId:string | * REQUIRED The shipment identifier originally returned by the purchaseShipment operation.
-            key packageClientReferenceId:string | * REQUIRED The shipment identifier originally returned by the purchaseShipment operation.
-            key format:string | The file format of the document. Must be one of the supported formats returned by the getRates operation.
-            key dpi:number | The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.
-
+            shipmentId: object | required The shipment identifier originally returned by the purchaseShipment operation.
+            key packageClientReferenceId: object | required The package client reference identifier originally provided in the request body parameter for the getRates operation.
+            key format: object |  The file format of the document. Must be one of the supported formats returned by the getRates operation.
+            key dpi: object |  The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.
+            x-amzn-shipping-business-id: object |  Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
@@ -545,24 +237,30 @@ class Shipping(Client):
     def cancel_shipment(self, shipmentId, **kwargs) -> ApiResponse:
         """
         cancel_shipment(self, shipmentId, **kwargs) -> ApiResponse
-
+        
         Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled.
-
+        
         **Usage Plan:**
-
-        ======================================
-        Rate (requests per second)
-        ======================================
-        5
-        ======================================
-
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        80                                      100
+        ======================================  ==============
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Shipping().cancel_shipment("value")
+        
         Args:
-            shipmentId:string | * REQUIRED The shipment identifier originally returned by the purchaseShipment operation.
-
+            shipmentId: object | required The shipment identifier originally returned by the purchaseShipment operation.
+            x-amzn-shipping-business-id: object |  Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
         return self._request(
             fill_query_params(kwargs.pop("path"), shipmentId),
@@ -574,26 +272,32 @@ class Shipping(Client):
     def get_access_points(self, **kwargs) -> ApiResponse:
         """
         get_access_points(self, **kwargs) -> ApiResponse
-
+        
         Returns a list of access points in proximity of input postal code.
-
+        
         **Usage Plan:**
-
-        ======================================
-        Rate (requests per second)
-        ======================================
-        5
-        ======================================
-
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        80                                      100
+        ======================================  ==============
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Shipping().get_access_points()
+        
         Args:
-            key accessPointTypes:string | * REQUIRED
-            key countryCode:string | * REQUIRED
-            key postalCode:string | * REQUIRED
-
+            key accessPointTypes: object | required Access point types
+            key countryCode: object | required Country code for access point
+            key postalCode: object | required postal code for access point
+            x-amzn-shipping-business-id: object |  Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
         return self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)
 
@@ -601,31 +305,30 @@ class Shipping(Client):
     def submit_ndr_feedback(self, **kwargs) -> ApiResponse:
         """
         submit_ndr_feedback(self, **kwargs) -> ApiResponse
-
+        
         This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment.
-
+        
         **Usage Plan:**
-
-        ======================================
-        Rate (requests per second)
-        ======================================
-        5
-        ======================================
-
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        80                                      100
+        ======================================  ==============
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Shipping().submit_ndr_feedback()
+        
         Args:
-            body: {
-                "trackingId": "string",
-                "ndrAction": "RTO",
-                "ndrRequestData": {
-                    "rescheduleDate": "2024-12-12T05:24:00.00Z",
-                    "additionalAddressNotes": "string"
-                }
-            }
-
+            body: SubmitNdrFeedbackRequest | required Request body for ndrFeedback operation
+            x-amzn-shipping-business-id: object |  Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
         return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
 
@@ -633,24 +336,30 @@ class Shipping(Client):
     def get_additional_inputs(self, **kwargs) -> ApiResponse:
         """
         get_additional_inputs(self, **kwargs) -> ApiResponse
-
+        
         Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase.
-
+        
         **Usage Plan:**
-
-        ======================================
-        Rate (requests per second)
-        ======================================
-        5
-        ======================================
-
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        80                                      100
+        ======================================  ==============
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Shipping().get_additional_inputs()
+        
         Args:
-            key requestToken:string | * REQUIRED The request token returned in the response to the getRates operation.
-            key rateId:string | * REQUIRED The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.
-
+            key requestToken: object | required The request token returned in the response to the getRates operation.
+            key rateId: object | required The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.
+            x-amzn-shipping-business-id: object |  Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
         return self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)