ozonapi-async 0.1.0__py3-none-any.whl

ozonapi/seller/methods/barcodes.py

@@ -0,0 +1,84 @@
+from ..core import APIManager
+from ..core.method_rate_limiter import method_rate_limit
+from ..schemas.barcodes import BarcodeGenerateRequest, BarcodeGenerateResponse
+from ..schemas.barcodes import BarcodeAddRequest, BarcodeAddResponse
+
+
+class SellerBarcodeAPI(APIManager):
+    """Реализует методы раздела Штрихкоды товаров.
+
+    References:
+        https://docs.ozon.ru/api/seller/#tag/BarcodeAPI
+    """
+
+    @method_rate_limit(limit_requests=20, interval_seconds=60)
+    async def barcode_add(
+        self: "SellerBarcodeAPI",
+        request: BarcodeAddRequest
+    ) -> BarcodeAddResponse:
+        """Если у товара есть штрихкод, который не указан в системе Ozon, привяжите его с помощью этого метода.
+        Если штрихкода нет, вы можете создать его через метод `barcode_generate()`.
+
+        Notes:
+            • За один запрос вы можете назначить штрихкод не больше чем на `100` товаров.
+            • На одном товаре может быть до `100` штрихкодов.
+            • С одного аккаунта продавца можно использовать метод не больше `20` раз в минуту.
+
+        References:
+            https://docs.ozon.ru/api/seller/#operation/add-barcode
+
+        Args:
+            request: Данные для добавления штрих-кодов по схеме `BarcodeAddRequest`
+
+        Returns:
+            Ответ с результатом добавления штрих-кодов по схеме `BarcodeAddResponse`
+
+        Example:
+            async with SellerAPI(client_id, api_key) as api:
+                barcodes = [BarcodeAddItem.model_validate({"barcode": "4321012345678", "sku": 0}), ]
+
+                result = await api.barcode_add(BarcodeAddRequest(barcodes=barcodes))
+        """
+        response = await self._request(
+            method="post",
+            api_version="v1",
+            endpoint="barcode/add",
+            json=request.model_dump(),
+        )
+        return BarcodeAddResponse(**response)
+
+    async def barcode_generate(
+        self: "SellerBarcodeAPI",
+        request: BarcodeGenerateRequest,
+    ) -> BarcodeGenerateResponse:
+        """Если у товара нет штрихкода, вы можете создать его с помощью этого метода.
+        Если штрихкод уже есть, но он не указан в системе Ozon, вы можете привязать его через метод `barcode_add()`.
+
+        Notes:
+            • За один запрос вы можете создать штрихкоды не больше чем для `100` товаров.
+            • С одного аккаунта продавца можно использовать метод не больше `20` раз в минуту.
+
+        References:
+            https://docs.ozon.ru/api/seller/#operation/generate-barcode
+
+        Args:
+            request: Массив с product_id для создания штрих-кодов по схеме `BarcodeGenerateRequest`
+
+        Returns:
+            Массив с описанием ошибок при создании штрихкодов по схеме `BarcodeGenerateResponse`
+
+        Example:
+            async with SellerAPI(client_id, api_key) as api:
+                result = await api.barcode_generate(
+                    BarcodeGenerateRequest(
+                        product_ids=[12345, 67890, ]
+                    )
+                )
+        """
+        response = await self._request(
+            method="post",
+            api_version="v1",
+            endpoint="barcode/generate",
+            json=request.model_dump(),
+        )
+        return BarcodeGenerateResponse(**response)

ozonapi/seller/methods/fbs.py

@@ -0,0 +1,69 @@
+from ..core import APIManager
+from ..schemas.fbs import PostingFBSUnfulfilledListRequest, PostingFBSUnfulfilledListResponse
+
+
+class SellerFBSAPI(APIManager):
+    """Реализует методы раздела Обработка заказов FBS и rFBS.
+
+    References:
+        https://docs.ozon.ru/api/seller/?__rr=1#tag/FBS
+    """
+
+    async def posting_fbs_unfulfilled_list(
+        self: "SellerFBSAPI",
+        request: PostingFBSUnfulfilledListRequest
+    ) -> PostingFBSUnfulfilledListResponse:
+        """Метод для получения списка необработанных отправлений за указанный период времени.
+
+        Notes:
+            • Период должен быть не больше одного года.
+            • Обязательно используйте фильтр либо по времени сборки — `cutoff`, либо по дате передачи отправления в доставку — `delivering_date`.
+            • Если использовать фильтры `cutoff` и `delivering_date` вместе, в ответе вернётся ошибка.
+            • Чтобы использовать фильтр по времени сборки, заполните поля `cutoff_from` и `cutoff_to`.
+            • Чтобы использовать фильтр по дате передачи отправления в доставку, заполните поля `delivering_date_from` и `delivering_date_to`.
+            • Для пагинации используйте `offset`.
+
+        References:
+            https://docs.ozon.ru/api/seller/#tag/FBS
+
+        Args:
+            request: Запрос на получение информации о необработанных отправлениях FBS и rFBS за указанный период времени по схеме `PostingFBSUnfulfilledListRequest`
+
+        Returns:
+            Список необработанных отправлений за указанный период времени по схеме `PostingFBSUnfulfilledListResponse`
+
+        Example:
+            async with SellerAPI(client_id, api_key) as api:
+                # noinspection PyArgumentList
+
+                result = await api.posting_fbs_unfulfilled_list(
+                    PostingFBSUnfulfilledListRequest(
+                        filter=PostingFBSUnfulfilledListFilter(
+                            cutoff_from=None,
+                            cutoff_to=None,
+                            delivering_date_from=datetime.datetime.now() - datetime.timedelta(days=30),
+                            delivering_date_to=datetime.datetime.now(),
+                            delivery_method_id=[],
+                            is_quantum=False,
+                            provider_id=[],
+                            status=None,
+                            warehouse_id=[],
+                            last_changed_status_date=None
+                        ),
+                        dir=SortingDirection.DESC,
+                        limit=10,
+                        offset=0,
+                        with_=PostingFBSUnfulfilledListFilterWith(
+                            barcodes=True,
+                            financial_data=True
+                        )
+                    )
+                )
+        """
+        response = await self._request(
+            method="post",
+            api_version="v3",
+            endpoint="posting/fbs/unfulfilled/list",
+            json=request.model_dump(by_alias=True)
+        )
+        return PostingFBSUnfulfilledListResponse(**response)

ozonapi/seller/methods/prices_and_stocks.py

@@ -0,0 +1,147 @@
+from ..core import APIManager
+
+from ..schemas.prices_and_stocks import (
+    ProductInfoPricesRequest,
+    ProductInfoPricesResponse,
+    ProductInfoStocksRequest,
+    ProductInfoStocksResponse,
+    ProductInfoStocksByWarehouseFBSRequest,
+    ProductInfoStocksByWarehouseFBSResponse,
+)
+
+
+class SellerPricesAndStocksAPI(APIManager):
+    """Реализует методы раздела Цены и остатки товаров.
+
+    References:
+        https://docs.ozon.ru/api/seller/#tag/PricesandStocksAPI
+    """
+
+    async def product_info_prices(
+        self: "SellerPricesAndStocksAPI",
+        request: ProductInfoPricesRequest = ProductInfoPricesRequest.model_construct(),
+    ) -> ProductInfoPricesResponse:
+        """Метод для получения информации о ценах и комиссиях товаров по их идентификаторам.
+
+        Notes:
+            • Можно вообще ничего не передавать - выберет всё по максимальному лимиту.
+            • Можно передавать до `1000` значений суммарно по `offer_id` и `product_id` или не передавать их вовсе, чтобы выбрать всё.
+            • Максимум `1000` товаров на страницу, если не заданы `offer_id` и `product_id`.
+            • Для пагинации используйте `cursor` из ответа, передав его в следующий запрос.
+
+        References:
+            https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoPrices
+
+        Args:
+            request: Содержит товарные идентификаторы для получения информации о ценах и комиссиях по схеме `ProductInfoPricesRequest`
+
+        Returns:
+            Ответ с информацией о ценах и комиссиях по схеме `ProductInfoPricesResponse`
+
+        Example:
+            Базовый запрос:
+                 async with SellerAPI(client_id, api_key) as api:
+                    result = await api.product_info_prices()
+
+            Запрос с настройками выборки:
+                 async with SellerAPI(client_id, api_key) as api:
+                    result = await api.product_info_prices(
+                        ProductInfoPricesRequest(
+                                cursor="",
+                                filter=ProductInfoPricesFilter(
+                                    offer_id=[],
+                                    product_id=[],
+                                    visibility = Visibility.VISIBLE,
+                                ),
+                                limit=100
+                        )
+                    )
+        """
+        response = await self._request(
+            method="post",
+            api_version="v5",
+            endpoint="product/info/prices",
+            json=request.model_dump(),
+        )
+        return ProductInfoPricesResponse(**response)
+
+    async def product_info_stocks(
+        self: "SellerPricesAndStocksAPI",
+        request: ProductInfoStocksRequest = ProductInfoStocksRequest.model_construct()
+    ) -> ProductInfoStocksResponse:
+        """Метод для получения информации о количестве общих складских остатков и зарезервированном количестве для схем FBS и rFBS по товарным идентификаторам.
+        Чтобы получить информацию об остатках по схеме FBO, используйте метод `analytics_stocks()`.
+
+        Notes:
+            • Можно использовать без параметров - выберет всё по максимальному лимиту.
+            • Можно передавать до `1000` значений суммарно по `offer_id` и `product_id` или не передавать их вовсе, чтобы выбрать всё.
+            • Максимум `1000` товаров на страницу, если не заданы `offer_id` и `product_id`.
+            • Для пагинации передайте полученный `cursor` в следующий запрос.
+
+        References:
+            https://docs.ozon.ru/api/seller/#operation/ProductAPI_GetProductInfoStocks
+
+        Args:
+            request: Данные для получения информации об общих остатках FBS и rFBS по схеме `ProductInfoStocksRequest`
+
+        Returns:
+            Ответ с информацией об общих остатках FBS и rFBS по схеме `ProductInfoStocksResponse`
+
+        Examples:
+            Базовый запрос:
+                async with SellerAPI(client_id, api_key) as api:
+                    result = await api.product_info_stocks()
+
+            Запрос с настройками выборки (товары не в наличии):
+                async with SellerAPI(client_id, api_key) as api:
+                    result = await api.product_info_stocks(
+                        ProductInfoStocksRequest(
+                            cursor="",
+                            filter=ProductInfoStocksFilter(
+                                offer_id=[],
+                                product_id=[],
+                                visibility = Visibility.EMPTY_STOCK,
+                                with_quants=None
+                            ),
+                            limit=100
+                        )
+                    )
+        """
+        response = await self._request(
+            method="post",
+            api_version="v4",
+            endpoint="product/info/stocks",
+            json=request.model_dump(),
+        )
+        return ProductInfoStocksResponse(**response)
+
+    async def product_info_stocks_by_warehouse_fbs(
+        self: "SellerPricesAndStocksAPI",
+        request: ProductInfoStocksByWarehouseFBSRequest
+    ) -> ProductInfoStocksByWarehouseFBSResponse:
+        """Метод для получения информации о складских остатках и зарезервированном кол-ве в разбивке по складам продавца (FBS и rFBS) по SKU.
+
+        References:
+            https://docs.ozon.ru/api/seller/#operation/ProductAPI_ProductStocksByWarehouseFbs
+
+        Args:
+            request: Список SKU для получения информации о товарах о складских остатках и зарезервированном кол-ве в разбивке по складам продавца (FBS и rFBS) по схеме `ProductInfoStocksByWarehouseFBSRequest`
+
+        Returns:
+            Ответ с информацией о складских остатках и зарезервированном кол-ве в разбивке по складам продавца (FBS и rFBS) по схеме `ProductInfoStocksByWarehouseFBSResponse`
+
+        Example:
+            async with SellerAPI(client_id, api_key) as api:
+                result = await api.product_info_stocks_by_warehouse_fbs(
+                    ProductInfoStocksByWarehouseFBSRequest(
+                        sku=[9876543210, ]
+                    )
+                )
+        """
+        response = await self._request(
+            method="post",
+            api_version="v1",
+            endpoint="product/info/stocks-by-warehouse/fbs",
+            json=request.model_dump(),
+        )
+        return ProductInfoStocksByWarehouseFBSResponse(**response)