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

sp_api/asyncio/api/solicitations/solicitations.py

@@ -0,0 +1,78 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class Solicitations(AsyncBaseClient):
+    """
+    Solicitations SP-API Client
+    :link:
+
+    With the Solicitations API you can build applications that send non-critical solicitations to buyers. You can get a list of solicitation types that are available for an order that you specify, then call an operation that sends a solicitation to the buyer for that order. Buyers cannot respond to solicitations sent by this API, and these solicitations do not appear in the Messaging section of Seller Central or in the recipient's Message Center. The Solicitations API returns responses that are formed according to the <a href=https://tools.ietf.org/html/draft-kelly-json-hal-08>JSON Hypertext Application Language</a> (HAL) standard.
+    """
+
+    @sp_endpoint("/solicitations/v1/orders/{}", method="GET")
+    async def get_solicitation_actions_for_order(
+        self, amazonOrderId, **kwargs
+    ) -> ApiResponse:
+        """
+        get_solicitation_actions_for_order(self, amazonOrderId, **kwargs) -> ApiResponse
+
+        Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       5
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            amazonOrderId:string | * REQUIRED An Amazon order identifier. This specifies the order for which you want a list of available solicitation types.
+            key marketplaceIds:array | * REQUIRED A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), amazonOrderId), params=kwargs
+        )
+
+    @sp_endpoint(
+        "/solicitations/v1/orders/{}/solicitations/productReviewAndSellerFeedback",
+        method="POST",
+    )
+    async def create_product_review_and_seller_feedback_solicitation(
+        self, amazonOrderId, **kwargs
+    ) -> ApiResponse:
+        """
+        create_product_review_and_seller_feedback_solicitation(self, amazonOrderId, **kwargs) -> ApiResponse
+
+        Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       5
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            amazonOrderId:string | * REQUIRED An Amazon order identifier. This specifies the order for which a solicitation is sent.
+            key marketplaceIds:array | * REQUIRED A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), amazonOrderId), params=kwargs
+        )

sp_api/asyncio/api/supply_sources/supply_sources.py

@@ -0,0 +1,138 @@
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class SupplySources(AsyncBaseClient):
+    """
+    SupplySources SP-API Client
+    :link:
+
+    Manage configurations and capabilities of seller supply sources.
+    """
+
+    @sp_endpoint("/supplySources/2020-07-01/supplySources", method="GET")
+    async def get_supply_sources(self, **kwargs) -> ApiResponse:
+        """
+        get_supply_sources(self, **kwargs) -> ApiResponse
+
+        The path to retrieve paginated supply sources.
+
+        Args:
+
+            key nextPageToken:string |  The pagination token to retrieve a specific page of results.
+
+            key pageSize:number |  The number of supply sources to return per paginated request.
+
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/supplySources/2020-07-01/supplySources", method="POST")
+    async def create_supply_source(self, **kwargs) -> ApiResponse:
+        """
+               create_supply_source(self, **kwargs) -> ApiResponse
+
+               Create a new supply source.
+
+               Args:
+
+                   payload: | * REQUIRED {'description': 'A request to create a supply source.',
+        'properties': {'address': {'$ref': '#/definitions/Address'}, 'alias': {'$ref': '#/definitions/SupplySourceAlias'}, 'supplySourceCode': {'$ref': '#/definitions/SupplySourceCode'}},
+        'required': ['address', 'supplySourceCode', 'alias'],
+        'type': 'object'}
+
+
+               Returns:
+                   ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), data=kwargs)
+
+    @sp_endpoint("/supplySources/2020-07-01/supplySources/{}", method="GET")
+    async def get_supply_source(self, supplySourceId, **kwargs) -> ApiResponse:
+        """
+        get_supply_source(self, supplySourceId, **kwargs) -> ApiResponse
+
+        Retrieve a supply source.
+
+        Args:
+
+            supplySourceId:string | * REQUIRED The unique identifier of a supply source.
+
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), supplySourceId), params=kwargs
+        )
+
+    @sp_endpoint("/supplySources/2020-07-01/supplySources/{}", method="PUT")
+    async def update_supply_source(self, supplySourceId, **kwargs) -> ApiResponse:
+        """
+        update_supply_source(self, supplySourceId, **kwargs) -> ApiResponse
+
+        Update the configuration and capabilities of a supply source.
+
+        Args:
+
+            supplySourceId:string | * REQUIRED The unique identitier of a supply source.
+
+            payload: |  {'description': 'A request to update the configuration and capabilities of a supply source.',
+                         'properties': {'alias': {'$ref': '#/definitions/SupplySourceAlias'}, 'capabilities': {'$ref': '#/definitions/SupplySourceCapabilities'}, 'configuration': {'$ref': '#/definitions/SupplySourceConfiguration'}},
+                         'type': 'object'}
+
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), supplySourceId), data=kwargs
+        )
+
+    @sp_endpoint("/supplySources/2020-07-01/supplySources/{}", method="DELETE")
+    async def archive_supply_source(self, supplySourceId, **kwargs) -> ApiResponse:
+        """
+        archive_supply_source(self, supplySourceId, **kwargs) -> ApiResponse
+
+        Archive a supply source, making it inactive. Cannot be undone.
+
+        Args:
+
+            supplySourceId:string | * REQUIRED The unique identifier of a supply source.
+
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), supplySourceId), data=kwargs
+        )
+
+    @sp_endpoint("/supplySources/2020-07-01/supplySources/{}/status", method="PUT")
+    async def update_supply_source_status(self, supplySourceId, **kwargs) -> ApiResponse:
+        """
+        update_supply_source_status(self, supplySourceId, **kwargs) -> ApiResponse
+
+        Update the status of a supply source.
+
+        Args:
+
+            supplySourceId:string | * REQUIRED The unique identifier of a supply source.
+
+            payload: |  {'description': 'A request to update the status of a supply source.', 'properties': {'status': {'$ref': '#/definitions/SupplySourceStatus'}}, 'type': 'object'}
+
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), supplySourceId), data=kwargs
+        )

sp_api/asyncio/api/tokens/tokens.py

@@ -0,0 +1,65 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class Tokens(AsyncBaseClient):
+    """
+    Tokens SP-API Client
+    :link:
+
+    The Selling Partner API for Tokens provides a secure way to access a customers's PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes you to make subsequent requests to access these restricted resources.
+    """
+
+    @sp_endpoint("/tokens/2021-03-01/restrictedDataToken", method="POST")
+    async def create_restricted_data_token(self, **kwargs) -> ApiResponse:
+        """
+        create_restricted_data_token(self, **kwargs) -> ApiResponse
+
+        Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII). See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations.
+
+        The path of a restricted resource can be:
+        - A specific path containing a seller's order ID, for example ```/orders/v0/orders/902-3159896-1390916/address```. The returned RDT authorizes a subsequent call to the getOrderAddress operation of the Orders API for that specific order only. For example, ```GET /orders/v0/orders/902-3159896-1390916/address```.
+        - A generic path that does not contain a seller's order ID, for example```/orders/v0/orders/{orderId}/address```). The returned RDT authorizes subsequent calls to the getOrderAddress operation for *any* of a seller's order IDs. For example, ```GET /orders/v0/orders/902-3159896-1390916/address``` and ```GET /orders/v0/orders/483-3488972-0896720/address```
+
+        **Usage Plans:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       10
+        ======================================  ==============
+
+        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Examples:
+            literal blocks::
+
+                Tokens().create_restricted_data_token(restrictedResources=[
+                     {
+                         "method": "GET",
+                         "path": "/orders/v0/orders",
+                         "dataElements": ["buyerInfo", "shippingAddress"]
+                     }
+                  ])
+
+        Args:
+            body: {
+              "targetApplication": "string",
+              "restrictedResources": [
+                {
+                  "method": "GET",
+                  "path": "string",
+                  "dataElements": [
+                    "string"
+                  ]
+                }
+              ]
+            }
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), data=kwargs)

sp_api/asyncio/api/upload/upload.py

@@ -0,0 +1,18 @@
+from sp_api.base import Client, sp_endpoint
+from sp_api.asyncio.base import AsyncBaseClient
+from sp_api.base.helpers import create_md5
+import urllib.parse
+
+
+class Upload(AsyncBaseClient):
+    @sp_endpoint("/uploads/2020-11-01/uploadDestinations/{}", method="POST")
+    async def upload_document(self, resource, file, content_type="application/pdf", **kwargs):
+        md5 = urllib.parse.quote(create_md5(file))
+        kwargs.update(
+            {
+                "contentMD5": md5,
+                "contentType": kwargs.pop("contentType", content_type),
+                "marketplaceIds": self.marketplace_id,
+            }
+        )
+        return await self._request(kwargs.pop("path").format(resource), params=kwargs)

sp_api/asyncio/api/vendor_direct_fulfillment_inventory/vendor_direct_fulfillment_inventory.py

@@ -0,0 +1,64 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class VendorDirectFulfillmentInventory(AsyncBaseClient):
+    """
+    VendorDirectFulfillmentInventory SP-API Client
+    :link:
+
+    The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor's inventory updates.
+    """
+
+    @sp_endpoint(
+        "/vendor/directFulfillment/inventory/v1/warehouses/{}/items", method="POST"
+    )
+    async def submit_inventory_update(self, warehouseId, **kwargs) -> ApiResponse:
+        """
+        submit_inventory_update(self, warehouseId, **kwargs) -> ApiResponse
+
+        Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.
+
+        **Usage Plans:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+
+        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            warehouseId:string | * REQUIRED Identifier for the warehouse for which to update inventory.
+            body: {
+              "inventory": {
+                "sellingParty": {
+                  "partyId": "string"
+                },
+                "isFullUpdate": true,
+                "items": [
+                  {
+                    "buyerProductIdentifier": "string",
+                    "vendorProductIdentifier": "string",
+                    "availableQuantity": {
+                      "amount": 0,
+                      "unitOfMeasure": "string"
+                    },
+                    "isObsolete": true
+                  }
+                ]
+              }
+            }
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), warehouseId),
+            data=kwargs,
+            add_marketplace=False,
+        )

sp_api/asyncio/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders.py

@@ -0,0 +1,196 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class VendorDirectFulfillmentOrders(AsyncBaseClient):
+    """
+    VendorDirectFulfillmentOrders SP-API Client
+    :link:
+
+    The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor's order data.
+    """
+
+    @sp_endpoint("/vendor/directFulfillment/orders/v1/purchaseOrders", method="GET")
+    async def get_orders(self, **kwargs) -> ApiResponse:
+        """
+        get_orders(self, **kwargs) -> ApiResponse
+
+        Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order.
+
+        **Usage Plans:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+
+        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            key shipFromPartyId:string |  The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
+            key status:string |  Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
+            key limit:integer |  The limit to the number of purchase orders returned.
+            key createdAfter:string | * REQUIRED Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
+            key createdBefore:string | * REQUIRED Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
+            key sortOrder:string |  Sort the list in ascending or descending order by order creation date.
+            key nextToken:string |  Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
+            key includeDetails:string |  When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/vendor/directFulfillment/orders/v1/purchaseOrders/{}", method="GET")
+    async def get_order(self, purchaseOrderNumber, **kwargs) -> ApiResponse:
+        """
+        get_order(self, purchaseOrderNumber, **kwargs) -> ApiResponse
+
+        Returns purchase order information for the purchaseOrderNumber that you specify.
+
+        **Usage Plans:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                       10
+        ======================================  ==============
+
+        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            purchaseOrderNumber:string | * REQUIRED The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), purchaseOrderNumber), params=kwargs
+        )
+
+    @sp_endpoint("/vendor/directFulfillment/orders/v1/acknowledgements", method="POST")
+    async def submit_acknowledgement(self, **kwargs) -> ApiResponse:
+        """
+        submit_acknowledgement(self, **kwargs) -> ApiResponse
+
+        Submits acknowledgements for one or more purchase orders.
+
+        **Usage Plans:**
+
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+
+        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            body: {
+              "orderAcknowledgements": [
+                {
+                  "purchaseOrderNumber": "string",
+                  "vendorOrderNumber": "string",
+                  "acknowledgementDate": "2019-08-24T14:15:22Z",
+                  "acknowledgementStatus": {
+                    "code": "string",
+                    "description": "string"
+                  },
+                  "sellingParty": {
+                    "partyId": "string",
+                    "address": {
+                      "name": "string",
+                      "attention": "string",
+                      "addressLine1": "string",
+                      "addressLine2": "string",
+                      "addressLine3": "string",
+                      "city": "string",
+                      "county": "string",
+                      "district": "string",
+                      "stateOrRegion": "string",
+                      "postalCode": "string",
+                      "countryCode": "string",
+                      "phone": "string"
+                    },
+                    "taxInfo": {
+                      "taxRegistrationType": "VAT",
+                      "taxRegistrationNumber": "string",
+                      "taxRegistrationAddress": {
+                        "name": "string",
+                        "attention": "string",
+                        "addressLine1": "string",
+                        "addressLine2": "string",
+                        "addressLine3": "string",
+                        "city": "string",
+                        "county": "string",
+                        "district": "string",
+                        "stateOrRegion": "string",
+                        "postalCode": "string",
+                        "countryCode": "string",
+                        "phone": "string"
+                      },
+                      "taxRegistrationMessages": "string"
+                    }
+                  },
+                  "shipFromParty": {
+                    "partyId": "string",
+                    "address": {
+                      "name": "string",
+                      "attention": "string",
+                      "addressLine1": "string",
+                      "addressLine2": "string",
+                      "addressLine3": "string",
+                      "city": "string",
+                      "county": "string",
+                      "district": "string",
+                      "stateOrRegion": "string",
+                      "postalCode": "string",
+                      "countryCode": "string",
+                      "phone": "string"
+                    },
+                    "taxInfo": {
+                      "taxRegistrationType": "VAT",
+                      "taxRegistrationNumber": "string",
+                      "taxRegistrationAddress": {
+                        "name": "string",
+                        "attention": "string",
+                        "addressLine1": "string",
+                        "addressLine2": "string",
+                        "addressLine3": "string",
+                        "city": "string",
+                        "county": "string",
+                        "district": "string",
+                        "stateOrRegion": "string",
+                        "postalCode": "string",
+                        "countryCode": "string",
+                        "phone": "string"
+                      },
+                      "taxRegistrationMessages": "string"
+                    }
+                  },
+                  "itemAcknowledgements": [
+                    {
+                      "itemSequenceNumber": "string",
+                      "buyerProductIdentifier": "string",
+                      "vendorProductIdentifier": "string",
+                      "acknowledgedQuantity": {
+                        "amount": 0,
+                        "unitOfMeasure": "Each"
+                      }
+                    }
+                  ]
+                }
+              ]
+            }
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)