shopline-sdk-python 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- shopline_sdk/__init__.py +17 -0
- shopline_sdk/apis/__init__.py +0 -0
- shopline_sdk/apis/addon_products/__init__.py +0 -0
- shopline_sdk/apis/addon_products/bulk_update_addon_product_quantity_by_sku.py +72 -0
- shopline_sdk/apis/addon_products/create_addon_product.py +69 -0
- shopline_sdk/apis/addon_products/get_addon_product.py +42 -0
- shopline_sdk/apis/addon_products/get_addon_product_stocks.py +66 -0
- shopline_sdk/apis/addon_products/get_addon_products.py +84 -0
- shopline_sdk/apis/addon_products/search_addon_products.py +113 -0
- shopline_sdk/apis/addon_products/update_addon_product.py +54 -0
- shopline_sdk/apis/addon_products/update_addon_product_quantity.py +96 -0
- shopline_sdk/apis/addon_products/update_addon_product_stock.py +86 -0
- shopline_sdk/apis/affiliate_campaigns/__init__.py +0 -0
- shopline_sdk/apis/affiliate_campaigns/create_affiliate_campaign.py +109 -0
- shopline_sdk/apis/affiliate_campaigns/delete_affiliate_campaign.py +44 -0
- shopline_sdk/apis/affiliate_campaigns/export_affiliate_campaign_report_to_partner.py +60 -0
- shopline_sdk/apis/affiliate_campaigns/get_affiliate_campaign.py +59 -0
- shopline_sdk/apis/affiliate_campaigns/get_affiliate_campaign_orders.py +75 -0
- shopline_sdk/apis/affiliate_campaigns/get_affiliate_campaign_summary.py +49 -0
- shopline_sdk/apis/affiliate_campaigns/get_affiliate_campaigns.py +84 -0
- shopline_sdk/apis/affiliate_campaigns/get_products_sales_ranking_of_campaign.py +73 -0
- shopline_sdk/apis/affiliate_campaigns/update_affiliate_campaign.py +96 -0
- shopline_sdk/apis/agents/__init__.py +0 -0
- shopline_sdk/apis/agents/get_agent.py +59 -0
- shopline_sdk/apis/agents/get_agents.py +77 -0
- shopline_sdk/apis/bulk_operations/__init__.py +0 -0
- shopline_sdk/apis/bulk_operations/get_a_bulk_operation.py +43 -0
- shopline_sdk/apis/bulk_operations/get_bulk_operations.py +57 -0
- shopline_sdk/apis/cart_item_app_metafields/__init__.py +0 -0
- shopline_sdk/apis/cart_item_app_metafields/bulk_create_app_metafield.py +52 -0
- shopline_sdk/apis/cart_item_app_metafields/bulk_delete_app_metafield.py +61 -0
- shopline_sdk/apis/cart_item_app_metafields/bulk_update_app_metafield.py +62 -0
- shopline_sdk/apis/cart_item_app_metafields/get_app_metafields_attached_to_cart_items_of_specific_cart.py +61 -0
- shopline_sdk/apis/cart_item_metafields/__init__.py +0 -0
- shopline_sdk/apis/cart_item_metafields/bulk_create_metafield.py +52 -0
- shopline_sdk/apis/cart_item_metafields/bulk_delete_metafield.py +62 -0
- shopline_sdk/apis/cart_item_metafields/bulk_update_metafield.py +62 -0
- shopline_sdk/apis/cart_item_metafields/get_metafields_attached_to_cart_items_of_specific_cart.py +62 -0
- shopline_sdk/apis/carts/__init__.py +0 -0
- shopline_sdk/apis/carts/bulk_add_items_to_cart.py +80 -0
- shopline_sdk/apis/carts/bulk_delete_cart_items.py +59 -0
- shopline_sdk/apis/carts/bulk_patch_cart_items.py +61 -0
- shopline_sdk/apis/carts/get_cart.py +63 -0
- shopline_sdk/apis/carts/get_cart_id.py +74 -0
- shopline_sdk/apis/categories/__init__.py +0 -0
- shopline_sdk/apis/categories/bulk_assign.py +75 -0
- shopline_sdk/apis/categories/bulk_update_category_product_sorting.py +84 -0
- shopline_sdk/apis/categories/create_category.py +62 -0
- shopline_sdk/apis/categories/delete_category.py +62 -0
- shopline_sdk/apis/categories/get_categories.py +104 -0
- shopline_sdk/apis/categories/get_category.py +76 -0
- shopline_sdk/apis/categories/update_category.py +70 -0
- shopline_sdk/apis/channels/__init__.py +0 -0
- shopline_sdk/apis/channels/create_product_channel_price.py +45 -0
- shopline_sdk/apis/channels/get_channel.py +76 -0
- shopline_sdk/apis/channels/get_channels.py +83 -0
- shopline_sdk/apis/channels/get_product_channel_price.py +75 -0
- shopline_sdk/apis/channels/update_product_channel_price.py +45 -0
- shopline_sdk/apis/conversations/__init__.py +0 -0
- shopline_sdk/apis/conversations/create_order_message.py +91 -0
- shopline_sdk/apis/conversations/create_return_order_message.py +90 -0
- shopline_sdk/apis/conversations/create_shop_message.py +81 -0
- shopline_sdk/apis/conversations/get_conversations.py +76 -0
- shopline_sdk/apis/conversations/get_messages.py +76 -0
- shopline_sdk/apis/custom_fields/__init__.py +0 -0
- shopline_sdk/apis/custom_fields/get_custom_fields.py +42 -0
- shopline_sdk/apis/customer_app_metafields/__init__.py +0 -0
- shopline_sdk/apis/customer_app_metafields/create_specific_app_metafield.py +44 -0
- shopline_sdk/apis/customer_app_metafields/delete_specific_app_metafield.py +42 -0
- shopline_sdk/apis/customer_app_metafields/get_app_metafields_attached_to_specific_customer.py +61 -0
- shopline_sdk/apis/customer_app_metafields/get_specific_app_metafield.py +41 -0
- shopline_sdk/apis/customer_app_metafields/update_specific_app_metafield.py +44 -0
- shopline_sdk/apis/customer_group_children/__init__.py +0 -0
- shopline_sdk/apis/customer_group_children/get_children_group_of_the_customer_group.py +89 -0
- shopline_sdk/apis/customer_groups/__init__.py +0 -0
- shopline_sdk/apis/customer_groups/get_customer_group.py +65 -0
- shopline_sdk/apis/customer_groups/get_customer_groups.py +108 -0
- shopline_sdk/apis/customer_groups/get_customer_ids_of_the_specific_customer_group.py +84 -0
- shopline_sdk/apis/customer_groups/search_customer_groups.py +92 -0
- shopline_sdk/apis/customer_metafields/__init__.py +0 -0
- shopline_sdk/apis/customer_metafields/create_specific_metafield.py +44 -0
- shopline_sdk/apis/customer_metafields/delete_specific_metafield.py +42 -0
- shopline_sdk/apis/customer_metafields/get_metafields_attached_to_specific_customer.py +62 -0
- shopline_sdk/apis/customer_metafields/get_specific_metafield.py +41 -0
- shopline_sdk/apis/customer_metafields/update_specific_metafield.py +44 -0
- shopline_sdk/apis/customers/__init__.py +0 -0
- shopline_sdk/apis/customers/add_or_remove_customer_tags.py +93 -0
- shopline_sdk/apis/customers/create_customer.py +87 -0
- shopline_sdk/apis/customers/delete_customer.py +62 -0
- shopline_sdk/apis/customers/get_customer.py +94 -0
- shopline_sdk/apis/customers/get_customer_member_points_history.py +92 -0
- shopline_sdk/apis/customers/get_customer_store_credit_history.py +98 -0
- shopline_sdk/apis/customers/get_customers.py +127 -0
- shopline_sdk/apis/customers/get_line_customer.py +67 -0
- shopline_sdk/apis/customers/getcustomers_smembershipinfo.py +93 -0
- shopline_sdk/apis/customers/search_customers.py +216 -0
- shopline_sdk/apis/customers/update_customer.py +87 -0
- shopline_sdk/apis/customers/update_customer_member_points.py +113 -0
- shopline_sdk/apis/customers/update_customer_store_credits.py +172 -0
- shopline_sdk/apis/customers/update_customer_subscriptions.py +64 -0
- shopline_sdk/apis/customers/update_customer_tags.py +88 -0
- shopline_sdk/apis/delivery_options/__init__.py +0 -0
- shopline_sdk/apis/delivery_options/get_delivery_config.py +52 -0
- shopline_sdk/apis/delivery_options/get_delivery_option.py +42 -0
- shopline_sdk/apis/delivery_options/get_delivery_options.py +65 -0
- shopline_sdk/apis/delivery_options/get_delivery_time_slots.py +64 -0
- shopline_sdk/apis/delivery_options/updatedeliveryoption_sstoreinformation.py +67 -0
- shopline_sdk/apis/event_trackers/__init__.py +0 -0
- shopline_sdk/apis/event_trackers/create_an_event_tracker.py +83 -0
- shopline_sdk/apis/event_trackers/delete_an_event_tracker.py +57 -0
- shopline_sdk/apis/event_trackers/get_an_event_tracker.py +64 -0
- shopline_sdk/apis/event_trackers/get_event_trackers.py +97 -0
- shopline_sdk/apis/event_trackers/update_event_tracker.py +91 -0
- shopline_sdk/apis/flash_price_campaigns/__init__.py +0 -0
- shopline_sdk/apis/flash_price_campaigns/create_flash_price_campaign.py +45 -0
- shopline_sdk/apis/flash_price_campaigns/delete_flash_price_campaign.py +44 -0
- shopline_sdk/apis/flash_price_campaigns/get_a_flash_price_campaign.py +43 -0
- shopline_sdk/apis/flash_price_campaigns/get_flash_price_campaigns.py +72 -0
- shopline_sdk/apis/flash_price_campaigns/update_flash_price_campaign.py +46 -0
- shopline_sdk/apis/gifts/__init__.py +0 -0
- shopline_sdk/apis/gifts/bulk_update_quantity_by_sku.py +106 -0
- shopline_sdk/apis/gifts/create_gift.py +57 -0
- shopline_sdk/apis/gifts/get_gift_stocks.py +66 -0
- shopline_sdk/apis/gifts/get_gifts.py +86 -0
- shopline_sdk/apis/gifts/search_gifts.py +110 -0
- shopline_sdk/apis/gifts/update_gift.py +54 -0
- shopline_sdk/apis/gifts/update_gift_quantity.py +100 -0
- shopline_sdk/apis/gifts/update_gift_stock.py +86 -0
- shopline_sdk/apis/layouts/__init__.py +0 -0
- shopline_sdk/apis/layouts/get_layouts_sections.py +77 -0
- shopline_sdk/apis/medias/__init__.py +0 -0
- shopline_sdk/apis/medias/create_image.py +52 -0
- shopline_sdk/apis/member_point_rules/__init__.py +0 -0
- shopline_sdk/apis/member_point_rules/get_member_point_rules.py +55 -0
- shopline_sdk/apis/member_points/__init__.py +0 -0
- shopline_sdk/apis/member_points/bulk_update_member_points.py +87 -0
- shopline_sdk/apis/membership_tiers/__init__.py +0 -0
- shopline_sdk/apis/membership_tiers/get_customer_membership_tier_history.py +84 -0
- shopline_sdk/apis/membership_tiers/get_membership_tiers.py +65 -0
- shopline_sdk/apis/merchant_app_metafields/__init__.py +0 -0
- shopline_sdk/apis/merchant_app_metafields/get_app_metafields_attached_to_current_merchant.py +61 -0
- shopline_sdk/apis/merchant_metafields/__init__.py +0 -0
- shopline_sdk/apis/merchant_metafields/get_metafields_attached_to_current_merchant.py +62 -0
- shopline_sdk/apis/merchants/__init__.py +0 -0
- shopline_sdk/apis/merchants/generatemerchant_sexpresscartlink.py +66 -0
- shopline_sdk/apis/merchants/get_merchant.py +56 -0
- shopline_sdk/apis/merchants/get_merchants.py +46 -0
- shopline_sdk/apis/metafield_definitions/__init__.py +0 -0
- shopline_sdk/apis/metafield_definitions/create_specific_metafield_definition.py +44 -0
- shopline_sdk/apis/metafield_definitions/get_an_array_of_metafield_definitions.py +45 -0
- shopline_sdk/apis/metafield_definitions/get_specific_metafield_definition.py +41 -0
- shopline_sdk/apis/multipass_linking/__init__.py +0 -0
- shopline_sdk/apis/multipass_linking/delete_multipass_linking_for_customer.py +61 -0
- shopline_sdk/apis/multipass_linking/get_active_multipass_linkings.py +67 -0
- shopline_sdk/apis/multipass_linking/update_multipass_linking_for_customer.py +69 -0
- shopline_sdk/apis/multipass_secret/__init__.py +0 -0
- shopline_sdk/apis/multipass_secret/create_multipass_secret.py +41 -0
- shopline_sdk/apis/multipass_secret/get_multipass_secret.py +50 -0
- shopline_sdk/apis/order_app_metafields/__init__.py +0 -0
- shopline_sdk/apis/order_app_metafields/get_app_metafields_attached_to_specific_order.py +61 -0
- shopline_sdk/apis/order_deliveries/__init__.py +0 -0
- shopline_sdk/apis/order_deliveries/get_order_delivery.py +43 -0
- shopline_sdk/apis/order_deliveries/update_order_delivery.py +63 -0
- shopline_sdk/apis/order_item_app_metafields/__init__.py +0 -0
- shopline_sdk/apis/order_item_app_metafields/get_app_metafields_attached_to_order_items_of_specific_order.py +61 -0
- shopline_sdk/apis/order_item_metafields/__init__.py +0 -0
- shopline_sdk/apis/order_item_metafields/get_metafields_attached_to_order_items_of_specific_order.py +62 -0
- shopline_sdk/apis/order_metafields/__init__.py +0 -0
- shopline_sdk/apis/order_metafields/get_metafields_attached_to_specific_order.py +62 -0
- shopline_sdk/apis/orders/__init__.py +0 -0
- shopline_sdk/apis/orders/bulk_execute_shipment.py +70 -0
- shopline_sdk/apis/orders/cancel_order.py +70 -0
- shopline_sdk/apis/orders/create_archived_orders_report.py +72 -0
- shopline_sdk/apis/orders/create_order.py +90 -0
- shopline_sdk/apis/orders/execute_shipment.py +63 -0
- shopline_sdk/apis/orders/get_all_orders_tags.py +54 -0
- shopline_sdk/apis/orders/get_order.py +78 -0
- shopline_sdk/apis/orders/get_order_action_logs.py +62 -0
- shopline_sdk/apis/orders/get_order_labels_of_delivery.py +94 -0
- shopline_sdk/apis/orders/get_order_transaction_by_order_ids.py +58 -0
- shopline_sdk/apis/orders/get_orders.py +111 -0
- shopline_sdk/apis/orders/search_orders.py +339 -0
- shopline_sdk/apis/orders/split_order.py +84 -0
- shopline_sdk/apis/orders/update_order.py +123 -0
- shopline_sdk/apis/orders/update_order_delivery_status.py +88 -0
- shopline_sdk/apis/orders/update_order_payment_status.py +92 -0
- shopline_sdk/apis/orders/update_order_status.py +94 -0
- shopline_sdk/apis/orders/update_order_tags.py +91 -0
- shopline_sdk/apis/payments/__init__.py +0 -0
- shopline_sdk/apis/payments/get_payment.py +59 -0
- shopline_sdk/apis/payments/get_payments.py +88 -0
- shopline_sdk/apis/product_app_metafields/__init__.py +0 -0
- shopline_sdk/apis/product_app_metafields/get_app_metafields_attached_to_specific_product.py +61 -0
- shopline_sdk/apis/product_metafields/__init__.py +0 -0
- shopline_sdk/apis/product_metafields/get_metafields_attached_to_specific_product.py +62 -0
- shopline_sdk/apis/product_review_comments/__init__.py +0 -0
- shopline_sdk/apis/product_review_comments/bulk_create_product_review_comments.py +66 -0
- shopline_sdk/apis/product_review_comments/bulk_delete_product_review_comments.py +46 -0
- shopline_sdk/apis/product_review_comments/bulk_update_product_review_comments.py +64 -0
- shopline_sdk/apis/product_review_comments/create_product_review_comments.py +45 -0
- shopline_sdk/apis/product_review_comments/delete_product_review_comment.py +37 -0
- shopline_sdk/apis/product_review_comments/get_product_review_comment.py +42 -0
- shopline_sdk/apis/product_review_comments/get_product_review_comments.py +91 -0
- shopline_sdk/apis/product_review_comments/update_product_review_comment.py +45 -0
- shopline_sdk/apis/product_subscriptions/__init__.py +0 -0
- shopline_sdk/apis/product_subscriptions/get_a_list_of_product_subscriptions.py +71 -0
- shopline_sdk/apis/product_subscriptions/get_product_subscription.py +42 -0
- shopline_sdk/apis/products/__init__.py +0 -0
- shopline_sdk/apis/products/add_product_images.py +84 -0
- shopline_sdk/apis/products/batch_update_current_product_labels.py +73 -0
- shopline_sdk/apis/products/bulk_delete_product.py +77 -0
- shopline_sdk/apis/products/bulk_update_stock.py +81 -0
- shopline_sdk/apis/products/bulkpublish_unpublishproductinonlinestore.py +64 -0
- shopline_sdk/apis/products/bulkpublish_unpublishproductinretailstore.py +64 -0
- shopline_sdk/apis/products/create_product.py +54 -0
- shopline_sdk/apis/products/create_product_variation.py +70 -0
- shopline_sdk/apis/products/delete_product.py +70 -0
- shopline_sdk/apis/products/delete_product_images.py +54 -0
- shopline_sdk/apis/products/delete_product_variation.py +70 -0
- shopline_sdk/apis/products/get_locked_inventory_count.py +53 -0
- shopline_sdk/apis/products/get_product.py +79 -0
- shopline_sdk/apis/products/get_product_stocks.py +66 -0
- shopline_sdk/apis/products/get_products.py +112 -0
- shopline_sdk/apis/products/search_products.py +58 -0
- shopline_sdk/apis/products/update_current_product_tags.py +80 -0
- shopline_sdk/apis/products/update_product.py +54 -0
- shopline_sdk/apis/products/update_product_price.py +94 -0
- shopline_sdk/apis/products/update_product_quantity.py +102 -0
- shopline_sdk/apis/products/update_product_variation.py +46 -0
- shopline_sdk/apis/products/update_product_variation_price.py +92 -0
- shopline_sdk/apis/products/update_product_variation_quantity.py +111 -0
- shopline_sdk/apis/products/update_quantity_by_sku.py +114 -0
- shopline_sdk/apis/products/update_stock.py +89 -0
- shopline_sdk/apis/promotions/__init__.py +0 -0
- shopline_sdk/apis/promotions/create_promotion.py +45 -0
- shopline_sdk/apis/promotions/delete_promotion.py +44 -0
- shopline_sdk/apis/promotions/get_customer_coupon_promotions.py +61 -0
- shopline_sdk/apis/promotions/get_customer_promotions.py +63 -0
- shopline_sdk/apis/promotions/get_promotion.py +60 -0
- shopline_sdk/apis/promotions/get_promotions.py +106 -0
- shopline_sdk/apis/promotions/search_promotions.py +108 -0
- shopline_sdk/apis/promotions/update_promotion.py +54 -0
- shopline_sdk/apis/purchase_orders/__init__.py +0 -0
- shopline_sdk/apis/purchase_orders/create_child_purchase_order.py +66 -0
- shopline_sdk/apis/purchase_orders/create_purchase_order.py +66 -0
- shopline_sdk/apis/purchase_orders/delete_the_specified_purchase_orders.py +60 -0
- shopline_sdk/apis/purchase_orders/get_purchase_orders.py +89 -0
- shopline_sdk/apis/purchase_orders/get_the_specified_purchase_order.py +59 -0
- shopline_sdk/apis/purchase_orders/update_purchase_order.py +66 -0
- shopline_sdk/apis/return_orders/__init__.py +0 -0
- shopline_sdk/apis/return_orders/create_return_order.py +62 -0
- shopline_sdk/apis/return_orders/get_return_order.py +42 -0
- shopline_sdk/apis/return_orders/get_return_orders.py +95 -0
- shopline_sdk/apis/return_orders/update_return_order.py +70 -0
- shopline_sdk/apis/sales/__init__.py +0 -0
- shopline_sdk/apis/sales/create_sale_products.py +78 -0
- shopline_sdk/apis/sales/delete_sale_products.py +44 -0
- shopline_sdk/apis/sales/get_sale_comments.py +77 -0
- shopline_sdk/apis/sales/get_sale_customers.py +69 -0
- shopline_sdk/apis/sales/get_sale_products.py +74 -0
- shopline_sdk/apis/sales/update_sale_product_status.py +71 -0
- shopline_sdk/apis/sales/update_sale_products.py +78 -0
- shopline_sdk/apis/settings/__init__.py +0 -0
- shopline_sdk/apis/settings/get_checkout_setting.py +51 -0
- shopline_sdk/apis/settings/get_domains_setting.py +51 -0
- shopline_sdk/apis/settings/get_layouts_draft_setting.py +59 -0
- shopline_sdk/apis/settings/get_layouts_setting.py +59 -0
- shopline_sdk/apis/settings/get_orders_setting.py +51 -0
- shopline_sdk/apis/settings/get_payments_setting.py +51 -0
- shopline_sdk/apis/settings/get_pos_setting.py +51 -0
- shopline_sdk/apis/settings/get_product_review_setting.py +51 -0
- shopline_sdk/apis/settings/get_products_setting.py +51 -0
- shopline_sdk/apis/settings/get_promotions_setting.py +51 -0
- shopline_sdk/apis/settings/get_setting.py +42 -0
- shopline_sdk/apis/settings/get_shop_setting.py +51 -0
- shopline_sdk/apis/settings/get_tax_setting.py +51 -0
- shopline_sdk/apis/settings/get_theme_draft_setting.py +59 -0
- shopline_sdk/apis/settings/get_theme_setting.py +59 -0
- shopline_sdk/apis/settings/get_third_party_ads_setting.py +42 -0
- shopline_sdk/apis/settings/get_users_setting.py +65 -0
- shopline_sdk/apis/settings/publish_layouts_setting.py +73 -0
- shopline_sdk/apis/settings/publish_theme_setting.py +59 -0
- shopline_sdk/apis/settings/save_layouts_draft_setting.py +67 -0
- shopline_sdk/apis/settings/save_theme_setting.py +59 -0
- shopline_sdk/apis/settings/update_domains_setting.py +85 -0
- shopline_sdk/apis/staffs/__init__.py +0 -0
- shopline_sdk/apis/staffs/get_all_staff.py +62 -0
- shopline_sdk/apis/staffs/get_staff.py +59 -0
- shopline_sdk/apis/staffs/get_staff_permissions.py +62 -0
- shopline_sdk/apis/store_credits/__init__.py +0 -0
- shopline_sdk/apis/store_credits/bulk_update_store_credits.py +90 -0
- shopline_sdk/apis/store_credits/get_store_credits.py +87 -0
- shopline_sdk/apis/storefront_oauth_applications/__init__.py +0 -0
- shopline_sdk/apis/storefront_oauth_applications/create_storefront_o_auth_application.py +52 -0
- shopline_sdk/apis/storefront_oauth_applications/delete_storefront_oauth_application_by_id.py +47 -0
- shopline_sdk/apis/storefront_oauth_applications/get_storefront_o_auth_application.py +41 -0
- shopline_sdk/apis/storefront_oauth_applications/get_storefront_o_auth_application_by_id.py +50 -0
- shopline_sdk/apis/storefront_tokens/__init__.py +0 -0
- shopline_sdk/apis/storefront_tokens/create_storefront_token.py +60 -0
- shopline_sdk/apis/storefront_tokens/delete_storefront_token_by_id.py +54 -0
- shopline_sdk/apis/storefront_tokens/get_storefront_token_by_id.py +51 -0
- shopline_sdk/apis/storefront_tokens/list_all_storefront_tokens.py +46 -0
- shopline_sdk/apis/taxes/__init__.py +0 -0
- shopline_sdk/apis/taxes/get_taxes.py +65 -0
- shopline_sdk/apis/themes/__init__.py +0 -0
- shopline_sdk/apis/themes/get_theme_by_theme_key.py +63 -0
- shopline_sdk/apis/themes/getthethemesectionsbytheme_key.py +76 -0
- shopline_sdk/apis/token/__init__.py +0 -0
- shopline_sdk/apis/token/get_token_info.py +44 -0
- shopline_sdk/apis/user_coupons/__init__.py +0 -0
- shopline_sdk/apis/user_coupons/claim_user_coupon.py +45 -0
- shopline_sdk/apis/user_coupons/create_user_coupon.py +40 -0
- shopline_sdk/apis/user_coupons/get_user_coupons.py +55 -0
- shopline_sdk/apis/user_coupons/get_user_coupons_with_cursor.py +57 -0
- shopline_sdk/apis/user_coupons/redeem_user_coupon.py +45 -0
- shopline_sdk/apis/warehouses/__init__.py +0 -0
- shopline_sdk/apis/warehouses/get_warehouses.py +92 -0
- shopline_sdk/apis/webhooks/__init__.py +0 -0
- shopline_sdk/apis/webhooks/create_webhook.py +45 -0
- shopline_sdk/apis/webhooks/delete_webhook.py +37 -0
- shopline_sdk/apis/webhooks/get_webhook.py +42 -0
- shopline_sdk/apis/webhooks/get_webhooks.py +59 -0
- shopline_sdk/apis/webhooks/update_webhook.py +45 -0
- shopline_sdk/apis/wish_list_items/__init__.py +0 -0
- shopline_sdk/apis/wish_list_items/create_wish_list_item.py +68 -0
- shopline_sdk/apis/wish_list_items/delete_wish_list_item.py +89 -0
- shopline_sdk/apis/wish_list_items/get_wish_list_items.py +88 -0
- shopline_sdk/client.py +15 -0
- shopline_sdk/exceptions.py +48 -0
- shopline_sdk/helper.py +84 -0
- shopline_sdk/models/__init__.py +610 -0
- shopline_sdk/models/addon_product.py +50 -0
- shopline_sdk/models/addon_products.py +14 -0
- shopline_sdk/models/addon_products_cursor_based.py +15 -0
- shopline_sdk/models/address_node.py +27 -0
- shopline_sdk/models/address_nodes.py +20 -0
- shopline_sdk/models/address_preference.py +46 -0
- shopline_sdk/models/address_preference_layout_data.py +15 -0
- shopline_sdk/models/address_preferences.py +16 -0
- shopline_sdk/models/affiliate.py +32 -0
- shopline_sdk/models/affiliate_campaign.py +53 -0
- shopline_sdk/models/affiliate_campaign_order.py +75 -0
- shopline_sdk/models/affiliate_campaign_orders.py +16 -0
- shopline_sdk/models/affiliate_campaigns.py +20 -0
- shopline_sdk/models/agent.py +20 -0
- shopline_sdk/models/agent_work_log.py +30 -0
- shopline_sdk/models/agent_work_logs.py +12 -0
- shopline_sdk/models/agents.py +14 -0
- shopline_sdk/models/analytics.py +12 -0
- shopline_sdk/models/app_metafield_value.py +26 -0
- shopline_sdk/models/app_setting.py +9 -0
- shopline_sdk/models/bad_request_error.py +14 -0
- shopline_sdk/models/bearer_auth.py +9 -0
- shopline_sdk/models/bulk_delete_metafield_body.py +15 -0
- shopline_sdk/models/bulk_update_app_metafield_body.py +16 -0
- shopline_sdk/models/bulk_update_metafield_body.py +17 -0
- shopline_sdk/models/campaign_product.py +18 -0
- shopline_sdk/models/cart.py +128 -0
- shopline_sdk/models/cart_delivery.py +24 -0
- shopline_sdk/models/cart_item.py +51 -0
- shopline_sdk/models/cart_product.py +83 -0
- shopline_sdk/models/cart_product_variation.py +36 -0
- shopline_sdk/models/cart_promotion.py +19 -0
- shopline_sdk/models/categories.py +14 -0
- shopline_sdk/models/categories_cursor_based.py +15 -0
- shopline_sdk/models/category.py +45 -0
- shopline_sdk/models/category_layout.py +23 -0
- shopline_sdk/models/change_payment_method_response.py +14 -0
- shopline_sdk/models/channel.py +49 -0
- shopline_sdk/models/channel_param.py +11 -0
- shopline_sdk/models/channels.py +14 -0
- shopline_sdk/models/checkout_setting.py +37 -0
- shopline_sdk/models/corporate_info.py +34 -0
- shopline_sdk/models/coupon_item.py +53 -0
- shopline_sdk/models/create_agent_body.py +17 -0
- shopline_sdk/models/create_agent_work_log_request_body.py +18 -0
- shopline_sdk/models/create_app_metafield_body.py +15 -0
- shopline_sdk/models/create_bulk_operation_body.py +22 -0
- shopline_sdk/models/create_category_body.py +27 -0
- shopline_sdk/models/create_channel_price_body.py +21 -0
- shopline_sdk/models/create_customer_body.py +63 -0
- shopline_sdk/models/create_customer_group_activity_body.py +24 -0
- shopline_sdk/models/create_delivery_option_body.py +38 -0
- shopline_sdk/models/create_event_tracker_body.py +23 -0
- shopline_sdk/models/create_flash_price_campaign_body.py +22 -0
- shopline_sdk/models/create_metafield_body.py +16 -0
- shopline_sdk/models/create_metafield_definition_body.py +18 -0
- shopline_sdk/models/create_page_body.py +25 -0
- shopline_sdk/models/create_product_body.py +84 -0
- shopline_sdk/models/create_product_feed_setting_body.py +31 -0
- shopline_sdk/models/create_product_review_comment_body.py +21 -0
- shopline_sdk/models/create_product_variation_body.py +13 -0
- shopline_sdk/models/create_promotion_body.py +56 -0
- shopline_sdk/models/create_return_order_body.py +49 -0
- shopline_sdk/models/create_sub_res_app_metafield_body.py +16 -0
- shopline_sdk/models/create_sub_res_metafield_body.py +17 -0
- shopline_sdk/models/create_user_coupon_body.py +18 -0
- shopline_sdk/models/create_webhook_body.py +14 -0
- shopline_sdk/models/create_wish_list_item_body.py +27 -0
- shopline_sdk/models/cursor_based_paginatable.py +12 -0
- shopline_sdk/models/custom_field.py +18 -0
- shopline_sdk/models/customer.py +200 -0
- shopline_sdk/models/customer_coupon_promotions.py +12 -0
- shopline_sdk/models/customer_group.py +33 -0
- shopline_sdk/models/customer_group_activity.py +28 -0
- shopline_sdk/models/customer_groups.py +14 -0
- shopline_sdk/models/customer_promotion.py +54 -0
- shopline_sdk/models/customer_viewed_categories.py +14 -0
- shopline_sdk/models/customer_viewed_category.py +14 -0
- shopline_sdk/models/customer_viewed_product.py +14 -0
- shopline_sdk/models/customer_viewed_products.py +14 -0
- shopline_sdk/models/delivery_option.py +74 -0
- shopline_sdk/models/delivery_rate.py +17 -0
- shopline_sdk/models/delivery_time_slot.py +27 -0
- shopline_sdk/models/domains_setting.py +13 -0
- shopline_sdk/models/domains_setting_webmaster.py +20 -0
- shopline_sdk/models/end_date_param.py +10 -0
- shopline_sdk/models/entity_render_error.py +11 -0
- shopline_sdk/models/event_tracker.py +35 -0
- shopline_sdk/models/event_trackers.py +14 -0
- shopline_sdk/models/extend_promotion.py +25 -0
- shopline_sdk/models/facebook_business_extension_domains_entity.py +16 -0
- shopline_sdk/models/filter_tag.py +14 -0
- shopline_sdk/models/flash_price_campaign.py +39 -0
- shopline_sdk/models/flash_price_campaigns.py +16 -0
- shopline_sdk/models/forbidden_error.py +14 -0
- shopline_sdk/models/gift.py +54 -0
- shopline_sdk/models/gifts.py +14 -0
- shopline_sdk/models/gifts_cursor_based.py +15 -0
- shopline_sdk/models/global_section.py +12 -0
- shopline_sdk/models/global_section_settings.py +27 -0
- shopline_sdk/models/gross_amount_analytics.py +28 -0
- shopline_sdk/models/gross_orders_analytics.py +29 -0
- shopline_sdk/models/individual_info.py +14 -0
- shopline_sdk/models/interval_param.py +11 -0
- shopline_sdk/models/invoice.py +17 -0
- shopline_sdk/models/is_real_time_param.py +10 -0
- shopline_sdk/models/job.py +48 -0
- shopline_sdk/models/jobs.py +14 -0
- shopline_sdk/models/layout_sections.py +12 -0
- shopline_sdk/models/layouts_setting.py +14 -0
- shopline_sdk/models/limit_exceeded_error.py +14 -0
- shopline_sdk/models/link.py +39 -0
- shopline_sdk/models/lock_inventory.py +9 -0
- shopline_sdk/models/lock_inventory_count.py +14 -0
- shopline_sdk/models/max_applicable_member_point.py +16 -0
- shopline_sdk/models/media.py +16 -0
- shopline_sdk/models/media_upload_error.py +10 -0
- shopline_sdk/models/member_point.py +28 -0
- shopline_sdk/models/member_point_fulfillment.py +23 -0
- shopline_sdk/models/member_point_rule.py +40 -0
- shopline_sdk/models/member_point_rules.py +12 -0
- shopline_sdk/models/member_points.py +14 -0
- shopline_sdk/models/member_registration_analytics.py +29 -0
- shopline_sdk/models/membership_info.py +56 -0
- shopline_sdk/models/membership_tier.py +26 -0
- shopline_sdk/models/membership_tier_action_log.py +19 -0
- shopline_sdk/models/membership_tier_action_logs.py +14 -0
- shopline_sdk/models/membership_tier_rule.py +53 -0
- shopline_sdk/models/merchant.py +78 -0
- shopline_sdk/models/merchant_kyc.py +24 -0
- shopline_sdk/models/merchant_tax.py +50 -0
- shopline_sdk/models/metafield_definition.py +28 -0
- shopline_sdk/models/metafield_value.py +28 -0
- shopline_sdk/models/money.py +13 -0
- shopline_sdk/models/multipass_linking.py +22 -0
- shopline_sdk/models/multipass_linkings.py +16 -0
- shopline_sdk/models/multipass_secret.py +20 -0
- shopline_sdk/models/net_amount_analytics.py +28 -0
- shopline_sdk/models/net_orders_analytics.py +29 -0
- shopline_sdk/models/not_found_error.py +12 -0
- shopline_sdk/models/order.py +218 -0
- shopline_sdk/models/order_action_log.py +16 -0
- shopline_sdk/models/order_action_logs.py +12 -0
- shopline_sdk/models/order_agent.py +16 -0
- shopline_sdk/models/order_campaign_item.py +27 -0
- shopline_sdk/models/order_comment.py +28 -0
- shopline_sdk/models/order_conversation.py +39 -0
- shopline_sdk/models/order_conversations.py +14 -0
- shopline_sdk/models/order_conversations_message.py +32 -0
- shopline_sdk/models/order_conversations_messages.py +16 -0
- shopline_sdk/models/order_customer_info.py +24 -0
- shopline_sdk/models/order_delivery.py +57 -0
- shopline_sdk/models/order_delivery_address.py +37 -0
- shopline_sdk/models/order_delivery_data.py +28 -0
- shopline_sdk/models/order_inspect_item.py +18 -0
- shopline_sdk/models/order_invoice.py +32 -0
- shopline_sdk/models/order_item.py +93 -0
- shopline_sdk/models/order_payment.py +38 -0
- shopline_sdk/models/order_promotion_item.py +24 -0
- shopline_sdk/models/order_source.py +16 -0
- shopline_sdk/models/order_tag.py +10 -0
- shopline_sdk/models/order_transaction.py +32 -0
- shopline_sdk/models/orders_setting.py +25 -0
- shopline_sdk/models/page.py +49 -0
- shopline_sdk/models/page_block_settings.py +12 -0
- shopline_sdk/models/page_section.py +14 -0
- shopline_sdk/models/page_section_schema.py +37 -0
- shopline_sdk/models/page_section_settings.py +29 -0
- shopline_sdk/models/page_sections.py +12 -0
- shopline_sdk/models/paginatable.py +16 -0
- shopline_sdk/models/pagination.py +12 -0
- shopline_sdk/models/payment.py +33 -0
- shopline_sdk/models/payment_config_data.py +14 -0
- shopline_sdk/models/payment_fee_item.py +31 -0
- shopline_sdk/models/payment_settlement.py +47 -0
- shopline_sdk/models/payments_setting.py +17 -0
- shopline_sdk/models/pos_payment.py +19 -0
- shopline_sdk/models/pos_setting.py +15 -0
- shopline_sdk/models/price_detail.py +15 -0
- shopline_sdk/models/price_set.py +29 -0
- shopline_sdk/models/price_sets.py +12 -0
- shopline_sdk/models/product.py +201 -0
- shopline_sdk/models/product_feed_setting.py +45 -0
- shopline_sdk/models/product_feed_settings.py +14 -0
- shopline_sdk/models/product_ids_param.py +10 -0
- shopline_sdk/models/product_price_tier.py +26 -0
- shopline_sdk/models/product_related_theme_settings.py +23 -0
- shopline_sdk/models/product_revenue.py +26 -0
- shopline_sdk/models/product_revenues.py +14 -0
- shopline_sdk/models/product_review.py +28 -0
- shopline_sdk/models/product_review_comment.py +31 -0
- shopline_sdk/models/product_review_comments.py +14 -0
- shopline_sdk/models/product_review_comments_cursor_based.py +15 -0
- shopline_sdk/models/product_review_setting.py +32 -0
- shopline_sdk/models/product_reviews.py +14 -0
- shopline_sdk/models/product_stock.py +34 -0
- shopline_sdk/models/product_subscription.py +34 -0
- shopline_sdk/models/product_variation.py +56 -0
- shopline_sdk/models/products_cursor_based.py +17 -0
- shopline_sdk/models/products_setting.py +28 -0
- shopline_sdk/models/promotion.py +104 -0
- shopline_sdk/models/promotion_condition.py +27 -0
- shopline_sdk/models/promotion_excluded_hints.py +16 -0
- shopline_sdk/models/promotions_setting.py +28 -0
- shopline_sdk/models/purchase_order.py +63 -0
- shopline_sdk/models/purchase_order_item.py +66 -0
- shopline_sdk/models/purchase_orders.py +14 -0
- shopline_sdk/models/quantity_update_not_allowed_error.py +14 -0
- shopline_sdk/models/retail_status.py +11 -0
- shopline_sdk/models/return_order.py +75 -0
- shopline_sdk/models/return_order_delivery.py +26 -0
- shopline_sdk/models/return_order_delivery_address.py +37 -0
- shopline_sdk/models/return_order_delivery_data.py +28 -0
- shopline_sdk/models/return_order_item.py +33 -0
- shopline_sdk/models/return_order_payment.py +28 -0
- shopline_sdk/models/return_order_promotion_item.py +22 -0
- shopline_sdk/models/return_order_ref_data.py +10 -0
- shopline_sdk/models/return_orders.py +14 -0
- shopline_sdk/models/sale_comment.py +30 -0
- shopline_sdk/models/sale_customer.py +31 -0
- shopline_sdk/models/sale_product.py +21 -0
- shopline_sdk/models/save_draft_body.py +25 -0
- shopline_sdk/models/sc_conversation.py +31 -0
- shopline_sdk/models/sc_conversations.py +14 -0
- shopline_sdk/models/sc_conversations_message.py +30 -0
- shopline_sdk/models/sc_conversations_messages.py +16 -0
- shopline_sdk/models/search_products_body.py +71 -0
- shopline_sdk/models/server_error.py +12 -0
- shopline_sdk/models/service_unavailable_error.py +12 -0
- shopline_sdk/models/settings.py +30 -0
- shopline_sdk/models/settlement_terminal_list.py +9 -0
- shopline_sdk/models/shop_conversation.py +31 -0
- shopline_sdk/models/shop_conversations.py +14 -0
- shopline_sdk/models/shop_conversations_message.py +30 -0
- shopline_sdk/models/shop_conversations_messages.py +16 -0
- shopline_sdk/models/shop_crm_setting.py +24 -0
- shopline_sdk/models/shop_setting.py +10 -0
- shopline_sdk/models/staff.py +61 -0
- shopline_sdk/models/staff_performance.py +9 -0
- shopline_sdk/models/start_date_param.py +10 -0
- shopline_sdk/models/status.py +11 -0
- shopline_sdk/models/stock.py +12 -0
- shopline_sdk/models/store_credit.py +50 -0
- shopline_sdk/models/store_credit_fulfillment.py +27 -0
- shopline_sdk/models/storefront_o_auth_application.py +18 -0
- shopline_sdk/models/storefront_o_auth_applications.py +12 -0
- shopline_sdk/models/storefront_token.py +26 -0
- shopline_sdk/models/storefront_token_merchant.py +17 -0
- shopline_sdk/models/storefront_token_staff.py +15 -0
- shopline_sdk/models/storefront_tokens.py +12 -0
- shopline_sdk/models/supplier.py +24 -0
- shopline_sdk/models/tag.py +16 -0
- shopline_sdk/models/taggable.py +9 -0
- shopline_sdk/models/tax.py +57 -0
- shopline_sdk/models/tax_info.py +22 -0
- shopline_sdk/models/tax_region.py +20 -0
- shopline_sdk/models/tax_setting.py +10 -0
- shopline_sdk/models/theme.py +44 -0
- shopline_sdk/models/theme_schema.py +19 -0
- shopline_sdk/models/theme_setting.py +16 -0
- shopline_sdk/models/third_party_ads_setting.py +38 -0
- shopline_sdk/models/token_scopes.py +10 -0
- shopline_sdk/models/top_products_analytics.py +19 -0
- shopline_sdk/models/top_products_analytics_record.py +30 -0
- shopline_sdk/models/top_products_analytics_record_variation.py +34 -0
- shopline_sdk/models/total_sessions_analytics.py +35 -0
- shopline_sdk/models/total_views_analytics.py +29 -0
- shopline_sdk/models/transaction.py +65 -0
- shopline_sdk/models/translatable.py +28 -0
- shopline_sdk/models/translatable_array.py +28 -0
- shopline_sdk/models/unauthorized_error.py +14 -0
- shopline_sdk/models/unprocessable_entity_error.py +16 -0
- shopline_sdk/models/update_addon_product_body.py +36 -0
- shopline_sdk/models/update_agent_body.py +15 -0
- shopline_sdk/models/update_app_metafield_body.py +14 -0
- shopline_sdk/models/update_category_body.py +28 -0
- shopline_sdk/models/update_channel_price_body.py +21 -0
- shopline_sdk/models/update_customer_body.py +62 -0
- shopline_sdk/models/update_customer_group_activity_body.py +22 -0
- shopline_sdk/models/update_event_tracker_body.py +27 -0
- shopline_sdk/models/update_flash_price_campaign_body.py +22 -0
- shopline_sdk/models/update_gift_body.py +20 -0
- shopline_sdk/models/update_lock_inventory_body.py +21 -0
- shopline_sdk/models/update_metafield_body.py +14 -0
- shopline_sdk/models/update_product_body.py +66 -0
- shopline_sdk/models/update_product_feed_setting_body.py +27 -0
- shopline_sdk/models/update_product_review_comment_body.py +18 -0
- shopline_sdk/models/update_product_variation_body.py +34 -0
- shopline_sdk/models/update_promotion_body.py +71 -0
- shopline_sdk/models/update_return_order_body.py +17 -0
- shopline_sdk/models/update_webhook_body.py +14 -0
- shopline_sdk/models/user_coupon.py +12 -0
- shopline_sdk/models/user_coupons.py +14 -0
- shopline_sdk/models/user_credit_rule.py +40 -0
- shopline_sdk/models/users_setting.py +83 -0
- shopline_sdk/models/utm_data.py +20 -0
- shopline_sdk/models/warehouse.py +14 -0
- shopline_sdk/models/warehouses_cursor_based.py +17 -0
- shopline_sdk/models/webhook.py +23 -0
- shopline_sdk/models/webhooks.py +14 -0
- shopline_sdk/models/wish_list_item.py +41 -0
- shopline_sdk/models/wish_list_items.py +15 -0
- shopline_sdk_python-0.1.0.dist-info/METADATA +265 -0
- shopline_sdk_python-0.1.0.dist-info/RECORD +638 -0
- shopline_sdk_python-0.1.0.dist-info/WHEEL +5 -0
- shopline_sdk_python-0.1.0.dist-info/licenses/LICENSE +674 -0
- shopline_sdk_python-0.1.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CouponItem"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .money import Money
|
|
9
|
+
from .translatable import Translatable
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class Coupon_ItemConfig(BaseModel):
|
|
14
|
+
"""Configuration model for coupon_item"""
|
|
15
|
+
coupon_code: Optional[str] = None
|
|
16
|
+
"""Coupon Code 酷碰券代碼"""
|
|
17
|
+
discounted_amount: Optional[Money] = None
|
|
18
|
+
"""Discount Amount 折扣金額"""
|
|
19
|
+
|
|
20
|
+
class CouponItem(BaseModel):
|
|
21
|
+
id: Optional[str] = None
|
|
22
|
+
"""優惠 ID"""
|
|
23
|
+
cart_tag_id: Optional[str] = None
|
|
24
|
+
"""Cart Tag ID 購物車溫層 ID"""
|
|
25
|
+
coupon_item: Optional[Coupon_ItemConfig] = None
|
|
26
|
+
discounted_amount: Optional[Money] = None
|
|
27
|
+
"""Discount Amount 折抵固定金額(優惠類型為 固定金額 時)"""
|
|
28
|
+
discount_on: Optional[str] = None
|
|
29
|
+
"""Discount On 優惠生效等級"""
|
|
30
|
+
discount_percentage: Optional[float] = None
|
|
31
|
+
"""Discount Percentage 折抵百分比數(優惠類型為 %折扣 時)"""
|
|
32
|
+
discount_type: Optional[str] = None
|
|
33
|
+
"""Discount Type 優惠類型"""
|
|
34
|
+
discounted_price: Optional[Money] = None
|
|
35
|
+
"""Discounted Price 加購品優惠折抵金額"""
|
|
36
|
+
extended_promotion_id: Optional[str] = None
|
|
37
|
+
"""Extended Promotion ID 多階層優惠所對應的主要優惠活動 ID"""
|
|
38
|
+
is_accumulated: Optional[bool] = None
|
|
39
|
+
"""Is Accumulated Promotion 是否是自動累計優惠"""
|
|
40
|
+
is_extend_promotion: Optional[bool] = None
|
|
41
|
+
"""Is Extend Promotion 是否是多階層優惠"""
|
|
42
|
+
is_membership_tier_promotion: Optional[bool] = None
|
|
43
|
+
"""Is Membership Tier Promotion 是否是會員分級專屬優惠"""
|
|
44
|
+
membership_tier_id: Optional[str] = None
|
|
45
|
+
"""Membership Tier ID 會員分級專屬優惠 ID"""
|
|
46
|
+
requires_membership: Optional[bool] = None
|
|
47
|
+
"""Requires Membership 需要會員資格"""
|
|
48
|
+
summary_translations: Optional[Translatable] = None
|
|
49
|
+
"""Summary Translations 優惠簡介"""
|
|
50
|
+
title_translations: Optional[Translatable] = None
|
|
51
|
+
"""Title Translations 優惠標題"""
|
|
52
|
+
whitelisted_membership_tier_ids: Optional[List[str]] = None
|
|
53
|
+
"""Whitelisted Membership Tier IDs 可使用的會員等級 IDs"""
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateAgentBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .agent import Agent
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class CreateAgentBody(BaseModel):
|
|
12
|
+
"""Payload for creating agent"""
|
|
13
|
+
name: str
|
|
14
|
+
pin_code: str
|
|
15
|
+
"""Pin code of the agent 員工 pin code"""
|
|
16
|
+
email: Optional[str] = None
|
|
17
|
+
phone: Optional[str] = None
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateAgentWorkLogRequestBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Work_LogConfig(BaseModel):
|
|
10
|
+
"""Configuration model for work_log"""
|
|
11
|
+
clock_type: Literal['in', 'out']
|
|
12
|
+
"""The type of clock action (in or out)"""
|
|
13
|
+
clocked_at: str
|
|
14
|
+
"""The timestamp of the clock action"""
|
|
15
|
+
|
|
16
|
+
class CreateAgentWorkLogRequestBody(BaseModel):
|
|
17
|
+
"""Payload for create agent's work log"""
|
|
18
|
+
work_log: Work_LogConfig
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateAppMetafieldBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .app_metafield_value import AppMetafieldValue
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class CreateAppMetafieldBody(BaseModel):
|
|
12
|
+
"""Payload for creating app metafield"""
|
|
13
|
+
key: Optional[str] = None
|
|
14
|
+
field_type: Optional[Literal['single_line_text_field', 'multi_line_text_field', 'number_integer', 'number_decimal', 'json', 'boolean', 'url']] = None
|
|
15
|
+
field_value: Optional[Union[str, float, bool, Dict[str, Any]]] = None
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateBulkOperationBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .product import Product
|
|
9
|
+
from .translatable import Translatable
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class DataItem(BaseModel):
|
|
14
|
+
"""Item model for data"""
|
|
15
|
+
operation_ref_id: str
|
|
16
|
+
"""The id of the product 商品ID"""
|
|
17
|
+
product: Dict[str, Any]
|
|
18
|
+
|
|
19
|
+
class CreateBulkOperationBody(BaseModel):
|
|
20
|
+
"""Payload for creating bulk operation"""
|
|
21
|
+
data: Optional[List[DataItem]] = None
|
|
22
|
+
"""Bulk operation payload. 創建新商品批量操作所需內容。"""
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateCategoryBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .category import Category
|
|
9
|
+
from .translatable import Translatable
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class CategoryConfig(BaseModel):
|
|
14
|
+
"""Configuration model for category"""
|
|
15
|
+
name_translations: Optional[Translatable] = None
|
|
16
|
+
seo_title_translations: Optional[Translatable] = None
|
|
17
|
+
seo_description_translations: Optional[Translatable] = None
|
|
18
|
+
seo_keywords: Optional[str] = None
|
|
19
|
+
seo_link: Optional[str] = None
|
|
20
|
+
"""SEO url 自訂SEO url"""
|
|
21
|
+
parent_id: Optional[str] = None
|
|
22
|
+
banner_url: Optional[str] = None
|
|
23
|
+
"""Category Banner Picture 分類横幅圖片"""
|
|
24
|
+
|
|
25
|
+
class CreateCategoryBody(BaseModel):
|
|
26
|
+
"""Payload for creating category"""
|
|
27
|
+
category: Optional[CategoryConfig] = None
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateChannelPriceBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Price_DetailsItem(BaseModel):
|
|
10
|
+
"""Item model for price_details"""
|
|
11
|
+
variation_key: str
|
|
12
|
+
"""The id of the variation product 商品規格ID"""
|
|
13
|
+
price: float
|
|
14
|
+
"""The price of the product when the event is started 商品規格分店價格"""
|
|
15
|
+
|
|
16
|
+
class CreateChannelPriceBody(BaseModel):
|
|
17
|
+
"""Payload for creating product channel price"""
|
|
18
|
+
price: Optional[float] = None
|
|
19
|
+
"""The Channel price of the product 商品分店價格"""
|
|
20
|
+
price_details: Optional[List[Price_DetailsItem]] = None
|
|
21
|
+
"""The channel price sets of the variations of the product 商品規格分店價格"""
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateCustomerBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .customer import Customer
|
|
9
|
+
from .order_delivery_address import OrderDeliveryAddress
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class CreateCustomerBody(BaseModel):
|
|
13
|
+
"""Payload for updating customer"""
|
|
14
|
+
name: Optional[str] = None
|
|
15
|
+
email: Optional[str] = None
|
|
16
|
+
"""Customer's Email 顧客電子郵件 - *Customers will receive a requirement to reset password by email after creation. 使用open api Create Customer之後顧客將會收到要求重新設定密碼之email"""
|
|
17
|
+
mobile_phone: Optional[str] = None
|
|
18
|
+
"""Customer Mobile Phone, separate by comma if multiple It has to be used with mobile_phone_country_calling_code 顧客手機, 以逗號分隔, 需與mobile_phone_country_calling_code一同使用"""
|
|
19
|
+
mobile_phone_country_calling_code: Optional[str] = None
|
|
20
|
+
"""Country Code of Mobile Phone. It has to be used with mobile_phone It has to be comply with the "Mobile sign up country" in customer setting 手機號碼國碼, 需與mobile_phone一同使用 號碼所屬國家需符合後台設定的「手機註冊支援國家」"""
|
|
21
|
+
send_notification: Optional[bool] = None
|
|
22
|
+
"""Will send welcome email/sms if True 是否發出歡迎電郵/短訊 -- Default: true"""
|
|
23
|
+
notification_types: Optional[List[Literal['email', 'sms']]] = None
|
|
24
|
+
"""Email and/or SMS. SMS can be sent only after enabling feature. System will try to send both email and SMS if this field is not specified. 電郵 及/或 短訊。 需開通功能後才能發出短訊。 如漏空,系統會嘗試所有通知方法"""
|
|
25
|
+
phones: Optional[str] = None
|
|
26
|
+
"""Customer's Phones 顧客電話 - *Not verified mobile phone number 請注意,非客戶手機驗證電話"""
|
|
27
|
+
phone: Optional[str] = None
|
|
28
|
+
"""Customer's Phone 顧客電話 - *Not verified mobile phone number 請注意,非客戶手機驗證電話"""
|
|
29
|
+
phone_country_code: Optional[str] = None
|
|
30
|
+
"""Customer Phone Country Code.<br />顧客電話國碼"""
|
|
31
|
+
gender: Optional[Literal['male', 'female', 'other']] = None
|
|
32
|
+
birthday: Optional[str] = None
|
|
33
|
+
birth_year: Optional[int] = None
|
|
34
|
+
"""Customer's birth year 顧客出生年份 - *Could not be used with the birthday parameter at the same time."""
|
|
35
|
+
birth_month: Optional[int] = None
|
|
36
|
+
"""Customer's birth month 顧客出生月份 - *Could not be used with the birthday parameter at the same time."""
|
|
37
|
+
birth_day: Optional[int] = None
|
|
38
|
+
"""Customer's birth day 顧客出生日期 - *Could not be used with the birthday parameter at the same time."""
|
|
39
|
+
is_member: Optional[bool] = None
|
|
40
|
+
"""Set as True for registered customer 是否為會員?"""
|
|
41
|
+
is_accept_marketing: Optional[bool] = None
|
|
42
|
+
"""Set as True for acceptance of marketing news. 是否接受優惠宣傳?"""
|
|
43
|
+
is_subscribed_marketing_email: Optional[bool] = None
|
|
44
|
+
"""Set as True for acceptance of email marketing news. 是否接受email優惠宣傳?"""
|
|
45
|
+
is_subscribed_marketing_sms: Optional[bool] = None
|
|
46
|
+
"""Set as True for acceptance of sms marketing news. 是否接受sms優惠宣傳?"""
|
|
47
|
+
delivery_addresses: Optional[List[OrderDeliveryAddress]] = None
|
|
48
|
+
"""Customer's Delivery Address 顧客送貨地址 - *Maximum for 5 delivery address groups 最多五組"""
|
|
49
|
+
is_allow_welcome_credit: Optional[bool] = None
|
|
50
|
+
"""Set as True for sending welcome credit. 是否發送入會購物金 *If welcome credit is enabled at admin panel, welcome credit and notification will be sent when creating customer. 若後台啟用入會購物金功能,建立顧客時會發送入會購物金與通知 Default: false"""
|
|
51
|
+
created_by: Optional[Literal['shop', 'admin', 'openapi', 'shop_crm', 'pos']] = None
|
|
52
|
+
"""Creation source 記錄創建來源"""
|
|
53
|
+
created_by_channel_id: Optional[str] = None
|
|
54
|
+
"""Creation source id 記錄創建來源的id"""
|
|
55
|
+
registered_by: Optional[Literal['shop', 'admin', 'openapi', 'shop_crm', 'pos']] = None
|
|
56
|
+
"""Registration source 會員註冊來源"""
|
|
57
|
+
registered_by_channel_id: Optional[str] = None
|
|
58
|
+
"""Registration source id 會員註冊來源的id"""
|
|
59
|
+
memo: Optional[str] = None
|
|
60
|
+
tags: Optional[List[str]] = None
|
|
61
|
+
"""顧客標籤"""
|
|
62
|
+
membership_tier_id: Optional[str] = None
|
|
63
|
+
"""Membership Tier ID The details of the Membership Tier could be retrieved from Get Membership Tiers endpoint 會員等級ID 會員等級的詳細資料可在Get Membership Tiers的endpoint檢索到"""
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateCustomerGroupActivityBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .customer_group_activity import CustomerGroupActivity
|
|
9
|
+
from .translatable import Translatable
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class Customer_Group_ActivityConfig(BaseModel):
|
|
14
|
+
"""Configuration model for customer_group_activity"""
|
|
15
|
+
name_translations: Translatable
|
|
16
|
+
ref_id: str
|
|
17
|
+
type: str
|
|
18
|
+
activity_status: Literal['draft', 'pending', 'cancelled', 'sending', 'sent', 'failed', 'partially_sent', 'removed']
|
|
19
|
+
activity_time: Optional[str] = None
|
|
20
|
+
submitted_at: Optional[str] = None
|
|
21
|
+
|
|
22
|
+
class CreateCustomerGroupActivityBody(BaseModel):
|
|
23
|
+
"""Payload for creating customer group activity"""
|
|
24
|
+
customer_group_activity: Optional[Customer_Group_ActivityConfig] = None
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateDeliveryOptionBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .delivery_option import DeliveryOption
|
|
9
|
+
from .money import Money
|
|
10
|
+
from .translatable import Translatable
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class Config_DataConfig(BaseModel):
|
|
15
|
+
"""Configuration model for config_data"""
|
|
16
|
+
lead_time: Optional[Dict[str, Any]] = None
|
|
17
|
+
max_lead_time: Optional[Dict[str, Any]] = None
|
|
18
|
+
excluded_weekdays: Optional[Dict[str, Any]] = None
|
|
19
|
+
excluded_dates: Optional[Dict[str, Any]] = None
|
|
20
|
+
delivery_time_required: Optional[Dict[str, Any]] = None
|
|
21
|
+
specific_delivery_time_translations: Optional[Dict[str, Any]] = None
|
|
22
|
+
delivery_target_area: Optional[Dict[str, Any]] = None
|
|
23
|
+
|
|
24
|
+
class CreateDeliveryOptionBody(BaseModel):
|
|
25
|
+
"""Payload for creating delivery option"""
|
|
26
|
+
status: Optional[Literal['active', 'draft']] = None
|
|
27
|
+
name_translations: Translatable
|
|
28
|
+
description_translations: Optional[Translatable] = None
|
|
29
|
+
show_description_on_checkout: Optional[bool] = None
|
|
30
|
+
delivery_time_description_translations: Optional[Translatable] = None
|
|
31
|
+
config_data: Optional[Config_DataConfig] = None
|
|
32
|
+
requires_customer_address: Optional[bool] = None
|
|
33
|
+
fee_type: Literal['flat', 'flat_weight', 'subtotal', 'item_count', 'sl_logistic']
|
|
34
|
+
delivery_rates: List[Dict[str, Any]]
|
|
35
|
+
region_type: Optional[Literal['custom']] = None
|
|
36
|
+
"""Delivery Option Code 送貨方式代碼 Only support creating "custom" region_type through open api"""
|
|
37
|
+
delivery_type: Optional[Literal['custom']] = None
|
|
38
|
+
"""Only support creating "custom" delivery_type through open api"""
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateEventTrackerBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Config_DataConfig(BaseModel):
|
|
10
|
+
"""Configuration model for config_data"""
|
|
11
|
+
tracking_code: Optional[str] = None
|
|
12
|
+
"""Tracking code 追蹤碼"""
|
|
13
|
+
access_token: Optional[str] = None
|
|
14
|
+
"""Access token"""
|
|
15
|
+
|
|
16
|
+
class CreateEventTrackerBody(BaseModel):
|
|
17
|
+
"""Payload for creating an event tracker"""
|
|
18
|
+
event_key: Literal['tiktok', 'facebook_standard_pixel']
|
|
19
|
+
"""The platform of tracking services 追蹤平台"""
|
|
20
|
+
event_type: Literal['loaded_home_page', 'added_product_to_cart', 'loaded_checkout_page', 'placed_an_order', 'loaded_any_page']
|
|
21
|
+
"""The event to be tracked 需要追蹤的事件"""
|
|
22
|
+
config_data: Config_DataConfig
|
|
23
|
+
"""Config data, each event_key has its own config 設定,每個event_key都有各自的config"""
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateFlashPriceCampaignBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Flash_Price_CampaignConfig(BaseModel):
|
|
10
|
+
"""Configuration model for flash_price_campaign"""
|
|
11
|
+
start_at: str
|
|
12
|
+
"""The start time of the event 商品限時促銷價活動的開始時間 *Should use UTC time *應使用UTC時間"""
|
|
13
|
+
end_at: str
|
|
14
|
+
"""The end time of the event 商品限時促銷價活動的結束時間 *Should use UTC time *應使用UTC時間"""
|
|
15
|
+
title: str
|
|
16
|
+
"""Flash price campaign's title 商品限時促銷價活動的名稱"""
|
|
17
|
+
price_sets: Optional[List[Dict[str, Any]]] = None
|
|
18
|
+
"""The product price sets of this flash price campaigns. 商品限時促銷價活動的商品限時價格。"""
|
|
19
|
+
|
|
20
|
+
class CreateFlashPriceCampaignBody(BaseModel):
|
|
21
|
+
"""Payload for creating flash price campaign"""
|
|
22
|
+
flash_price_campaign: Optional[Flash_Price_CampaignConfig] = None
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateMetafieldBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .metafield_value import MetafieldValue
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class CreateMetafieldBody(BaseModel):
|
|
12
|
+
"""Payload for creating metafield"""
|
|
13
|
+
namespace: Optional[str] = None
|
|
14
|
+
key: Optional[str] = None
|
|
15
|
+
field_type: Optional[Literal['single_line_text_field', 'multi_line_text_field', 'number_integer', 'number_decimal', 'json', 'boolean', 'url']] = None
|
|
16
|
+
field_value: Optional[Union[str, float, bool, Dict[str, Any]]] = None
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateMetafieldDefinitionBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .metafield_definition import MetafieldDefinition
|
|
9
|
+
from .metafield_value import MetafieldValue
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class CreateMetafieldDefinitionBody(BaseModel):
|
|
13
|
+
"""Payload for creating metafield definition"""
|
|
14
|
+
namespace: Optional[str] = None
|
|
15
|
+
key: Optional[str] = None
|
|
16
|
+
name: Optional[str] = None
|
|
17
|
+
description: Optional[str] = None
|
|
18
|
+
field_type: Optional[Literal['single_line_text_field', 'multi_line_text_field', 'number_integer', 'number_decimal', 'json', 'boolean', 'url']] = None
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreatePageBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .link import Link
|
|
9
|
+
from .page import Page
|
|
10
|
+
from .page_section_settings import PageSectionSettings
|
|
11
|
+
from .translatable import Translatable
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class CreatePageBody(BaseModel):
|
|
15
|
+
"""Payload for creating page"""
|
|
16
|
+
type: Optional[str] = None
|
|
17
|
+
title_translations: Optional[Translatable] = None
|
|
18
|
+
content_translations: Optional[Translatable] = None
|
|
19
|
+
seo_title_translations: Optional[Translatable] = None
|
|
20
|
+
seo_description_translations: Optional[Translatable] = None
|
|
21
|
+
seo_keywords: Optional[str] = None
|
|
22
|
+
link: Optional[Link] = None
|
|
23
|
+
use_noindex_meta_tag: Optional[bool] = None
|
|
24
|
+
sections: Optional[Dict[str, PageSectionSettings]] = None
|
|
25
|
+
sections_order: Optional[List[str]] = None
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateProductBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .product import Product
|
|
9
|
+
from .product_variation import ProductVariation
|
|
10
|
+
from .translatable import Translatable
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class ProductConfig(BaseModel):
|
|
15
|
+
"""Configuration model for product"""
|
|
16
|
+
price: Optional[float] = None
|
|
17
|
+
"""Product Price 原價格"""
|
|
18
|
+
price_sale: Optional[float] = None
|
|
19
|
+
"""Product Sale Price 特價"""
|
|
20
|
+
retail_price: Optional[float] = None
|
|
21
|
+
"""Retail Price 零售價"""
|
|
22
|
+
member_price: Optional[float] = None
|
|
23
|
+
"""Member Price 會員價"""
|
|
24
|
+
cost: Optional[float] = None
|
|
25
|
+
"""Product Cost 成本價"""
|
|
26
|
+
product_price_tiers: Optional[Dict[str, str]] = None
|
|
27
|
+
"""Membership tier's ID 會員等級ID"""
|
|
28
|
+
hide_price: Optional[bool] = None
|
|
29
|
+
same_price: Optional[bool] = None
|
|
30
|
+
quantity: Optional[float] = None
|
|
31
|
+
"""Quantity 商品數量 - If the product contains variations with quantity, this field will be the sum of quantities of all variations. Otherwise, the product quantity is between 0 to 9999999. 如果商品有不同規格及數量,商品數量將會是所有規格商品數量的總和。 否則,商品數量要在 0 - 9999999 之間。"""
|
|
32
|
+
unlimited_quantity: Optional[bool] = None
|
|
33
|
+
location_id: Optional[str] = None
|
|
34
|
+
sku: Optional[str] = None
|
|
35
|
+
category_ids: Optional[List[str]] = None
|
|
36
|
+
title_translations: Optional[Translatable] = None
|
|
37
|
+
summary_translations: Optional[Translatable] = None
|
|
38
|
+
description_translations: Optional[Translatable] = None
|
|
39
|
+
seo_title_translations: Optional[Translatable] = None
|
|
40
|
+
seo_description_translations: Optional[Translatable] = None
|
|
41
|
+
seo_keywords: Optional[str] = None
|
|
42
|
+
link: Optional[str] = None
|
|
43
|
+
is_preorder: Optional[bool] = None
|
|
44
|
+
preorder_limit: Optional[int] = None
|
|
45
|
+
preorder_note_translations: Optional[Translatable] = None
|
|
46
|
+
is_reminder_active: Optional[bool] = None
|
|
47
|
+
show_custom_related_products: Optional[bool] = None
|
|
48
|
+
related_product_ids: Optional[List[str]] = None
|
|
49
|
+
weight: Optional[float] = None
|
|
50
|
+
tags: Optional[str] = None
|
|
51
|
+
"""Tags 標籤 *Tags are used to search products at the admin panel and help set up the product-related coupons. 標籤功能用作商品搜尋,並能為指定商品設置優惠券的用途。"""
|
|
52
|
+
blacklisted_delivery_option_ids: Optional[List[str]] = None
|
|
53
|
+
blacklisted_payment_ids: Optional[List[str]] = None
|
|
54
|
+
max_order_quantity: Optional[int] = None
|
|
55
|
+
created_by: Optional[Literal['catcher', 'pos', 'sc']] = None
|
|
56
|
+
supplier_id: Optional[str] = None
|
|
57
|
+
available_start_time: Optional[str] = None
|
|
58
|
+
available_end_time: Optional[str] = None
|
|
59
|
+
schedule_publish_at: Optional[str] = None
|
|
60
|
+
tax_type: Optional[str] = None
|
|
61
|
+
"""Tax type 國內稅項"""
|
|
62
|
+
oversea_tax_type: Optional[str] = None
|
|
63
|
+
"""Oversea tax type 海外稅項"""
|
|
64
|
+
status: Optional[Literal['active', 'draft', 'removed', 'hidden']] = None
|
|
65
|
+
images: Optional[List[str]] = None
|
|
66
|
+
"""Product Main Photos. If the images field is null, the system will upload a default image. 商品主圖片,如images為空,將會帶入系統預設圖片"""
|
|
67
|
+
detail_images: Optional[List[str]] = None
|
|
68
|
+
"""Additional Product Photos 更多商品圖片"""
|
|
69
|
+
variant_options: Optional[List[Dict[str, Any]]] = None
|
|
70
|
+
variant_custom_type_translations: Optional[List[Dict[str, Any]]] = None
|
|
71
|
+
variations: Optional[List[ProductVariation]] = None
|
|
72
|
+
all_variations: Optional[bool] = None
|
|
73
|
+
"""Set if all combinations of variation options should be used or not. 設定是否需要使用所有商品規格選項的組合。 when "same_price" is set as "false", "all_variations" is not applicable. 當"same_price"被設定為false,"all_variations"不適用。"""
|
|
74
|
+
channel_id: Optional[str] = None
|
|
75
|
+
allow_gift: Optional[bool] = None
|
|
76
|
+
"""Specifies whether the item can be set as a gift. 是否可以設為贈品 true: the product can be set as a gift. false: the product cannot be set as a gift."""
|
|
77
|
+
|
|
78
|
+
class CreateProductBody(BaseModel):
|
|
79
|
+
"""Payload for creating product"""
|
|
80
|
+
ignore_product_media_errors: Optional[bool] = None
|
|
81
|
+
"""Do not raise error when failed to upload media 上傳圖像失敗時不報錯"""
|
|
82
|
+
default_show_image_selector: Optional[bool] = None
|
|
83
|
+
"""Show product variations image on product page 在產品頁面上顯示產品規格圖像"""
|
|
84
|
+
product: Optional[ProductConfig] = None
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateProductFeedSettingBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class CreateProductFeedSettingBody(BaseModel):
|
|
9
|
+
"""Payload for creating an product feed setting"""
|
|
10
|
+
kind: Literal['GOOGLE', 'MAJORITY']
|
|
11
|
+
"""The kind of the product feed setting product feed setting的類型"""
|
|
12
|
+
path: str
|
|
13
|
+
"""The url path of the product feed setting"""
|
|
14
|
+
unique_ids: Optional[bool] = None
|
|
15
|
+
"""是否要用系統 id 取代 sku"""
|
|
16
|
+
title: Optional[str] = None
|
|
17
|
+
"""The title of the product feed setting"""
|
|
18
|
+
total_product_count: Optional[float] = None
|
|
19
|
+
"""The total product count of the product feed setting"""
|
|
20
|
+
with_out_of_stock_product: Optional[bool] = None
|
|
21
|
+
"""Whether to include out of stock products"""
|
|
22
|
+
with_preorder_product: Optional[bool] = None
|
|
23
|
+
"""Whether to include preorder products"""
|
|
24
|
+
category_ids: Optional[List[str]] = None
|
|
25
|
+
"""The category ids of the product feed setting"""
|
|
26
|
+
main_product_image_select: Optional[float] = None
|
|
27
|
+
"""The main product image select of the product feed setting"""
|
|
28
|
+
variant_product_image_select: Optional[float] = None
|
|
29
|
+
"""The variant product image select of the product feed setting"""
|
|
30
|
+
locale: Optional[str] = None
|
|
31
|
+
"""The locale of the product feed setting"""
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateProductReviewCommentBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .product_review_comment import ProductReviewComment
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class CreateProductReviewCommentBody(BaseModel):
|
|
12
|
+
"""Payload for creating product review comment"""
|
|
13
|
+
product_id: Optional[str] = None
|
|
14
|
+
score: Optional[int] = None
|
|
15
|
+
comment: Optional[str] = None
|
|
16
|
+
user_id: Optional[str] = None
|
|
17
|
+
order_id: Optional[str] = None
|
|
18
|
+
status: Optional[str] = None
|
|
19
|
+
user_name: Optional[str] = None
|
|
20
|
+
media_ids: Optional[List[str]] = None
|
|
21
|
+
"""Array of media ids 媒體id陣列"""
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreateProductVariationBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .translatable import Translatable
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class CreateProductVariationBody(BaseModel):
|
|
12
|
+
"""Payload for creating product variation"""
|
|
13
|
+
pass
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"""Shopline API 数据模型 - CreatePromotionBody"""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List, Optional, Union
|
|
4
|
+
from pydantic import BaseModel, Field
|
|
5
|
+
from typing_extensions import Literal
|
|
6
|
+
|
|
7
|
+
# 导入相关模型
|
|
8
|
+
from .addon_product import AddonProduct
|
|
9
|
+
from .gift import Gift
|
|
10
|
+
from .money import Money
|
|
11
|
+
from .promotion import Promotion
|
|
12
|
+
from .promotion_condition import PromotionCondition
|
|
13
|
+
from .translatable import Translatable
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
class PromotionConfig(BaseModel):
|
|
18
|
+
"""Configuration model for promotion"""
|
|
19
|
+
discount_on: Optional[Literal['order', 'item', 'category']] = None
|
|
20
|
+
discount_type: Optional[Literal['percentage', 'amount', 'gift', 'addon', 'free_shipping', 'bundle_pricing', 'bundle_group', 'member_point_redeem_gift', 'subscription_gift']] = None
|
|
21
|
+
title_translations: Optional[Translatable] = None
|
|
22
|
+
discount_percentage: Optional[float] = None
|
|
23
|
+
discount_amount: Optional[Money] = None
|
|
24
|
+
conditions: Optional[List[Dict[str, Any]]] = None
|
|
25
|
+
requires_membership: Optional[bool] = None
|
|
26
|
+
whitelisted_membership_tier_ids: Optional[List[str]] = None
|
|
27
|
+
whitelisted_tag_contents: Optional[List[str]] = None
|
|
28
|
+
user_max_use_count: Optional[int] = None
|
|
29
|
+
codes: Optional[List[str]] = None
|
|
30
|
+
show_coupon: Optional[bool] = None
|
|
31
|
+
max_use_count: Optional[int] = None
|
|
32
|
+
start_at: Optional[str] = None
|
|
33
|
+
end_at: Optional[str] = None
|
|
34
|
+
whitelisted_delivery_option_ids: Optional[List[str]] = None
|
|
35
|
+
whitelisted_payment_ids: Optional[List[str]] = None
|
|
36
|
+
discountable_product_ids: Optional[List[str]] = None
|
|
37
|
+
discountable_category_ids: Optional[List[str]] = None
|
|
38
|
+
discountable_quantity: Optional[int] = None
|
|
39
|
+
for_affiliate_campaign: Optional[bool] = None
|
|
40
|
+
is_accumulated: Optional[bool] = None
|
|
41
|
+
first_purchase_only: Optional[bool] = None
|
|
42
|
+
first_purchase_all_platform: Optional[bool] = None
|
|
43
|
+
discounted_price: Optional[Money] = None
|
|
44
|
+
status: Optional[Literal['active', 'draft', 'hidden']] = None
|
|
45
|
+
available_platforms: Optional[List[str]] = None
|
|
46
|
+
available_channel_ids: Optional[List[str]] = None
|
|
47
|
+
coupon_type: Optional[Literal['draw']] = None
|
|
48
|
+
benefit_tiers: Optional[List[Dict[str, Any]]] = None
|
|
49
|
+
addon_products: Optional[List[Dict[str, Any]]] = None
|
|
50
|
+
banner_media_ids: Optional[List[str]] = None
|
|
51
|
+
term_translations: Optional[Translatable] = None
|
|
52
|
+
gifts: Optional[List[Dict[str, Any]]] = None
|
|
53
|
+
|
|
54
|
+
class CreatePromotionBody(BaseModel):
|
|
55
|
+
"""Payload for creating promotion"""
|
|
56
|
+
promotion: Optional[PromotionConfig] = None
|