python-amazon-sp-api 1.9.60__py3-none-any.whl → 2.0.3__py3-none-any.whl

sp_api/asyncio/api/inventories/inventories.py

@@ -0,0 +1,74 @@
+import urllib
+
+from sp_api.base import Client, Marketplaces, sp_endpoint, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+from sp_api.base.InventoryEnums import InventoryGranularity
+from sp_api.util import normalize_csv_param
+
+
+class Inventories(AsyncBaseClient):
+    """
+    :link: https://github.com/amzn/selling-partner-api-docs/blob/main/references/fba-inventory-api/fbaInventory.md#getinventorysummaries
+    """
+
+    @sp_endpoint("/fba/inventory/v1/summaries")
+    async def get_inventory_summary_marketplace(self, **kwargs) -> ApiResponse:
+        """
+        get_inventory_summary_marketplace(self, **kwargs) -> GetInventorySummariesResponse
+
+
+        Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime and sellerSkus parameters:
+
+        - All inventory summaries with available details are returned when the startDateTime and sellerSkus parameters are omitted.
+        - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus parameter is ignored.
+        - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        2                                       2
+        ======================================  ==============
+
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        All inventory summaries with available details are returned when the startDateTime and sellerSkus parameters are omitted.
+        When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus parameter is ignored.
+        When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus.
+        Usage Plan:
+
+        Examples:
+            literal blocks::
+
+                Inventories().get_inventory_summary_marketplace(**{
+                        "details": True,
+                        "marketplaceIds": ["ATVPDKIKX0DER"]
+                    })
+
+        Args:
+            key details: bool | true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).	boolean	"false"
+            key granularityType: Granularity Type | The granularity type for the inventory aggregation level.	enum (GranularityType)	-
+            key granularityId: str The granularity ID for the inventory aggregation level.	string	-
+            key startDateTime: datetime | A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.	string (date-time)	-
+            key sellerSkus: [str] | A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
+            key nextToken: str | String token returned in the response of your previous request.	string	-
+            key marketplaceIds: str | The marketplace ID for the marketplace for which to return inventory summaries.
+
+        Returns:
+            GetInventorySummariesResponse:
+
+        """
+
+        kwargs.update(
+            {
+                "granularityType": kwargs.get(
+                    "granularityType", InventoryGranularity.MARKETPLACE.value
+                ),
+                "granularityId": kwargs.get("granularityId", self.marketplace_id),
+            }
+        )
+        normalize_csv_param(kwargs, "sellerSkus")
+
+        return await self._request(kwargs.pop("path"), params=kwargs)

sp_api/asyncio/api/listings_items/listings_items.py

@@ -0,0 +1,170 @@
+from sp_api.base import (
+    Client,
+    sp_endpoint,
+    fill_query_params,
+    ApiResponse,
+    IncludedData,
+)
+from sp_api.util import normalize_included_data
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class ListingsItems(AsyncBaseClient):
+    """
+        ListingsItems SP-API Client
+        :link:
+
+        The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API.
+
+    For more information, see the [Listings Items API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/listings-items-api-use-case-guide/listings-items-api-use-case-guide_2021-08-01.md).
+    """
+
+    @sp_endpoint("/listings/2021-08-01/items/{}/{}", method="DELETE")
+    async def delete_listings_item(self, sellerId, sku, **kwargs) -> ApiResponse:
+        """
+        delete_listings_item(self, sellerId, sku, **kwargs) -> ApiResponse
+        Delete a listings item for a selling partner.
+        **Usage Plans:**
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       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:
+            sellerId:string | * REQUIRED A selling partner identifier, such as a merchant account or vendor code.
+            sku:string | * REQUIRED A selling partner provided identifier for an Amazon listing.
+            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.
+            key issueLocale:string |  A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), sellerId, sku), data=kwargs
+        )
+
+    @sp_endpoint("/listings/2021-08-01/items/{}/{}", method="GET")
+    async def get_listings_item(self, sellerId, sku, **kwargs) -> ApiResponse:
+        """
+        get_listings_item(self, sellerId, **kwargs) -> ApiResponse
+        Returns details about a listings item for a selling partner.
+        **Usage Plan:**
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       10
+        ======================================  ==============
+        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).
+        Args:
+            sellerId:string | * REQUIRED A selling partner identifier, such as a merchant account or vendor code
+            sku:string | * REQUIRED A selling partner provided identifier for an Amazon listing.
+            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.
+            key issueLocale:string |  A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.
+            key includedData:array |  A comma-delimited list of data sets to include in the response. Default: summaries.
+        Returns:
+            ApiResponse:
+        """
+        normalize_included_data(kwargs, enum_cls=IncludedData)
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), sellerId, sku), params=kwargs
+        )
+
+    @sp_endpoint("/listings/2021-08-01/items/{}", method="GET")
+    async def search_listings_items(self, sellerId, **kwargs) -> ApiResponse:
+        """
+        search_listings_items(self, sellerId, **kwargs) -> ApiResponse
+        Search for and return list of listings items and respective details for a selling partner.
+        **Usage Plan:**
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       5
+        ======================================  ==============
+        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md).
+        Args:
+            sellerId:string | * REQUIRED A selling partner identifier, such as a merchant account or vendor code
+            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.
+            key issueLocale:string |  A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.
+            key includedData:array |  A comma-delimited list of data sets to include in the response. Default: summaries.
+        Returns:
+            ApiResponse:
+        """
+        normalize_included_data(kwargs, enum_cls=IncludedData)
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), sellerId), params=kwargs
+        )
+
+    @sp_endpoint("/listings/2021-08-01/items/{}/{}", method="PATCH")
+    async def patch_listings_item(self, sellerId, sku, **kwargs) -> ApiResponse:
+        """
+        patch_listings_item(self, sellerId, sku, **kwargs) -> ApiResponse
+        Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported.
+        **Usage Plans:**
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       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:
+            sellerId:string | * REQUIRED A selling partner identifier, such as a merchant account or vendor code.
+            sku:string | * REQUIRED A selling partner provided identifier for an Amazon listing.
+            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.
+            key issueLocale:string |  A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.
+            body: {
+              "productType": "string",
+              "patches": [
+                {
+                  "op": "add",
+                  "path": "string",
+                  "value": [
+                    {}
+                  ]
+                }
+              ]
+            }
+
+         Returns:
+            ApiResponse:
+        """
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), sellerId, sku),
+            data=kwargs.pop("body"),
+            params=kwargs,
+        )
+
+    @sp_endpoint("/listings/2021-08-01/items/{}/{}", method="PUT")
+    async def put_listings_item(self, sellerId, sku, **kwargs) -> ApiResponse:
+        """
+        put_listings_item(self, sellerId, sku, **kwargs) -> ApiResponse
+        Creates a new or fully-updates an existing listings item for a selling partner.
+        **Usage Plans:**
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       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:
+            sellerId:string | * REQUIRED A selling partner identifier, such as a merchant account or vendor code.
+            sku:string | * REQUIRED A selling partner provided identifier for an Amazon listing.
+            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.
+            key issueLocale:string |  A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.
+            body: {
+              "productType": "string",
+              "requirements": "LISTING",
+              "attributes": {}
+            }
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), sellerId, sku),
+            data=kwargs.pop("body"),
+            params=kwargs,
+        )

sp_api/asyncio/api/listings_restrictions/listings_restrictions.py

@@ -0,0 +1,36 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class ListingsRestrictions(AsyncBaseClient):
+    """
+    ListingsRestrictions SP-API Client
+
+    The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog listings.
+
+    For more information, see the [Listings Restrictions API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/listings-restrictions-api-use-case-guide/listings-restrictions-api-use-case-guide_2021-08-01.md).
+    """
+
+    @sp_endpoint("/listings/2021-08-01/restrictions", method="GET")
+    async def get_listings_restrictions(self, **kwargs) -> ApiResponse:
+        """
+        get_listings_restrictions(self, **kwargs) -> ApiResponse
+
+        Returns listing restrictions for an item in the Amazon Catalog.
+
+        Args:
+
+            key asin:string | * REQUIRED The Amazon Standard Identification Number (ASIN) of the item.
+            key conditionType:string |  The condition used to filter restrictions.
+            key sellerId:string | * REQUIRED A selling partner identifier, such as a merchant account.
+            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.
+            key reasonLocale:string |  A locale for reason text localization. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.
+
+
+        Returns:
+            ApiResponse
+        """
+
+        return await self._request(kwargs.pop("path"), params=kwargs)