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

sp_api/asyncio/api/services/services.py

@@ -0,0 +1,218 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class Services(AsyncBaseClient):
+    """
+    Services SP-API Client
+    :link:
+
+    With the Services API, you can build applications that help service providers get and modify their service orders.
+    """
+
+    @sp_endpoint("/service/v1/serviceJobs/{}", method="GET")
+    async def get_service_job_by_service_job_id(self, serviceJobId, **kwargs) -> ApiResponse:
+        """
+        get_service_job_by_service_job_id(self, serviceJobId, **kwargs) -> ApiResponse
+
+        Gets service job details for the service job indicated by the service job identifier you specify.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        20                                      40
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            serviceJobId:string | * REQUIRED A service job identifier.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), serviceJobId), params=kwargs
+        )
+
+    @sp_endpoint("/service/v1/serviceJobs/{}/cancellations", method="PUT")
+    async def cancel_service_job_by_service_job_id(
+        self, serviceJobId, **kwargs
+    ) -> ApiResponse:
+        """
+        cancel_service_job_by_service_job_id(self, serviceJobId, **kwargs) -> ApiResponse
+
+        Cancels the service job indicated by the service job identifier you specify.
+
+        **Usage Plan:**
+
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       20
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            serviceJobId:string | * REQUIRED An Amazon defined service job identifier.
+            key cancellationReasonCode:string | * REQUIRED A cancel reason code that specifies the reason for cancelling a service job.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), serviceJobId), data=kwargs
+        )
+
+    @sp_endpoint("/service/v1/serviceJobs/{}/completions", method="PUT")
+    async def complete_service_job_by_service_job_id(
+        self, serviceJobId, **kwargs
+    ) -> ApiResponse:
+        """
+        complete_service_job_by_service_job_id(self, serviceJobId, **kwargs) -> ApiResponse
+
+        Completes the service job indicated by the service job identifier you specify.
+
+        **Usage Plan:**
+
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       20
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            serviceJobId:string | * REQUIRED An Amazon defined service job identifier.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), serviceJobId), data=kwargs
+        )
+
+    @sp_endpoint("/service/v1/serviceJobs", method="GET")
+    async def get_service_jobs(self, **kwargs) -> ApiResponse:
+        """
+        get_service_jobs(self, **kwargs) -> ApiResponse
+
+        Gets service job details for the specified filter query.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      40
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            key serviceOrderIds: array |  List of service order ids for the query you want to perform.Max values supported 20.
+            key serviceJobStatus: array |  A list of one or more job status by which to filter the list of jobs.
+            key pageToken: string |  String returned in the response of your previous request.
+            key pageSize: integer |  A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.
+            key sortField: string |  Sort fields on which you want to sort the output.
+            key sortOrder: string |  Sort order for the query you want to perform.
+            key createdAfter: string |  A date used for selecting jobs created after (or at) a specified time must be in ISO 8601 format. Required if LastUpdatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.
+            key createdBefore: string |  A date used for selecting jobs created before (or at) a specified time must be in ISO 8601 format.
+            key lastUpdatedAfter: string |  A date used for selecting jobs updated after (or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.
+            key lastUpdatedBefore: string |  A date used for selecting jobs updated before (or at) a specified time must be in ISO 8601 format.
+            key scheduleStartDate: string |  A date used for filtering jobs schedule after (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.
+            key scheduleEndDate: string |  A date used for filtering jobs schedule before (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.
+            key marketplaceIds: array | * REQUIRED Used to select jobs that were placed in the specified marketplaces.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/service/v1/serviceJobs/{}/appointments", method="POST")
+    async def add_appointment_for_service_job_by_service_job_id(
+        self, serviceJobId, **kwargs
+    ) -> ApiResponse:
+        """
+        add_appointment_for_service_job_by_service_job_id(self, serviceJobId, **kwargs) -> ApiResponse
+
+        Adds an appointment to the service job indicated by the service job identifier you specify.
+
+        **Usage Plan:**
+
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       20
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            serviceJobId:string | * REQUIRED An Amazon defined service job identifier.
+            body: {
+              "appointmentTime": {
+                "startTime": "2019-08-24T14:15:22Z",
+                "durationInMinutes": 0
+              }
+            }
+
+         Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), serviceJobId), data=kwargs
+        )
+
+    @sp_endpoint("/service/v1/serviceJobs/{}", method="POST")
+    async def reschedule_appointment_for_service_job_by_service_job_id(
+        self, serviceJobId, **kwargs
+    ) -> ApiResponse:
+        """
+        reschedule_appointment_for_service_job_by_service_job_id(self, serviceJobId, **kwargs) -> ApiResponse
+
+        Reschedules an appointment for the service job indicated by the service job identifier you specify.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       20
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            serviceJobId:string | * REQUIRED An Amazon defined service job identifier.
+            appointmentId:string | * REQUIRED An existing appointment identifier for the Service Job.
+            kwargs: Example | >>>
+                {
+                    "appointmentTime": {
+                        "startTime": "2019-08-24T14:15:22Z",
+                        "durationInMinutes": 0
+                    },
+                    "rescheduleReasonCode": "string"
+                }
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), serviceJobId), data=kwargs
+        )

sp_api/asyncio/api/shipping/shipping.py

@@ -0,0 +1,459 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class Shipping(AsyncBaseClient):
+    """
+    Shipping SP-API Client
+    :link:
+
+    Provides programmatic access to Amazon Shipping APIs.
+    """
+
+    @sp_endpoint("/shipping/v1/shipments", method="POST")
+    async def create_shipment(self, **kwargs) -> ApiResponse:
+        """
+        create_shipment(self, **kwargs) -> ApiResponse
+
+        Create a new shipment.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       15
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            body: {
+              "clientReferenceId": "string",
+              "shipTo": {
+                "name": "string",
+                "addressLine1": "string",
+                "addressLine2": "string",
+                "addressLine3": "string",
+                "stateOrRegion": "string",
+                "city": "string",
+                "countryCode": "st",
+                "postalCode": "string",
+                "email": "string",
+                "copyEmails": [
+                  "string"
+                ],
+                "phoneNumber": "string"
+              },
+              "shipFrom": {
+                "name": "string",
+                "addressLine1": "string",
+                "addressLine2": "string",
+                "addressLine3": "string",
+                "stateOrRegion": "string",
+                "city": "string",
+                "countryCode": "st",
+                "postalCode": "string",
+                "email": "string",
+                "copyEmails": [
+                  "string"
+                ],
+                "phoneNumber": "string"
+              },
+              "containers": [
+                {
+                  "containerType": "PACKAGE",
+                  "containerReferenceId": "string",
+                  "value": {
+                    "value": 0,
+                    "unit": "str"
+                  },
+                  "dimensions": {
+                    "length": 0,
+                    "width": 0,
+                    "height": 0,
+                    "unit": "IN"
+                  },
+                  "items": [
+                    {
+                      "quantity": 0,
+                      "unitPrice": {
+                        "value": 0,
+                        "unit": "str"
+                      },
+                      "unitWeight": {
+                        "unit": "g",
+                        "value": 0
+                      },
+                      "title": "string"
+                    }
+                  ],
+                  "weight": {
+                    "unit": "g",
+                    "value": 0
+                  }
+                }
+              ]
+            }
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), data=kwargs)
+
+    @sp_endpoint("/shipping/v1/shipments/{}", method="GET")
+    async def get_shipment(self, shipmentId, **kwargs) -> ApiResponse:
+        """
+        get_shipment(self, shipmentId, **kwargs) -> ApiResponse
+
+        Return the entire shipment object for the shipmentId.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       15
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            shipmentId:string | * REQUIRED
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), shipmentId), params=kwargs
+        )
+
+    @sp_endpoint("/shipping/v1/shipments/{}/cancel", method="POST")
+    async def cancel_shipment(self, shipmentId, **kwargs) -> ApiResponse:
+        """
+        cancel_shipment(self, shipmentId, **kwargs) -> ApiResponse
+
+        Cancel a shipment by the given shipmentId.
+
+        **Usage Plan:**
+
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       15
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            shipmentId:string | * REQUIRED
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), shipmentId), data=kwargs
+        )
+
+    @sp_endpoint("/shipping/v1/shipments/{}/purchaseLabels", method="POST")
+    async def purchase_labels(self, shipmentId, **kwargs) -> ApiResponse:
+        """
+        purchase_labels(self, shipmentId, **kwargs) -> ApiResponse
+
+        Purchase shipping labels based on a given rate.
+
+        **Usage Plan:**
+
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       15
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            shipmentId:string | * REQUIRED
+            body: {
+              "rateId": "string",
+              "labelSpecification": {
+                "labelFormat": "PNG",
+                "labelStockSize": "4x6"
+              }
+            }
+
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), shipmentId), data=kwargs
+        )
+
+    @sp_endpoint("/shipping/v1/shipments/{}/label", method="POST")
+    async def retrieve_shipping_label(self, shipmentId, **kwargs) -> ApiResponse:
+        """
+        retrieve_shipping_label(self, shipmentId, **kwargs) -> ApiResponse
+
+        Retrieve shipping label based on the shipment id and tracking id.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       15
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            shipmentId:string | * REQUIRED
+            trackingId:string | * REQUIRED
+            body: {
+              "labelSpecification": {
+                "labelFormat": "PNG",
+                "labelStockSize": "4x6"
+              }
+            }
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), shipmentId), data=kwargs
+        )
+
+    @sp_endpoint("/shipping/v1/purchaseShipment", method="POST")
+    async def purchase_shipment(self, **kwargs) -> ApiResponse:
+        """
+        purchase_shipment(self, **kwargs) -> ApiResponse
+
+        Purchase shipping labels.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       15
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            body: {
+              "clientReferenceId": "string",
+              "shipTo": {
+                "name": "string",
+                "addressLine1": "string",
+                "addressLine2": "string",
+                "addressLine3": "string",
+                "stateOrRegion": "string",
+                "city": "string",
+                "countryCode": "st",
+                "postalCode": "string",
+                "email": "string",
+                "copyEmails": [
+                  "string"
+                ],
+                "phoneNumber": "string"
+              },
+              "shipFrom": {
+                "name": "string",
+                "addressLine1": "string",
+                "addressLine2": "string",
+                "addressLine3": "string",
+                "stateOrRegion": "string",
+                "city": "string",
+                "countryCode": "st",
+                "postalCode": "string",
+                "email": "string",
+                "copyEmails": [
+                  "string"
+                ],
+                "phoneNumber": "string"
+              },
+              "shipDate": "2019-08-24T14:15:22Z",
+              "serviceType": "Amazon Shipping Ground",
+              "containers": [
+                {
+                  "containerType": "PACKAGE",
+                  "containerReferenceId": "string",
+                  "value": {
+                    "value": 0,
+                    "unit": "str"
+                  },
+                  "dimensions": {
+                    "length": 0,
+                    "width": 0,
+                    "height": 0,
+                    "unit": "IN"
+                  },
+                  "items": [
+                    {
+                      "quantity": 0,
+                      "unitPrice": {
+                        "value": 0,
+                        "unit": "str"
+                      },
+                      "unitWeight": {
+                        "unit": "g",
+                        "value": 0
+                      },
+                      "title": "string"
+                    }
+                  ],
+                  "weight": {
+                    "unit": "g",
+                    "value": 0
+                  }
+                }
+              ],
+              "labelSpecification": {
+                "labelFormat": "PNG",
+                "labelStockSize": "4x6"
+              }
+            }
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), data=kwargs)
+
+    @sp_endpoint("/shipping/v1/rates", method="POST")
+    async def get_rates(self, **kwargs) -> ApiResponse:
+        """
+        get_rates(self, **kwargs) -> ApiResponse
+
+        Get service rates.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       15
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            body:{
+              "shipTo": {
+                "name": "string",
+                "addressLine1": "string",
+                "addressLine2": "string",
+                "addressLine3": "string",
+                "stateOrRegion": "string",
+                "city": "string",
+                "countryCode": "st",
+                "postalCode": "string",
+                "email": "string",
+                "copyEmails": [
+                  "string"
+                ],
+                "phoneNumber": "string"
+              },
+              "shipFrom": {
+                "name": "string",
+                "addressLine1": "string",
+                "addressLine2": "string",
+                "addressLine3": "string",
+                "stateOrRegion": "string",
+                "city": "string",
+                "countryCode": "st",
+                "postalCode": "string",
+                "email": "string",
+                "copyEmails": [
+                  "string"
+                ],
+                "phoneNumber": "string"
+              },
+              "serviceTypes": [
+                "Amazon Shipping Ground"
+              ],
+              "shipDate": "2019-08-24T14:15:22Z",
+              "containerSpecifications": [
+                {
+                  "dimensions": {
+                    "length": 0,
+                    "width": 0,
+                    "height": 0,
+                    "unit": "IN"
+                  },
+                  "weight": {
+                    "unit": "g",
+                    "value": 0
+                  }
+                }
+              ]
+            }
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), data=kwargs)
+
+    @sp_endpoint("/shipping/v1/account", method="GET")
+    async def get_account(self, **kwargs) -> ApiResponse:
+        """
+        get_account(self, **kwargs) -> ApiResponse
+
+        Verify if the current account is valid.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       15
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/shipping/v1/tracking/{}", method="GET")
+    async def get_tracking_information(self, trackingId, **kwargs) -> ApiResponse:
+        """
+        get_tracking_information(self, trackingId, **kwargs) -> ApiResponse
+
+        Return the tracking information of a shipment.
+
+        **Usage Plan:**
+
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       1
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            trackingId:string | * REQUIRED
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), trackingId), params=kwargs
+        )