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

shopline_sdk/models/quantity_update_not_allowed_error.py

@@ -0,0 +1,14 @@
+"""Shopline API 数据模型 - QuantityUpdateNotAllowedError"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class QuantityUpdateNotAllowedError(BaseModel):
+    message: Optional[str] = None
+    """A detailed message of the reason of failure"""
+    code: Optional[str] = None
+    """An error code"""
+    extras: Optional[Dict[str, Any]] = None
+    """Optional, Extra information about the error"""

shopline_sdk/models/retail_status.py

@@ -0,0 +1,11 @@
+"""Shopline API 数据模型 - retail_status"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class retail_status(BaseModel):
+    """The status that will be applied on the products to the retail store.  更新商品狀態至實體店。"""
+    value: Literal['active', 'draft']
+    """Enum values: active, draft"""

shopline_sdk/models/return_order.py

@@ -0,0 +1,75 @@
+"""Shopline API 数据模型 - ReturnOrder"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+from .order_promotion_item import OrderPromotionItem
+from .return_order_delivery import ReturnOrderDelivery
+from .return_order_delivery_address import ReturnOrderDeliveryAddress
+from .return_order_delivery_data import ReturnOrderDeliveryData
+from .return_order_item import ReturnOrderItem
+from .return_order_payment import ReturnOrderPayment
+from .return_order_promotion_item import ReturnOrderPromotionItem
+from .return_order_ref_data import ReturnOrderRefData
+
+
+
+class OrderConfig(BaseModel):
+    """Configuration model for order"""
+    id: Optional[str] = Field(default=None, alias="_id")
+    """order id 訂單ID"""
+    order_number: Optional[str] = None
+    """Order Number 訂單號碼"""
+    merchant_order_number: Optional[str] = None
+    """店家自定義訂單號 (會根據rollout_key選擇用哪個order_number)"""
+
+class ReturnOrder(BaseModel):
+    id: Optional[str] = None
+    """Return order ID"""
+    return_order_number: Optional[str] = None
+    """Return order number 退貨單號"""
+    created_at: Optional[str] = None
+    """Return order created time 退貨單創建日期"""
+    updated_at: Optional[str] = None
+    """Return order updated time 退貨單更新時間"""
+    status: Optional[Literal['confirmed', 'completed', 'cancelled']] = None
+    """status 退貨訂單狀態"""
+    total: Optional[Money] = None
+    order_id: Optional[str] = None
+    """Order ID"""
+    delivery_address: Optional[ReturnOrderDeliveryAddress] = None
+    inspect_status: Optional[Literal['pending', 'inspected']] = None
+    """Inspect status 驗貨狀態"""
+    customer_id: Optional[str] = None
+    """Customer ID 顧客ID"""
+    customer_name: Optional[str] = None
+    """Customer's Name 顧客姓名"""
+    customer_email: Optional[str] = None
+    """Customer's Email 顧客Email"""
+    customer_phone: Optional[str] = None
+    """Customer's Phone 顧客電話"""
+    order_delivery: Optional[ReturnOrderDelivery] = None
+    delivery_data: Optional[ReturnOrderDeliveryData] = None
+    order_payment: Optional[ReturnOrderPayment] = None
+    order_payment_status: Optional[Literal['pending', 'refunded']] = None
+    """order payment status 訂單退款狀態"""
+    order_delivery_status: Optional[Literal['return_collected', 'returning']] = None
+    """order delivery status 訂單退貨狀態"""
+    items: Optional[ReturnOrderItem] = None
+    promotion_items: Optional[OrderPromotionItem] = None
+    order: Optional[OrderConfig] = None
+    """order data 訂單信息"""
+    returned_by: Optional[Any] = None
+    """returned by which channel 訂單被退途徑"""
+    max_return_total: Optional[Money] = None
+    return_order_promotion_items: Optional[ReturnOrderPromotionItem] = None
+    applied_user_credits: Optional[Money] = None
+    applied_member_point_redeem_to_cash: Optional[Money] = None
+    applied_member_point: Optional[int] = None
+    """applied member point (After return_order_revamp feature key on)<br/> 分攤的折抵會員點數 (啟用「return_order_revamp」功能後)"""
+    custom_discount_items: Optional[ReturnOrderItem] = None
+    custom_discount: Optional[Money] = None
+    ref_data: Optional[ReturnOrderRefData] = None

shopline_sdk/models/return_order_delivery.py

@@ -0,0 +1,26 @@
+"""Shopline API 数据模型 - ReturnOrderDelivery"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Name_TranslationsConfig(BaseModel):
+    """Configuration model for name_translations"""
+    en: Optional[str] = None
+    zh_hant: Optional[str] = Field(default=None, alias="zh-hant")
+
+class ReturnOrderDelivery(BaseModel):
+    id: Optional[str] = None
+    """Order Delivery ID"""
+    platform: Optional[str] = None
+    """Delivery platform 送貨方式類別"""
+    status: Optional[Literal['pending', 'shipping', 'shipped', 'arrived', 'collected', 'returned', 'returning']] = None
+    """Delivery Status 送貨狀態   Status allows:  pending 備貨中  shipping 發貨中  shipped 已發貨  arrived 已到達  collected 已取貨  returned 已退貨  * returning 退貨中"""
+    delivery_status: Optional[Literal['arrived', 'collected', 'expired', 'failed', 'pending', 'request_accepted', 'request_authorized', 'request_submitted', 'returned', 'returning', 'returning_store_closed', 'shipped', 'store_closed']] = None
+    """Logistic Service Order Status 配送狀態   Status allows:  arrived 已到達  collected 已取貨  expired 已過出貨期限  failed 失敗  pending 未執行  request_accepted 可供出貨  request_authorized 待處理  request_submitted 處理中  returned 已退貨  returning 退貨中  returning_store_closed 退貨門市關轉  shipped 已出貨  * store_closed 門市關閉"""
+    delivery_option_id: Optional[str] = None
+    """Delivery Option ID 送貨選項ID"""
+    name_translations: Optional[Name_TranslationsConfig] = None
+    """Delivery Option Name Translations 送貨選項名稱翻譯"""

shopline_sdk/models/return_order_delivery_address.py

@@ -0,0 +1,37 @@
+"""Shopline API 数据模型 - ReturnOrderDeliveryAddress"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class ReturnOrderDeliveryAddress(BaseModel):
+    country_code: Optional[str] = None
+    """Country Code 國家代碼"""
+    country: Optional[str] = None
+    """Country 國家"""
+    city: Optional[str] = None
+    """City 城市"""
+    state: Optional[str] = None
+    """Stage or Region 州/省/地區"""
+    district: Optional[str] = None
+    """district 區域"""
+    postcode: Optional[str] = None
+    """ZIP code 郵政編號"""
+    address_1: Optional[str] = None
+    """Address 1 地址 1"""
+    address_2: Optional[str] = None
+    """Address 1 地址 2 (這裡原則上會自動帶入地址所在行政區)"""
+    key: Optional[str] = None
+    layer1: Optional[str] = None
+    layer2: Optional[str] = None
+    layer3: Optional[str] = None
+    logistic_codes: Optional[List[str]] = None
+    recipient_name: Optional[str] = None
+    """Recipient Name 收件人姓名"""
+    recipient_phone: Optional[str] = None
+    """Recipient Phone 收件人電話號碼"""
+    recipient_phone_country_code: Optional[str] = None
+    """Recipient Phone 收件人電話號碼國碼"""
+    remarks: Optional[str] = None
+    """Remark 備註"""

shopline_sdk/models/return_order_delivery_data.py

@@ -0,0 +1,28 @@
+"""Shopline API 数据模型 - ReturnOrderDeliveryData"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .translatable import Translatable
+
+
+class ReturnOrderDeliveryData(BaseModel):
+    hk_sfplus_home_region: Optional[str] = None
+    location_code: Optional[str] = None
+    """Store Code 便利商店店號"""
+    location_name: Optional[str] = None
+    """Store Code 便利商店店號"""
+    name_translations: Optional[Translatable] = None
+    store_address: Optional[str] = None
+    """Store Address 商店地址"""
+    url: Optional[str] = None
+    """Delivery Tracking url 貨件追蹤URL"""
+    tracking_number: Optional[str] = None
+    """Delivery Tracking Number 貨件追蹤號碼"""
+    scheduled_delivery_date: Optional[str] = None
+    """Scheduled Delivery Date 預計貨到時間"""
+    time_slot_key: Optional[str] = None
+    """Scheduled Delivery Time Slot 送貨時段 ---  If delivery platform istcat 當送貨方式是黑貓時  1 = before 13:00 / 13:00 前 2 = 14:00 - 18:00  4 = any time slot / 任何時間"""
+    time_slot_translations: Optional[Translatable] = None

shopline_sdk/models/return_order_item.py

@@ -0,0 +1,33 @@
+"""Shopline API 数据模型 - ReturnOrderItem"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+from .order_inspect_item import OrderInspectItem
+
+
+class ReturnOrderItem(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"""
+    item_type: Optional[Literal['Product', 'AddonProduct', 'Gift', 'CustomProduct']] = None
+    """Order item type: Product  商品  AddonProduct 加購品 Gift 贈品 CustomProduct 自訂商品"""
+    item_data: Optional[Dict[str, Any]] = None
+    """CartItem snapshot 在第三方合作夥伴下單之前,在購物車內時的資訊快照"""
+    object_data: Optional[Dict[str, Any]] = None
+    """product snapshot 在第三方合作夥伴下單之前,商品的資訊快照"""
+    item_id: Optional[str] = None
+    """ID of Product/Addon Product/Gift 商品/加購品/贈品的ID  (Custom Product doesn't have a item_id) (自訂商品沒有item_id)"""
+    item_variation_id: Optional[str] = None
+    """(To-Be-Deprecated) 規格商品ID請使用下方item_variation_key欄位"""
+    item_price: Optional[Money] = None
+    item_points: Optional[int] = None
+    """Points used for single item 兌換商品所需點數"""
+    quantity: Optional[int] = None
+    """Order item quantity 商品數量"""
+    total: Optional[Money] = None
+    total_points: Optional[int] = None
+    """Total points cost on same product (item_points * quantity)  此商品的總點數"""
+    order_inspect_items: Optional[OrderInspectItem] = None

shopline_sdk/models/return_order_payment.py

@@ -0,0 +1,28 @@
+"""Shopline API 数据模型 - ReturnOrderPayment"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+
+
+class ReturnOrderPayment(BaseModel):
+    id: Optional[Any] = None
+    """Order Payment ID"""
+    payment_method_id: Optional[str] = None
+    """Payment Method ID 付款方式ID"""
+    payment_type: Optional[Literal['ecpay', 'bank_transfer', 'cash_on_delivery', 'custom', 'tw_711_b2c_pay', 'tw_711_pay', 'sl_logistics_ninjavan_cod', 'sl_logistics_kerry_th_cod', 'sl_logistics_ghtk_cod', 'sl_logistics_janio_cod', 'sl_logistics_poslaju_cod']] = None
+    """Payment Method 付款方式"""
+    status: Optional[Literal['pending', 'failed', 'expired', 'completed', 'refunding', 'refunded']] = None
+    """Payment Status 付款狀態   Payment status allows:  pending 未付款  failed 付款失敗  expired 超過付款時間  completed 已付款  refunding 退款中  refunded 已退款"""
+    updated_at: Optional[str] = None
+    """Updated Time related to change of payment 付款更新時間 (UTC +0)"""
+    created_at: Optional[str] = None
+    """Created Date 創造時間 (UTC +0)"""
+    refund_amount: Optional[Money] = None
+    update_refund_amount_at: Optional[str] = None
+    """Update refund_amount Date 退款金額更新時間 (UTC +0)"""
+    payment_data: Optional[Dict[str, Any]] = None
+    """Payment Details Info 付款詳細資訊 (如有串接第三方金流)  Please refer to the example below"""

shopline_sdk/models/return_order_promotion_item.py

@@ -0,0 +1,22 @@
+"""Shopline API 数据模型 - ReturnOrderPromotionItem"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+
+
+class ReturnOrderPromotionItem(BaseModel):
+    id: Optional[str] = None
+    """Return Order Promotion Item ID"""
+    order_promotion_item_id: Optional[str] = None
+    """Order Promotion Item ID"""
+    return_order_id: Optional[str] = None
+    """Return Order ID"""
+    discounted_amount: Optional[Money] = None
+    updated_at: Optional[str] = None
+    """Updated Time 更新時間"""
+    created_at: Optional[str] = None
+    """Created Time 創造時間"""

shopline_sdk/models/return_order_ref_data.py

@@ -0,0 +1,10 @@
+"""Shopline API 数据模型 - ReturnOrderRefData"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class ReturnOrderRefData(BaseModel):
+    return_order_revamp: Optional[str] = None
+    """Return order revamp feature flag"""

shopline_sdk/models/return_orders.py

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

shopline_sdk/models/sale_comment.py

@@ -0,0 +1,30 @@
+"""Shopline API 数据模型 - SaleComment"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class SaleComment(BaseModel):
+    sale_id: Optional[str] = None
+    """Live Room ID 直播間 ID"""
+    platform: Optional[str] = None
+    """Live Platform 直播渠道"""
+    page_id: Optional[str] = None
+    """Fan page ID, some channels may not have it. 粉絲專頁 ID, 部分渠道沒有"""
+    post_id: Optional[str] = None
+    """Post ID, some channels may not have it. 貼文 ID, 部分渠道沒有"""
+    post_sales_user_id: Optional[str] = None
+    """Customer ID in live stream 直播間顧客 ID"""
+    user_name: Optional[str] = None
+    """Customer Name 顧客姓名"""
+    comment_id: Optional[str] = None
+    """Comment ID 留言 ID"""
+    content: Optional[str] = None
+    """Comment Content 留言內容"""
+    hit_keyword: Optional[int] = None
+    """Whether it hits the keyword, (only includes product keywords).  是否命中關鍵字(僅包含商品關鍵字)  0: 未命中; 1: 命中"""
+    has_add_cart: Optional[int] = None
+    """Whether the add-to-cart was successful. 是否加購成功  hit_keyword=1時，此欄位才會有值"""
+    product_info: Optional[List[Any]] = None
+    """Information about the added-to-cart items. 加購的商品資料  hit_keyword=1時，此欄位才會有值"""

shopline_sdk/models/sale_customer.py

@@ -0,0 +1,31 @@
+"""Shopline API 数据模型 - SaleCustomer"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Customer_InfoConfig(BaseModel):
+    """Configuration model for customer_info"""
+    name: Optional[str] = None
+    """Customer Name 顧客姓名"""
+    email: Optional[str] = None
+    """Customer Email 顧客電子郵件"""
+    phone: Optional[str] = None
+    """Customer Phone 顧客電話"""
+    mobile_phone: Optional[str] = None
+    """Customer Mobile Phone 顧客手機"""
+
+class SaleCustomer(BaseModel):
+    post_sales_user_id: Optional[str] = None
+    """Customer ID in live stream 直播間顧客 ID"""
+    platform: Optional[str] = None
+    """Live Platform 直播渠道"""
+    social_user_id: Optional[str] = None
+    """Third-party media user ID 第三方平台的顧客 ID  FB/Group: PSID  IG: IGSID  LINE: 未綁定 EC 會員: EC Customer ID; 已綁定 EC 會員: line_uid  Shopline: EC Customer Id"""
+    has_customer_bind: Optional[bool] = None
+    """是否綁定會員"""
+    customer_id: Optional[str] = None
+    """EC Customer ID EC 顧客 ID"""
+    customer_info: Optional[Customer_InfoConfig] = None

shopline_sdk/models/sale_product.py

@@ -0,0 +1,21 @@
+"""Shopline API 数据模型 - SaleProduct"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class VariationsItem(BaseModel):
+    """Item model for variations"""
+    variation_id: Optional[str] = None
+    custom_keys: Optional[List[str]] = None
+
+class SaleProduct(BaseModel):
+    product_id: Optional[str] = None
+    custom_numbers: Optional[List[str]] = None
+    custom_keys: Optional[List[str]] = None
+    effective_key: Optional[bool] = None
+    create_time: Optional[str] = None
+    update_time: Optional[str] = None
+    variations: Optional[List[VariationsItem]] = None

shopline_sdk/models/save_draft_body.py

@@ -0,0 +1,25 @@
+"""Shopline API 数据模型 - SaveDraftBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .link import Link
+from .page import Page
+from .page_section_settings import PageSectionSettings
+from .translatable import Translatable
+
+
+class SaveDraftBody(BaseModel):
+    """Payload for creating page"""
+    type: Optional[str] = None
+    title_translations: Optional[Translatable] = None
+    content_translations: Optional[Translatable] = None
+    seo_title_translations: Optional[Translatable] = None
+    seo_description_translations: Optional[Translatable] = None
+    seo_keywords: Optional[str] = None
+    link: Optional[Link] = None
+    use_noindex_meta_tag: Optional[bool] = None
+    sections: Optional[Dict[str, PageSectionSettings]] = None
+    sections_order: Optional[List[str]] = None

shopline_sdk/models/sc_conversation.py

@@ -0,0 +1,31 @@
+"""Shopline API 数据模型 - SCConversation"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class Last_MessageConfig(BaseModel):
+    """Configuration model for last_message"""
+    id: Optional[str] = None
+    """Conversation ID 對話 ID"""
+    sender_id: Optional[Any] = None
+    """Sender ID 留言發送方 ID"""
+    sender_type: Optional[Any] = None
+    """Sender Type 留言發送方"""
+    created_at: Optional[str] = None
+    """Created At 建立時間"""
+    value: Optional[str] = None
+    """Content 對話內容"""
+    type: Optional[Literal['text', 'image']] = None
+    """Conversation Type 對話類別"""
+
+class SCConversation(BaseModel):
+    id: Optional[str] = None
+    """Conversation ID 訊息 ID"""
+    type: Optional[Literal['shop_messages', 'order_messages']] = None
+    """Conversation Type 訊息平台"""
+    customer_id: Optional[str] = None
+    """Customer ID 客戶 ID"""
+    last_message: Optional[Last_MessageConfig] = None

shopline_sdk/models/sc_conversations.py

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

shopline_sdk/models/sc_conversations_message.py

@@ -0,0 +1,30 @@
+"""Shopline API 数据模型 - SCConversationsMessage"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class MessageConfig(BaseModel):
+    """Configuration model for message"""
+    sender_id: Optional[str] = None
+    """Sender ID 發送者 ID"""
+    sender_type: Optional[str] = None
+    """Sender Type 發送者類型"""
+    created_at: Optional[str] = None
+    """Created At 訊息建立時間"""
+    acting_sender_id: Optional[str] = None
+    """Performer ID 發送者 ID"""
+    is_sent_by_merchant: Optional[bool] = None
+    """Is Sent by Merchant 是否為 merchant 發送訊息"""
+    content: Optional[str] = None
+    """Content 文字內容"""
+    attachment: Optional[Dict[str, Any]] = None
+
+class SCConversationsMessage(BaseModel):
+    id: Optional[str] = None
+    """Message ID 訊息 ID"""
+    platform: Optional[Literal['shop_messages', 'order_messages']] = None
+    """Conversation Type 訊息種類"""
+    message: Optional[MessageConfig] = None

shopline_sdk/models/sc_conversations_messages.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - SCConversationsMessages"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .sc_conversations_message import SCConversationsMessage
+
+
+class SCConversationsMessages(BaseModel):
+    total: Optional[int] = None
+    """Total Number 總筆數"""
+    limit: Optional[int] = None
+    """Numbers of Shop Messages 顯示筆數"""
+    items: Optional[List[SCConversationsMessage]] = None

shopline_sdk/models/search_products_body.py

@@ -0,0 +1,71 @@
+"""Shopline API 数据模型 - SearchProductsBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class SearchProductsBody(BaseModel):
+    """Parameters for searching products"""
+    page: Optional[int] = None
+    """Page Number 頁數（第n頁）"""
+    per_page: Optional[int] = None
+    """每頁顯示 n 筆資料，建議最多 50 筆 If there're many products, set per_page to 50"""
+    query: Optional[str] = None
+    """支援 product_name、sku、barcode 的模糊查詢"""
+    id: Optional[str] = None
+    """商品 ID，支援等於、不等於、in 多筆查詢"""
+    category_id: Optional[str] = None
+    """商品分類 ID，支援以逗號分隔多筆"""
+    status: Optional[Literal['active', 'draft', 'removed', 'hidden']] = None
+    """商品狀態"""
+    sort_type: Optional[Literal['created_at', 'lowest_price', 'quantity_sold', 'custom_sorting']] = None
+    """排序類型，預設為 created_at"""
+    sort_by: Optional[Literal['asc', 'desc']] = None
+    """排序方向，預設為 desc。當 sort_type 為 quantity_sold 時只能為 desc。"""
+    sku: Optional[str] = None
+    """商品貨號，支援等於、不等於、in 多筆查詢"""
+    barcode: Optional[str] = None
+    """條碼，支援等於、不等於、in 多筆查詢"""
+    is_preorder: Optional[bool] = None
+    """是否為預購商品"""
+    quantity: Optional[str] = None
+    """規格數量，支援 lt/lte/gt/gte/not 等查詢"""
+    variation_quantity: Optional[str] = None
+    """Variation 數量查詢條件，語法同 quantity"""
+    unlimited_quantity: Optional[bool] = None
+    """是否為無限數量"""
+    created_at: Optional[str] = None
+    """建立時間，支援比較運算子（gt/gte/lt/lte）"""
+    updated_at: Optional[str] = None
+    """更新時間，支援比較運算子"""
+    title_translations: Optional[str] = None
+    """標題關鍵字（多語系）"""
+    summary_translations: Optional[str] = None
+    """摘要關鍵字（多語系）"""
+    tags: Optional[str] = None
+    """標籤關鍵字"""
+    excludes: Optional[List[str]] = None
+    """要排除的欄位"""
+    fields: Optional[List[str]] = None
+    """僅顯示的欄位"""
+    include_fields: Optional[List[Literal['labels']]] = None
+    """要額外包含的欄位"""
+    retail_status: Optional[Literal['active', 'draft']] = None
+    """POS 商品上架狀態"""
+    with_product_set: Optional[bool] = None
+    """是否包含組合商品"""
+    purchasable: Optional[bool] = None
+    """是否可購買"""
+    root_product: Optional[bool] = None
+    """是否為 Root Product 查詢模式（僅看 supplier_id 和 pos_category_id）"""
+    supplier_id: Optional[str] = None
+    """供應商 ID（root_product 為 true 時使用）"""
+    pos_category_id: Optional[str] = None
+    """POS 分類 ID（root_product 為 true 時使用）"""
+    type: Optional[str] = None
+    """商品類型（如 product_set）"""
+    previous_id: Optional[str] = None
+    """上一頁最後一筆的 ID（用於 cursor-based 分頁）"""
+    allow_gift: Optional[bool] = None
+    """是否允許作為贈品"""

shopline_sdk/models/server_error.py

@@ -0,0 +1,12 @@
+"""Shopline API 数据模型 - ServerError"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class ServerError(BaseModel):
+    message: Optional[str] = None
+    """A detailed message of the reason of failure"""
+    code: Optional[str] = None
+    """An error code"""

shopline_sdk/models/service_unavailable_error.py

@@ -0,0 +1,12 @@
+"""Shopline API 数据模型 - ServiceUnavailableError"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class ServiceUnavailableError(BaseModel):
+    message: Optional[str] = None
+    code: Optional[str] = None
+    extras: Optional[Dict[str, Any]] = None
+    """Optional, Extra information about the error"""

shopline_sdk/models/settings.py

@@ -0,0 +1,30 @@
+"""Shopline API 数据模型 - Settings"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .app_setting import AppSetting
+from .checkout_setting import CheckoutSetting
+from .payments_setting import PaymentsSetting
+from .pos_setting import PosSetting
+from .product_review_setting import ProductReviewSetting
+from .products_setting import ProductsSetting
+from .promotions_setting import PromotionsSetting
+from .tax_setting import TaxSetting
+from .third_party_ads_setting import ThirdPartyAdsSetting
+from .users_setting import UsersSetting
+
+
+class Settings(BaseModel):
+    users: Optional[UsersSetting] = None
+    app: Optional[AppSetting] = None
+    pos: Optional[PosSetting] = None
+    products: Optional[ProductsSetting] = None
+    checkout: Optional[CheckoutSetting] = None
+    third_party_ads: Optional[ThirdPartyAdsSetting] = None
+    tax: Optional[TaxSetting] = None
+    payments: Optional[PaymentsSetting] = None
+    product_review: Optional[ProductReviewSetting] = None
+    promotions: Optional[PromotionsSetting] = None