ey-commerce-lib 1.0.7__tar.gz → 1.0.8__tar.gz

{ey_commerce_lib-1.0.7 → ey_commerce_lib-1.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ey-commerce-lib
-Version: 1.0.7
+Version: 1.0.8
 Summary: eeyoung电商客户端调用封装
 Author-email: 饶奇奇 <1124393197@qq.com>
 Requires-Python: >=3.10

{ey_commerce_lib-1.0.7 → ey_commerce_lib-1.0.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ey-commerce-lib"
-version = "1.0.7"
+version = "1.0.8"
 description = "eeyoung电商客户端调用封装"
 readme = "README.md"
 authors = [

ey_commerce_lib-1.0.8/src/ey_commerce_lib/kogan/main.py

@@ -0,0 +1,40 @@
+from httpx import AsyncClient
+
+from ey_commerce_lib.kogan.schemas.query.order import KoganOrderQuery
+from ey_commerce_lib.kogan.schemas.query.product import KoganProductQuery
+from ey_commerce_lib.kogan.schemas.response.order import OrderResponseModel
+from ey_commerce_lib.kogan.schemas.response.product import ProductResponse
+
+
+class KoganClient:
+
+    def __init__(self, seller_id: str, seller_token: str):
+        self.seller_id = seller_id
+        self.seller_token = seller_token
+        # 异步客户端
+        self.__async_client = AsyncClient(base_url="https://nimda.kogan.com",
+                                          headers={
+                                              'Accept': 'application/json',
+                                              'SellerId': self.seller_id,
+                                              'SellerToken': self.seller_token
+                                          })
+
+    async def orders(self, query_params: KoganOrderQuery):
+        # 设置查询参数
+        orders_res = await self.__async_client.get('/api/marketplace/v2/orders/',
+                                                   params=query_params.model_dump(by_alias=True,
+                                                                                  exclude_none=True))
+        return OrderResponseModel(**orders_res.json())
+
+    async def products(self, query_params: KoganProductQuery):
+        products_res = await self.__async_client.get('/api/marketplace/v2/products/',
+                                                     params=query_params.model_dump(by_alias=True,
+                                                                                    exclude_none=True
+                                                                                    ))
+        return ProductResponse(**products_res.json())
+
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        await self.__async_client.aclose()

ey_commerce_lib-1.0.8/src/ey_commerce_lib/kogan/schemas/query/order.py

@@ -0,0 +1,20 @@
+from typing import Optional
+
+from pydantic import BaseModel, Field, ConfigDict
+
+
+class KoganOrderQuery(BaseModel):
+    # 订单状态  只能传入  ReleasedForShipment
+    status: str = None
+    # 数量  默认值不给为无限制
+    limit: Optional[int] = None
+    # 开始日期
+    start_date_utc: Optional[str] = Field(default=None, alias="startDateUTC")
+    # 结束日期
+    end_date_utc: Optional[str] = Field(default=None, alias="endDateUTC")
+
+    model_config = ConfigDict(
+        # 允许使用别名
+        populate_by_name=True
+    )
+

ey_commerce_lib-1.0.8/src/ey_commerce_lib/kogan/schemas/query/product.py

@@ -0,0 +1,75 @@
+from typing import Optional
+from pydantic import BaseModel, Field, ConfigDict
+
+
+class KoganProductQuery(BaseModel):
+    enabled: Optional[bool] = Field(
+        None,
+        alias="enabled",
+        description="启用状态过滤（True/true/1 表示启用，False/false/0 表示禁用）"
+    )
+    category: Optional[str] = Field(
+        None,
+        alias="category",
+        description="按 Kogan.com 类别名称筛选（不区分大小写，可多选）"
+    )
+    brand: Optional[str] = Field(
+        None,
+        alias="brand",
+        description="按品牌筛选（不区分大小写，可多选，标题中逗号需要转义，例如 '\\,'）"
+    )
+    created: Optional[str] = Field(
+        None,
+        alias="created",
+        description="创建时间"
+    )
+    ebay_category: Optional[int] = Field(
+        None,
+        alias="ebay_category",
+        description="按 eBay 类别 ID 筛选"
+    )
+    sku: Optional[str] = Field(
+        None,
+        alias="sku",
+        description="按 SKU 精确匹配（支持多选）"
+    )
+    search: Optional[str] = Field(
+        None,
+        alias="search",
+        description="搜索商品标题"
+    )
+    ordering: Optional[str] = Field(
+        None,
+        alias="ordering",
+        description="结果排序字段"
+    )
+    cursor: Optional[str] = Field(
+        None,
+        alias="cursor",
+        description="用于分页的游标（续接 'next' URL 的分页查询）"
+    )
+    size: Optional[int] = Field(
+        None,
+        alias="size",
+        description="每页返回结果数量"
+    )
+    created_after: Optional[str] = Field(
+        None,
+        alias="created_after",
+        description="筛选创建日期 >= 指定日期（AEST/AEDT 格式 YYYY-MM-DD）"
+    )
+    created_before: Optional[str] = Field(
+        None,
+        alias="created_before",
+        description="筛选创建日期 <= 指定日期（AEST/AEDT 格式 YYYY-MM-DD）"
+    )
+    detail: Optional[bool] = Field(
+        None,
+        alias="detail",
+        description="是否启用响应中所有字段（True/true/1 表示启用）"
+    )
+
+    model_config = ConfigDict(
+        # 支持别名
+        populate_by_name=True
+    )

ey_commerce_lib-1.0.8/src/ey_commerce_lib/kogan/schemas/response/order.py

@@ -0,0 +1,69 @@
+from pydantic import BaseModel, Field
+from typing import Optional
+from datetime import datetime
+
+
+class AddressModel(BaseModel):
+    address_line1: str = Field(..., alias="AddressLine1")  # 地址行1
+    address_line2: Optional[str] = Field(None, alias="AddressLine2")  # 地址行2
+    city: str = Field(..., alias="City")  # 城市
+    company_name: Optional[str] = Field(None, alias="CompanyName")  # 公司名称
+    country: str = Field(..., alias="Country")  # 国家代码
+    daytime_phone: Optional[str] = Field(None, alias="DaytimePhone")  # 白天联系电话
+    email_address: Optional[str] = Field(None, alias="EmailAddress")  # 邮箱地址
+    evening_phone: Optional[str] = Field(None, alias="EveningPhone")  # 夜间联系电话
+    first_name: str = Field(..., alias="FirstName")  # 名
+    last_name: str = Field(..., alias="LastName")  # 姓
+    name_suffix: Optional[str] = Field(None, alias="NameSuffix")  # 姓名后缀
+    postal_code: str = Field(..., alias="PostalCode")  # 邮政编码
+    state_or_province: Optional[str] = Field(None, alias="StateOrProvince")  # 州或省
+    location_id: Optional[str] = Field(None, alias="LocationId")  # 位置 ID
+    location_id_source: Optional[str] = Field(None, alias="LocationIdSource")  # 位置 ID 来源
+
+
+class ItemModel(BaseModel):
+    id: str = Field(..., alias="ID")  # 商品 ID
+    quantity: int = Field(..., alias="Quantity")  # 商品数量
+    seller_sku: str = Field(..., alias="SellerSku")  # 卖家 SKU
+    product_title: str = Field(..., alias="ProductTitle")  # 商品标题
+    unit_price: float = Field(..., alias="UnitPrice")  # 单价
+
+
+class OrderModel(BaseModel):
+    id: str = Field(..., alias="ID")  # 订单 ID
+    currency: str = Field(..., alias="Currency")  # 货币代码
+    items: list[ItemModel] = Field(..., alias="Items")  # 商品列表
+    order_date_utc: datetime = Field(..., alias="OrderDateUtc")  # 下单时间
+    order_status: str = Field(..., alias="OrderStatus")  # 订单状态
+    requested_shipping_method: str = Field(..., alias="RequestedShippingMethod")  # 请求的配送方式
+    total_gift_option_price: float = Field(..., alias="TotalGiftOptionPrice")  # 礼品选项总价
+    total_gift_option_tax_price: float = Field(..., alias="TotalGiftOptionTaxPrice")  # 礼品选项税费总价
+    total_price: float = Field(..., alias="TotalPrice")  # 订单总价
+    total_shipping_price: float = Field(..., alias="TotalShippingPrice")  # 运费总价
+    total_shipping_tax_price: float = Field(..., alias="TotalShippingTaxPrice")  # 运费税费总价
+    total_tax_price: float = Field(..., alias="TotalTaxPrice")  # 总税费
+    vat_inclusive: bool = Field(..., alias="VatInclusive")  # 是否含税
+    buyer_address: AddressModel = Field(..., alias="BuyerAddress")  # 买家地址
+    deliver_by_date_utc: datetime = Field(..., alias="DeliverByDateUtc")  # 要求送达日期
+    other_fees: float = Field(..., alias="OtherFees")  # 其他费用
+    payment_method: Optional[str] = Field(None, alias="PaymentMethod")  # 支付方式
+    payment_transaction_id: Optional[str] = Field(None, alias="PaymentTransactionID")  # 支付交易号
+    private_notes: Optional[str] = Field(None, alias="PrivateNotes")  # 私有备注
+    shipping_address: AddressModel = Field(..., alias="ShippingAddress")  # 收货地址
+    shipping_label_url: Optional[str] = Field(None, alias="ShippingLabelURL")  # 运单 URL
+    special_instructions: Optional[str] = Field(None, alias="SpecialInstructions")  # 特殊指示
+    total_order_discount: float = Field(..., alias="TotalOrderDiscount")  # 订单折扣总额
+    total_shipping_discount: float = Field(..., alias="TotalShippingDiscount")  # 运费折扣总额
+    order_label: str = Field(..., alias="OrderLabel")  # 订单标签
+    dispatched_items: Optional[list[str]] = Field(None, alias="DispatchedItems")  # 已发货商品 ID 列表
+    cancelled_items: Optional[list[str]] = Field(None, alias="CancelledItems")  # 已取消商品 ID 列表
+    customer_date_of_birth: Optional[str] = Field(None, alias="CustomerDateOfBirth")  # 客户生日
+    web_store: Optional[str] = Field(None, alias="WebStore")  # 网店标识
+    is_premium_subscription: Optional[bool] = Field(None, alias="IsPremiumSubscription")  # 是否高级会员订单
+
+
+class OrderResponseModel(BaseModel):
+    status: str = Field(..., alias="status")  # 响应状态
+    error: Optional[str] = Field(None, alias="error")  # 错误信息
+    pending_url: Optional[str] = Field(None, alias="pending_url")  # 挂起处理 URL
+    body: list[OrderModel] = Field(..., alias="body")  # 订单数据列表

ey_commerce_lib-1.0.8/src/ey_commerce_lib/kogan/schemas/response/product.py

@@ -0,0 +1,96 @@
+from pydantic import BaseModel, Field, ConfigDict
+from typing import Optional
+
+
+class OfferDetail(BaseModel):
+    # 价格
+    price: str = Field(..., alias="price")
+    # Kogan First 价格
+    kogan_first_price: Optional[str] = Field(None, alias="kogan_first_price")
+    # 是否免税
+    tax_exempt: bool = Field(..., alias="tax_exempt")
+    # 运费
+    shipping: str = Field(..., alias="shipping")
+    # 处理天数
+    handling_days: int = Field(..., alias="handling_days")
+    # 建议零售价
+    rrp: Optional[str] = Field(None, alias="rrp")
+
+    model_config = ConfigDict(
+        populate_by_name=True
+    )
+
+
+class StoreUrl(BaseModel):
+    # 商店链接
+    url: str = Field(..., alias="url")
+    # 商店名称
+    store_name: str = Field(..., alias="store_name")
+    # 组织名称
+    organisation: str = Field(..., alias="organisation")
+
+    model_config = ConfigDict(
+        populate_by_name=True
+    )
+
+
+class Product(BaseModel):
+    # 产品标题
+    product_title: str = Field(..., alias="product_title")
+    # 产品SKU
+    product_sku: str = Field(..., alias="product_sku")
+    # 产品副标题
+    product_subtitle: str = Field(..., alias="product_subtitle")
+    # 产品 GTIN
+    product_gtin: str = Field(..., alias="product_gtin")
+    # 图片链接列表
+    images: list[str] = Field(..., alias="images")
+    # 品牌
+    brand: Optional[str] = Field(None, alias="brand")
+    # 类别
+    category: str = Field(..., alias="category")
+    # 类别标识
+    category_slug: str = Field(..., alias="category_slug")
+    # 报价数据
+    offer_data: dict[str, OfferDetail] = Field(..., alias="offer_data")
+    # 库存数量
+    stock: int = Field(..., alias="stock")
+    # 是否启用
+    enabled: bool = Field(..., alias="enabled")
+    # 创建时间
+    created: str = Field(..., alias="created")
+    # 商店地址列表
+    store_urls: list[StoreUrl] = Field(..., alias="store_urls")
+    # 标签
+    tags: list[str] = Field(..., alias="tags")
+
+    model_config = ConfigDict(
+        populate_by_name=True
+    )
+
+
+class Body(BaseModel):
+    # 下一页链接
+    next: Optional[str] = Field(None, alias="next")
+    # 产品列表
+    results: list[Product] = Field(..., alias="results")
+
+    model_config = ConfigDict(
+        populate_by_name=True
+    )
+
+
+class ProductResponse(BaseModel):
+    # 状态
+    status: str = Field(..., alias="status")
+    # 待处理URL
+    pending_url: Optional[str] = Field(None, alias="pending_url")
+    # 错误信息
+    error: Optional[str] = Field(None, alias="error")
+    # 响应主体
+    body: Body = Field(..., alias="body")
+
+    model_config = ConfigDict(
+        populate_by_name=True
+    )
+

ey_commerce_lib-1.0.8/tests/kogan/test_client.py

@@ -0,0 +1,13 @@
+import pytest
+
+from ey_commerce_lib.kogan.main import KoganClient
+from ey_commerce_lib.kogan.schemas.query.product import KoganProductQuery
+
+
+@pytest.mark.asyncio
+async def test_client():
+    async with KoganClient(
+        seller_id="xxxxx",
+        seller_token="xxxxxx"
+    ) as client:
+        await client.products(KoganProductQuery(search="Spider School Bags Kids Superhero Spider-Man Backpack Gift Set (Color:A)"))