shopline-sdk-python 0.1.0__py3-none-any.whl

shopline_sdk/models/product_review.py

@@ -0,0 +1,28 @@
+"""Shopline API 数据模型 - ProductReview"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class RatingConfig(BaseModel):
+    """Configuration model for rating"""
+    one: Optional[int] = None
+    two: Optional[int] = None
+    three: Optional[int] = None
+    four: Optional[int] = None
+    five: Optional[int] = None
+
+class ProductReview(BaseModel):
+    id: Optional[str] = None
+    """ID"""
+    product_id: Optional[str] = None
+    """Product ID"""
+    avg_score: Optional[float] = None
+    """Review score in average 評論平均分數"""
+    total_comments_count: Optional[int] = None
+    """Number of comments in total 評論總數"""
+    imported_comments_count: Optional[int] = None
+    """Number of comments imported 已導入評論總數"""
+    rating: Optional[RatingConfig] = None

shopline_sdk/models/product_review_comment.py

@@ -0,0 +1,31 @@
+"""Shopline API 数据模型 - ProductReviewComment"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class ProductReviewComment(BaseModel):
+    id: Optional[str] = None
+    """ID"""
+    product_id: Optional[str] = None
+    """Product ID"""
+    order_id: Optional[str] = None
+    """Order ID (if any)"""
+    user_id: Optional[str] = None
+    """Customer ID (if any)"""
+    user_name: Optional[str] = None
+    """Name of the reviewer (only applicable on imported review) 評論作者的名稱（只適用於導入評論）"""
+    status: Optional[str] = None
+    score: Optional[int] = None
+    comment: Optional[str] = None
+    """The content of the review comment"""
+    media: Optional[Dict[str, Any]] = None
+    """Object contains url of image in different dimensions 包含不同大小圖片的連絡"""
+    created_by: Optional[str] = None
+    commented_at: Optional[str] = None
+    """Commented time 評論時間"""
+    updated_at: Optional[str] = None
+    """Updated time 更新時間"""
+    created_at: Optional[str] = None
+    """Created time 建立時間"""

shopline_sdk/models/product_review_comments.py

@@ -0,0 +1,14 @@
+"""Shopline API 数据模型 - ProductReviewComments"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .paginatable import Paginatable
+from .product_review_comment import ProductReviewComment
+
+
+class ProductReviewComments(BaseModel):
+    items: Optional[List[ProductReviewComment]] = None
+    pagination: Optional[Paginatable] = None

shopline_sdk/models/product_review_comments_cursor_based.py

@@ -0,0 +1,15 @@
+"""Shopline API 数据模型 - ProductReviewCommentsCursorBased"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .cursor_based_paginatable import CursorBasedPaginatable
+from .product_review_comment import ProductReviewComment
+
+
+class ProductReviewCommentsCursorBased(BaseModel):
+    last_id: Optional[str] = None
+    limit: Optional[int] = None
+    items: Optional[List[ProductReviewComment]] = None

shopline_sdk/models/product_review_setting.py

@@ -0,0 +1,32 @@
+"""Shopline API 数据模型 - ProductReviewSetting"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Review_Reward_ConditionConfig(BaseModel):
+    """Configuration model for review_reward_condition"""
+    min_length: Optional[int] = None
+    """Minimum comment length required 最少評論字數"""
+    deadline_days: Optional[int] = None
+    """Deadline days for reward 評價在order完成後送出的期限天數"""
+    picture_upload: Optional[int] = None
+    """Picture upload required 圖片上傳要求"""
+
+class ProductReviewSetting(BaseModel):
+    hide_review: Optional[bool] = None
+    """Hide Review 是否隱藏評價"""
+    hide: Optional[List[Literal['1', '2', '3', '4', '5']]] = None
+    """Hide Reviews of Given Stars 隱藏評價星等"""
+    show_media: Optional[bool] = None
+    """Show Media 是否顯示圖片"""
+    allow_customer_upload_media: Optional[bool] = None
+    """Allow Upload Media 評價是否可以上傳圖片"""
+    enable_reward: Optional[bool] = None
+    """Enable Reward 是否開啟評價獎賞"""
+    reward_type: Optional[Literal['user_credit', 'member_point']] = None
+    """Reward Type 評價獎賞類別"""
+    review_reward_condition: Optional[Review_Reward_ConditionConfig] = None
+    """Reward Condition 評價獎賞條件"""

shopline_sdk/models/product_reviews.py

@@ -0,0 +1,14 @@
+"""Shopline API 数据模型 - ProductReviews"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .paginatable import Paginatable
+from .product_review import ProductReview
+
+
+class ProductReviews(BaseModel):
+    items: Optional[List[ProductReview]] = None
+    pagination: Optional[Paginatable] = None

shopline_sdk/models/product_stock.py

@@ -0,0 +1,34 @@
+"""Shopline API 数据模型 - ProductStock"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .translatable import Translatable
+from .translatable_array import TranslatableArray
+
+
+
+class StocksConfig(BaseModel):
+    """Configuration model for stocks"""
+    warehouse_id: Optional[str] = None
+    quantity: Optional[int] = None
+
+
+class VariationsConfig(BaseModel):
+    """Configuration model for variations"""
+    id: Optional[str] = None
+    fields_translations: Optional[TranslatableArray] = None
+    stocks: Optional[Dict[str, Any]] = None
+
+class ProductStock(BaseModel):
+    id: Optional[str] = None
+    """Product's ID 商品ID"""
+    title_translations: Optional[Translatable] = None
+    unlimited_quantity: Optional[bool] = None
+    """Unlimited product quantity or not. 商品數量是否無限"""
+    stocks: Optional[StocksConfig] = None
+    """Product's Stock 庫存"""
+    variations: Optional[VariationsConfig] = None
+    """Product's Variation 規格品"""

shopline_sdk/models/product_subscription.py

@@ -0,0 +1,34 @@
+"""Shopline API 数据模型 - ProductSubscription"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .translatable import Translatable
+
+
+class ProductSubscription(BaseModel):
+    id: Optional[str] = None
+    """Order item's ID (ID of an order item's collection, including item_type, item_id..and so on)  系統自行創建訂單品項ID"""
+    recurring_count: Optional[int] = None
+    """Subscription Term 定期購訂單期數"""
+    duration: Optional[int] = None
+    """Number of subscription cycle intervals 定期購週期長度"""
+    duration_type: Optional[Literal['year', 'month', 'day']] = None
+    """Unit of subscription cycle interval 定期購週期單位"""
+    next_billing_at: Optional[str] = None
+    """Next billing date 下次產單日期"""
+    status: Optional[Literal['active', 'inactive']] = None
+    """Status 狀態"""
+    customer_name: Optional[str] = None
+    """Customer's Name 顧客姓名"""
+    customer_email: Optional[str] = None
+    """Customer's Email 顧客Email"""
+    product_name: Optional[Translatable] = None
+    initial_billing_at: Optional[str] = None
+    """Initial billing date 最初產單日期 possibly null 可能為null"""
+    created_at: Optional[str] = None
+    """Created date 創建時間"""
+    updated_at: Optional[str] = None
+    """Updated date 更新時間"""

shopline_sdk/models/product_variation.py

@@ -0,0 +1,56 @@
+"""Shopline API 数据模型 - ProductVariation"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .media import Media
+from .money import Money
+from .translatable_array import TranslatableArray
+
+
+
+class Feed_VariationsConfig(BaseModel):
+    """Configuration model for feed_variations"""
+    color: Optional[Dict[str, Any]] = None
+    size: Optional[Dict[str, Any]] = None
+    material: Optional[str] = None
+
+class ProductVariation(BaseModel):
+    id: Optional[str] = None
+    """Product Variation's ID 規格 ID"""
+    fields_translations: Optional[TranslatableArray] = None
+    price: Optional[Money] = None
+    price_sale: Optional[Money] = None
+    member_price: Optional[Money] = None
+    retail_price: Optional[Money] = None
+    cost: Optional[Money] = None
+    quantity: Optional[float] = None
+    """Product variation's current quantity 規格現有數量"""
+    total_orderable_quantity: Optional[float] = None
+    """Product variation's current orderable quantity 規格現有可購買數量"""
+    unlimited_quantity: Optional[bool] = None
+    """Whether the variation has unlimited quantity or not. 規格是否有無限數量 *Please check the main product's unlimited_quantity to see whether variation has unlimited quantity or not.  unlimited_quantity of variation will always shows null"""
+    preorder_limit: Optional[int] = None
+    """Pre-ordere Limit 預購上限"""
+    media: Optional[Media] = None
+    sku: Optional[str] = None
+    """Stock Keeping Unit 貨號"""
+    location_id: Optional[str] = None
+    """Location ID 儲位編號"""
+    feed_variations: Optional[Feed_VariationsConfig] = None
+    """Default variations for product feed 廣告規格"""
+    variant_option_ids: Optional[List[str]] = None
+    """ID of the corresponding variant options 對應規格類別 ID"""
+    barcode: Optional[str] = None
+    """Barcode 商品條碼編號"""
+    mpn: Optional[str] = None
+    """Manufacturer Part Number 製造編號"""
+    gtin: Optional[str] = None
+    """Barcode 商品條碼編號"""
+    barcode_type: Optional[Literal['Code 128', 'Bookland EAN', 'ISBN']] = None
+    """Barcode type 商品條碼編號類別"""
+    locked_inventory_count: Optional[float] = None
+    weight: Optional[float] = None
+    """Weight (kg) 重量 (公斤)"""

shopline_sdk/models/products_cursor_based.py

@@ -0,0 +1,17 @@
+"""Shopline API 数据模型 - ProductsCursorBased"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .cursor_based_paginatable import CursorBasedPaginatable
+from .product import Product
+
+
+class ProductsCursorBased(BaseModel):
+    last_id: Optional[str] = None
+    limit: Optional[int] = None
+    items: Optional[List[Product]] = None
+    removed_item_ids: Optional[List[Any]] = None
+    price_sets: Optional[Dict[str, Any]] = None

shopline_sdk/models/products_setting.py

@@ -0,0 +1,28 @@
+"""Shopline API 数据模型 - ProductsSetting"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class ProductsSetting(BaseModel):
+    enabled_pos_product_customized_price: Optional[bool] = None
+    enabled_pos_product_price_tier: Optional[bool] = None
+    enabled_product_review: Optional[bool] = None
+    """Enable product review. 啟用商品評價"""
+    price_range_enabled: Optional[bool] = None
+    """Show Price Range in the Store 前台顯示「價格區間」"""
+    variation_display: Optional[Literal['dropdown', 'swatches']] = None
+    """Display style for product variations in the store (Dropdown selection or Label swatches).  商品規格於商店的顯示方式為「下拉選單」或「文字選項」"""
+    addon_limit_enabled: Optional[bool] = None
+    """Addon Limit Enabled 加購品數量上限"""
+    enabled_show_member_price: Optional[bool] = None
+    """Show member price in the store. 在前台顯示「會員價」"""
+    enabled_stock_reminder: Optional[bool] = None
+    """Show Low Inventory Reminder in the Store 在前台顯示「低庫存」提示"""
+    show_sold_out: Optional[bool] = None
+    """Show Sold Out Reminder in the Store 前台顯示「售完」提示"""
+    enabled_pos_pinned_product: Optional[bool] = None
+    """Enable pos pinned product. 啟用 POS 釘選商品功能"""
+    show_max_discount_rate: Optional[Dict[str, Any]] = None
+    """Show max discount rate in the store. 在前台顯示「最低折扣規格」，與折扣的顯示方式"""

shopline_sdk/models/promotion.py

@@ -0,0 +1,104 @@
+"""Shopline API 数据模型 - Promotion"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .extend_promotion import ExtendPromotion
+from .link import Link
+from .media import Media
+from .money import Money
+from .promotion_condition import PromotionCondition
+from .translatable import Translatable
+
+
+class Promotion(BaseModel):
+    id: Optional[str] = None
+    """Promotion ID 優惠活動ID"""
+    discount_percentage: Optional[float] = None
+    """Discount percentage 折扣百分比 - *Applicable when discount_type is percentage 當discount_type為percentage時適用"""
+    discount_amount: Optional[Money] = None
+    discountable_quantity: Optional[int] = None
+    """Quantity 獲得數量 - *When discount_type is gift, this field refers to quantity of gift 當discount_type為gift時，此為贈品數量  *When discount_type is addon, this field refers to quality of add-on 當discount_type為addon時，此為可加購數量"""
+    discounted_point: Optional[int] = None
+    """Amount of point to redeem gift 點數兌換 - *Applicable when discount_type is member_point_redeem_gift 當discount_type為member_point_redeem_gift時適用"""
+    discounted_price: Optional[Money] = None
+    discountable_product_ids: Optional[List[str]] = None
+    """Ids of Discounted product 指定商品ids"""
+    conditions: Optional[List[PromotionCondition]] = None
+    created_at: Optional[str] = None
+    """Created Time 建立時間"""
+    updated_at: Optional[str] = None
+    """Updated Time 更新時間"""
+    title_translations: Optional[Translatable] = None
+    discountable_category_ids: Optional[List[str]] = None
+    """Ids of Discounted category 指定商品分類ids"""
+    discount_on: Optional[Literal['order', 'item', 'category']] = None
+    """Promotion target 優惠套用對象 - order = Entire shop 全店 item = Specific item 指定商品 category = Specific category 指定分類"""
+    discount_type: Optional[Literal['percentage', 'amount', 'gift', 'addon', 'free_shipping', 'bundle_pricing', 'bundle_group', 'member_point_redeem_gift', 'subscription_gift']] = None
+    """Discount type 折扣類型 - percentage: 折扣% amount: 固定金額 gift: 贈品 addon: 加購品 free_shipping: 免運 bundle_pricing: 任選優惠 bundle_group: A+B組合優惠（紅配綠） member_point_redeem_gift: 點數兌換贈品 subscription_gift"""
+    is_accumulated: Optional[bool] = None
+    """Is bundle pricing or bundle pricing accumulated? 任選優惠/A+B組合優惠是否累計"""
+    first_purchase_only: Optional[bool] = None
+    """For first purchase only 創建自動套用—每位會員限用優惠一次的任選優惠"""
+    first_purchase_all_platform: Optional[bool] = None
+    """For first purchase all platform 全通路首購"""
+    codes: Optional[List[str]] = None
+    """Coupon Code 促銷代碼"""
+    show_coupon: Optional[bool] = None
+    membership_tier_id: Optional[str] = None
+    requires_membership: Optional[bool] = None
+    """Does it require membership? 設定目標群組 - false: 所有顧客 true: 會員"""
+    whitelisted_membership_tier_ids: Optional[List[str]] = None
+    """Specific Membership Tiers 適用會員等級"""
+    whitelisted_tag_contents: Optional[List[str]] = None
+    user_max_use_count: Optional[int] = None
+    """Limit per member 每會員最多使用次數 - null = Unlimited 不限使用次數"""
+    max_use_count: Optional[int] = None
+    """How many times can this promotion be used? 活動限使用次數 - null = Unlimited 不限使用次數"""
+    use_count: Optional[int] = None
+    """Usage of this layer of promotion 本階層活動已使用次數"""
+    sum_use_count: Optional[int] = None
+    """Total usage of promotion 活動已使用次數"""
+    whitelisted_delivery_option_ids: Optional[List[str]] = None
+    """Delivery options that applicable to the promotion 活動適用送貨方式"""
+    whitelisted_payment_ids: Optional[List[str]] = None
+    """Payment options that applicable to the promotion 活動適用付款方式"""
+    start_at: Optional[str] = None
+    """Promotion start time 活動開始時間"""
+    end_at: Optional[str] = None
+    """Promotion end time 活動結束時間 - null = no end date 永不過期"""
+    status: Optional[Literal['active', 'draft', 'hidden']] = None
+    """Promotion status 活動狀態 - active: 上架 draft: 下架 hidden: 會員默認優惠/主商品加購品 removed: 刪除"""
+    usable: Optional[bool] = None
+    """Is promotion active 優惠是否進行中 - true: published and not expired上架且沒有過期 false: unpublished or published and expired上架已過期 或是 下架"""
+    for_affiliate_campaign: Optional[bool] = None
+    """Is applicable to affiliate campaign 是否適用於推薦活動"""
+    is_contain_campaign: Optional[bool] = None
+    """Is binded to affiliate campaign 是否已綁定推薦活動"""
+    seo_enabled: Optional[bool] = None
+    """Generate promotion page and SEO sitemap or not"""
+    seo_keywords: Optional[str] = None
+    """SEO keywords SEO 關鍵字"""
+    seo_description_translations: Optional[Translatable] = None
+    seo_title_translations: Optional[Translatable] = None
+    link: Optional[Link] = None
+    available_platforms: Optional[List[str]] = None
+    """指定平台（目前僅接受 "ec", "retail", "app" 值）"""
+    is_partial_free_shipping: Optional[bool] = None
+    coupon_type: Optional[Literal['draw', 'single', 'multi']] = None
+    extended_promotion_id: Optional[str] = None
+    """Parent promotion id 母層活動id - *applicable when this is a child promotion"""
+    extend_promotions: Optional[List[ExtendPromotion]] = None
+    """多階層優惠活動與條件"""
+    drew_coupon_count: Optional[int] = None
+    """How many times did this promotion been drew? 活動被領取次數"""
+    whitelisted_membership_tiers: Optional[List[Dict[str, Any]]] = None
+    """指定會員資料"""
+    summary: Optional[Dict[str, Any]] = None
+    """優惠概況"""
+    available_channel_ids: Optional[List[str]] = None
+    """Ids of available channel 指定通路ids"""
+    banner_medias: Optional[Media] = None
+    term_translations: Optional[Translatable] = None

shopline_sdk/models/promotion_condition.py

@@ -0,0 +1,27 @@
+"""Shopline API 数据模型 - PromotionCondition"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+
+
+class PromotionCondition(BaseModel):
+    id: Optional[str] = None
+    """Promotion Condition ID 優惠活動條件ID"""
+    min_item_count: Optional[int] = None
+    """滿件數量"""
+    min_price: Optional[Money] = None
+    """滿額"""
+    type: Optional[Literal['red', 'green']] = None
+    """A組(紅標)或B組(綠標) -  Applicable when discount_type is bundle_group"""
+    whitelisted_product_ids: Optional[List[str]] = None
+    """指定商品條件id"""
+    whitelisted_category_ids: Optional[List[str]] = None
+    """指定分類條件id"""
+    blacklisted_product_ids: Optional[List[str]] = None
+    """指定排除商品條件id"""
+    subscription_period: Optional[int] = None
+    """subscription period 定期購指定期數"""

shopline_sdk/models/promotion_excluded_hints.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - PromotionExcludedHints"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class PromotionExcludedHints(BaseModel):
+    has_order_promotion_excluded_hint: Optional[bool] = None
+    """Order Promotion Excluded Hint 排除全店優惠提示"""
+    has_member_promotion_excluded_hint: Optional[bool] = None
+    """Member Promotion Excluded Hint 排除會員優惠提示"""
+    has_user_credit_excluded_hint: Optional[bool] = None
+    """User Credit Excluded Hint 排除購物金折扣提示"""
+    has_member_point_excluded_hint: Optional[bool] = None
+    """Member Point Excluded Hint 排除會員點數折扣提示"""

shopline_sdk/models/promotions_setting.py

@@ -0,0 +1,28 @@
+"""Shopline API 数据模型 - PromotionsSetting"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class PromotionsSetting(BaseModel):
+    one_coupon_limit_enabled: Optional[bool] = None
+    """Checkout Limitation to One Coupon  購物車限用一組優惠代碼"""
+    show_promotion_reminder: Optional[bool] = None
+    """Show non-applied 'Free Shipping' promotion reminder on checkout page  顯示未套用 '免運費' 活動提示於結帳購物車"""
+    show_coupon: Optional[bool] = None
+    """Show 'Coupon' in Storefront Member Center  網店會員中心顯示 '優惠券'"""
+    multi_order_discount_strategy: Optional[Literal['order_or_tier_promotion', 'order_and_tier_promotions', 'multi_order_and_tier_promotions']] = None
+    """Order-Level Discount Setting  全店折扣優惠套用設定  order_or_tier_promotion:    Apply the promotion with largest discount among order-level discount promotions and membership offer.    結帳擇優套用一組 全店滿額滿件折扣優惠 或 會員等級默認優惠  order_and_tier_promotions    Apply the promotion with largest discount among order-level discount promotions first and apply membership offer afterward.    結帳擇優套用一組 全店滿額滿件折扣優惠後，疊加套用會員等級默認優惠  multi_order_and_tier_promotions    Apply multiple order-level discount promotions first and and apply membership offer afterward.   結帳疊加套用多組 全店滿額滿件折扣優惠 與 會員等級默認優惠"""
+    order_promotions_ignore_exclude_product: Optional[bool] = None
+    """Order-level discount / Membership offer exclude 'product not applicable to discount'  全店折扣優惠/會員等級默認優惠 排除「不適用折扣商品」"""
+    order_gift_exclude_credit_and_point: Optional[bool] = None
+    """[DEPRECATED] Total order over Minimum Amount Gift promotion condition deduct Credits and Points.  全店滿額送贈品優惠條件扣除 折抵購物金 與 點數折現  This field will be deprecated. Please use `order_gift_threshold_mode` instead.  此欄位即將淘汰，請改用 `order_gift_threshold_mode`。"""
+    order_gift_threshold_mode: Optional[Literal['after_price_discounts', 'after_all_discounts']] = None
+    """Gift Promotion – Minimum Amount Settings  全店滿額送贈品  - `after_price_discounts`: Minimum amount is calculated as: Cart subtotal - Discounts (default)    滿額條件以（購物車小計 - 折扣）計算（默認選中）  - `after_all_discounts`: Minimum amount is calculated as: Cart subtotal - Discounts - Credits - Points    滿額條件以（購物車小計 - 折扣 - 折抵購物金 - 點數折現）計算"""
+    category_item_gift_threshold_mode: Optional[Literal['before_discounts', 'after_price_discounts', 'after_all_discounts']] = None
+    """Free gift for selected products/categories over a minimum amount  指定商品／分類滿額送贈品  - `before_discounts`: Minimum amount is calculated as: Selected product subtotal (default)    滿額條件以（指定商品小計）計算（默認選中）  - `after_price_discounts`: Minimum amount is calculated as: Selected product subtotal - Discounts    滿額條件以（指定商品小計 - 折扣）計算  - `after_all_discounts`: Minimum amount is calculated as: Selected product subtotal - Discounts - Credits - Points    滿額條件以（指定商品小計 - 折扣 - 折抵購物金 - 點數折現）計算"""
+    order_free_shipping_threshold_mode: Optional[Literal['after_price_discounts', 'after_all_discounts']] = None
+    """Free shipping for order over a minimum amount  全店滿額免運費  - `after_price_discounts`: Minimum amount is calculated as: Cart subtotal - Discounts    滿額條件以（購物車小計 - 折扣）計算  - `after_all_discounts`: Minimum amount is calculated as: Cart subtotal - Discounts - Credits - Points (default)    滿額條件以（購物車小計 - 折扣 - 折抵購物金 - 點數折現）計算（默認選中）"""
+    category_item_free_shipping_threshold_mode: Optional[Literal['before_discounts', 'after_price_discounts', 'after_all_discounts']] = None
+    """Free shipping for selected products/categories over a minimum amount  指定商品／分類滿額免運費  - `before_discounts`: Minimum amount is calculated as: Selected product subtotal (default)    滿額條件以（指定商品小計）計算（默認選中）  - `after_price_discounts`: Minimum amount is calculated as: Selected product subtotal - Discounts    滿額條件以（指定商品小計 - 折扣）計算  - `after_all_discounts`: Minimum amount is calculated as: Selected product subtotal - Discounts - Credits - Points    滿額條件以（指定商品小計 - 折扣 - 折抵購物金 - 點數折現）計算"""

shopline_sdk/models/purchase_order.py

@@ -0,0 +1,63 @@
+"""Shopline API 数据模型 - PurchaseOrder"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .agent import Agent
+from .channel import Channel
+from .money import Money
+from .purchase_order_item import PurchaseOrderItem
+from .supplier import Supplier
+
+
+
+class Group_Purchase_OrdersItem(BaseModel):
+    """Item model for group_purchase_orders"""
+    id: Optional[str] = None
+    purchase_number: Optional[str] = None
+    status: Optional[Literal['pending', 'received', 'completed', 'cancelled', 'removed']] = None
+
+class PurchaseOrder(BaseModel):
+    id: Optional[str] = None
+    """Purchase Order ID 進貨單 ID"""
+    type: Optional[Literal['purchase', 'return']] = None
+    """Type  類型"""
+    number: Optional[str] = None
+    """PurchaseOrder Number 單號"""
+    custom_number: Optional[str] = None
+    """Custom Number 自訂單號"""
+    status: Optional[Literal['pending', 'received', 'completed', 'cancelled', 'removed']] = None
+    """Status 貨單狀態"""
+    arrival_status: Optional[Literal['pending_to_receive', 'partial', 'all_received', 'all_returned']] = None
+    """Arrival Status 到貨狀態"""
+    scheduled_time: Optional[str] = None
+    """Time scheduled to arrive at<br預定到貨日期"""
+    actual_time: Optional[str] = None
+    """Actual Time to arrive at 完成進貨日期"""
+    other_fee: Optional[Money] = None
+    total_amount: Optional[Money] = None
+    current_amount: Optional[Money] = None
+    total_quantity: Optional[int] = None
+    """Total Quantity 進貨數量"""
+    current_quantity: Optional[int] = None
+    """Current Quantity 點收數量"""
+    note: Optional[str] = None
+    """Note 備註"""
+    child_id: Optional[str] = None
+    """Child ID 子進貨單 ID"""
+    group_id: Optional[str] = None
+    """Group ID 進貨單群組 ID"""
+    items: Optional[List[PurchaseOrderItem]] = None
+    issuer: Optional[Agent] = None
+    executor: Optional[Agent] = None
+    channel: Optional[Channel] = None
+    supplier: Optional[Supplier] = None
+    has_removed_items: Optional[bool] = None
+    """Has Removed Items 有商品被移除的進貨單項目"""
+    group_purchase_orders: Optional[List[Group_Purchase_OrdersItem]] = None
+    created_at: Optional[str] = None
+    """Created at 建立時間"""
+    updated_at: Optional[str] = None
+    """Updated at 更新時間"""

shopline_sdk/models/purchase_order_item.py

@@ -0,0 +1,66 @@
+"""Shopline API 数据模型 - PurchaseOrderItem"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+
+
+
+class Product_NameConfig(BaseModel):
+    """Configuration model for product_name"""
+    zh_hant: Optional[str] = Field(default=None, alias="zh-hant")
+    en: Optional[str] = None
+
+
+class Variation_TitlesItem(BaseModel):
+    """Item model for variation_titles"""
+    zh_hant: Optional[str] = Field(default=None, alias="zh-hant")
+    en: Optional[str] = None
+
+
+class Variation_NameConfig(BaseModel):
+    """Configuration model for variation_name"""
+    zh_hant: Optional[str] = Field(default=None, alias="zh-hant")
+    en: Optional[str] = None
+
+class PurchaseOrderItem(BaseModel):
+    id: Optional[str] = None
+    """Purchase Order Item ID 進貨單項目 ID"""
+    product_id: Optional[str] = None
+    """Product ID  產品 ID"""
+    variation_id: Optional[str] = None
+    """Variation ID 規格 ID"""
+    product_name: Optional[Product_NameConfig] = None
+    """Product Name 產品名稱"""
+    variation_titles: Optional[List[Variation_TitlesItem]] = None
+    variation_name: Optional[Variation_NameConfig] = None
+    """Variation Name 規格內容"""
+    image_url: Optional[str] = None
+    """Image URL<br圖片網址"""
+    sku: Optional[str] = None
+    """Stock Keeping Unit 商品貨號"""
+    gtin: Optional[str] = None
+    """Global Trade Item Numbers 商品條碼編號"""
+    total_quantity: Optional[int] = None
+    """Total Quantity 進貨數量"""
+    current_quantity: Optional[int] = None
+    """Current Quantity 點收數量"""
+    purchase_price: Optional[Money] = None
+    supplier_id: Optional[str] = None
+    """supplier_id 供應商 ID"""
+    supplier_name: Optional[str] = None
+    """supplier_name 供應商名稱"""
+    subtotal: Optional[Money] = None
+    price: Optional[Money] = None
+    product_removed: Optional[bool] = None
+    """Is Product Removed 商品是否已移除"""
+    unlimited_quantity: Optional[bool] = None
+    """Is Unlimited Quantity 是否為無限量庫存"""
+    same_price: Optional[bool] = None
+    """Same Price 價格是否相同"""
+    total_stocks_cost: Optional[Money] = None
+    stocks: Optional[Dict[str, Any]] = None
+    """Stock 庫存"""

shopline_sdk/models/purchase_orders.py

@@ -0,0 +1,14 @@
+"""Shopline API 数据模型 - PurchaseOrders"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .paginatable import Paginatable
+from .purchase_order import PurchaseOrder
+
+
+class PurchaseOrders(BaseModel):
+    pagination: Optional[Paginatable] = None
+    items: Optional[List[PurchaseOrder]] = None