---
title: "Search Products"
method: POST
path: "/products/search"
tags: ["Products"]
---

# Search Products

`POST /products/search`

To search products with specific conditions.<br>利用特殊條件搜尋商品列表。

## Request body

- object
  - `page` integer — Page Number<br>頁數（第n頁）
  - `per_page` integer — 每頁顯示 n 筆資料，建議最多 50 筆<br>If there're many products, set per_page to 50
  - `query` string — 支援 product_name、sku、barcode 的模糊查詢
  - `id` string — 商品 ID，支援等於、不等於、in 多筆查詢
  - `category_id` string — 商品分類 ID，支援以逗號分隔多筆
  - `status` 'active' | 'draft' | 'removed' | 'hidden' — 商品狀態
  - `sort_type` 'created_at' | 'lowest_price' | 'quantity_sold' | 'custom_sorting' — 排序類型，預設為 created_at
  - `sort_by` 'asc' | 'desc' — 排序方向，預設為 desc。當 sort_type 為 quantity_sold 時只能為 desc。
  - `sku` string — 商品貨號，支援等於、不等於、in 多筆查詢
  - `barcode` string — 條碼，支援等於、不等於、in 多筆查詢
  - `is_preorder` boolean — 是否為預購商品
  - `quantity` string — 規格數量，支援 lt/lte/gt/gte/not 等查詢
  - `variation_quantity` string — Variation 數量查詢條件，語法同 quantity
  - `unlimited_quantity` boolean — 是否為無限數量
  - `created_at` string — 建立時間，支援比較運算子（gt/gte/lt/lte）
  - `updated_at` string — 更新時間，支援比較運算子
  - `title_translations` string — 標題關鍵字（多語系）
  - `summary_translations` string — 摘要關鍵字（多語系）
  - `tags` string — 標籤關鍵字
  - `excludes` string[] — 要排除的欄位
  - `fields` string[] — 僅顯示的欄位
  - `include_fields` string[] — 要額外包含的欄位
  - `retail_status` 'active' | 'draft' — POS 商品上架狀態
  - `with_product_set` boolean — 是否包含組合商品
  - `purchasable` boolean — 是否可購買
  - `root_product` boolean — 是否為 Root Product 查詢模式（僅看 supplier_id 和 pos_category_id）
  - `supplier_id` string — 供應商 ID（root_product 為 true 時使用）
  - `pos_category_id` string — POS 分類 ID（root_product 為 true 時使用）
  - `type` string — 商品類型（如 product_set）
  - `previous_id` string — 上一頁最後一筆的 ID（用於 cursor-based 分頁）
  - `allow_gift` boolean — 是否允許作為贈品

## Response `200`

OK

- object
  - `items` Product[]
    - `id` string — Product's ID<br>商品ID
    - `status` 'active' | 'draft' | 'removed' | 'hidden' — Product's status<br>商品狀態<br>-<br>true: Published 上架<br> false: Unpublished 下架<br>"active": Published 上架<br>"draft": Unpublished 下架<br> "hidden": hidden 隱藏<br><br>Default: false
    - `retail_status` 'active' | 'draft' — POS product's status<br>POS商品狀態<br>-<br> "active": Published 上架<br> "draft": Unpublished 下架<br><br> Default: active
    - `title_translations` object — Title translations<br>商品名稱
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `summary_translations` object — Summary translations<br>商品說明
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `price` object — Price<br>原價格
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `price_sale` object — Price on sale<br>特價
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `lowest_price` object — The lowest price of product variations if exists<br>規格商品中的最低價
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `lowest_price_sale` object — The lowest sale price of product variations if exists<br>特價規格商品中的最低價
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `hide_price` boolean — Hide Price to customers<br>隱藏價格<br>-<br>*Default: false
    - `same_price` boolean — Main Product and Variation Product share the same price (Including original price and member price) <br>規格商品是否皆同主商品價格，包含原價格與會員價<br> 1. If same price is true, main product price is required and will be apply to all variation prices<br> 2. If same price is false, variation price is required and each variation can apply different prices.
    - `cost` object — Cost<br>成本價
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `member_price` object — Member Price<br>會員價
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `retail_price` object — Retail Price<br>零售價<br> Only provided when include_fields contains 'retail_price'<br> 僅於include_fields傳入 'retail_price' 時提供
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `flash_price_sets` object[] — price for flash campaign<br>限時促銷價
      - `id` string
      - `start_at` string
      - `end_at` string
      - `price_set` object
        - `id` string
        - `type` string
        - `flash_price_campaign_id` string
        - `price` object — price
          - `cents` integer
          - `currency_symbol` string
          - `currency_iso` string
          - `label` string
          - `dollars` number
        - `price_sale` object — price_sale
          - `cents` integer
          - `currency_symbol` string
          - `currency_iso` string
          - `label` string
          - `dollars` number
        - `price_details` object[]
          - `variation_key` string
          - `price` object — price
            - `cents` integer
            - `currency_symbol` string
            - `currency_iso` string
            - `label` string
            - `dollars` number
          - `price_sale` object — price_sale
            - `cents` integer
            - `currency_symbol` string
            - `currency_iso` string
            - `label` string
            - `dollars` number
        - `created_at` string
        - `updated_at` string
      - `created_at` string
      - `updated_at` string
    - `is_preorder` boolean — Pre-ordered or not<br>是否開放預購
    - `preorder_limit` integer — Pre-ordere Limit<br>預購上限
    - `preorder_note_translations` object — Title translations<br>商品名稱
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `weight` number — Product's Weight (kg)<br>商品重量 (公斤)
    - `quantity` number — Product's Current quantity<br>商品目前數量<br>-<br> *If unlimited_quantity is true, the product has unlimited quantity<br> regardless of the quantity showing here
    - `total_orderable_quantity` number — Product's Current total orderable quantity<br>商品目前可購買總數量<br>-<br> *If unlimited_quantity is true or out_of_stock_orderable is true<br> this field will return -1
    - `unlimited_quantity` true | false — Unlimited product quantity or not.<br>商品數量是否無限
    - `medias` Media[] — Media Data<br>媒體(照片)資訊
      - `id` string — Media ID
      - `alt_translations` object — Content to display on ALT attribute<br>在圖片ALT上展示的內容
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `images` object — Object contains url of image in different dimensions<br>包含不同大小圖片的連絡
    - `detail_medias` Media[] — Additional Product Photos<br>更多商品圖片<br>Maximum 20 images for a product.<br>最多 20 張圖片
      - `id` string — Media ID
      - `alt_translations` object — Content to display on ALT attribute<br>在圖片ALT上展示的內容
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `images` object — Object contains url of image in different dimensions<br>包含不同大小圖片的連絡
    - `category_ids` string[] — Categories' IDs<br>商品所屬分類之ID
    - `supplier` string — Supplier<br>供應商
    - `sku` string — Stock Keeping Unit<br>商品貨號
    - `barcode` string — Product's Barcode<br>商品條碼編號
    - `quantity_sold` integer — Product's Quantity Sold<br>商品銷售數量
    - `barcode_type` 'Code 128' | 'Bookland EAN' | 'ISBN' — Barcode type<br>商品條碼編號類別
    - `field_titles` object[] — Field Title Data<br>規格名稱
      - `key` string
      - `label` string
      - `name_translations` Translatable
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `selectorEnabled` boolean
    - `variations` ProductVariation[] — Product Variations Data<br>商品規格資訊
      - `id` string — Product Variation's ID<br>規格 ID
      - `fields_translations` object — Field Translation<br>規格名稱
        - `en` string[] — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string[] — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string[] — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string[] — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string[] — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string[] — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string[] — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string[] — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string[] — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string[] — Merchant defined France name<br>店家定義法文名稱
      - `price` object — Price<br>原價格
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `price_sale` object — Price on sale<br>特價
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `member_price` object — Member Price<br>會員價
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `retail_price` object — Retail Price<br>零售價<br> Only provided when include_fields contains 'retail_price'<br> 僅於include_fields傳入 'retail_price' 時提供
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `cost` object — Cost<br>成本價
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `quantity` number — Product variation's current quantity<br>規格現有數量
      - `total_orderable_quantity` number — Product variation's current orderable quantity<br>規格現有可購買數量
      - `unlimited_quantity` boolean — Whether the variation has unlimited quantity or not.<br>規格是否有無限數量<br>*Please check the main product's unlimited_quantity to see whether variation has unlimited quantity or not.<br><br>unlimited_quantity of variation will always shows null
      - `preorder_limit` integer — Pre-ordere Limit<br>預購上限
      - `media` object — Media Data<br>圖片資料
        - `id` string — Media ID
        - `alt_translations` object — Content to display on ALT attribute<br>在圖片ALT上展示的內容
          - `en` string — Merchant defined English name<br>店家定義英文名稱
          - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
          - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
          - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
          - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
          - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
          - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
          - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
          - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
          - `fr` string — Merchant defined France name<br>店家定義法文名稱
        - `images` object — Object contains url of image in different dimensions<br>包含不同大小圖片的連絡
      - `sku` string — Stock Keeping Unit<br>貨號
      - `location_id` string — Location ID<br>儲位編號
      - `feed_variations` object — Default variations for product feed<br>廣告規格<br> 當商品為多規格並且規格中有設置color、size時，此时color、size為json。<br> 當商品規格中未設置color、size，但商家有在產品規格摘要頁麵填冩color、size時，此時color、size爲純字串<br>
        - `color` object
        - `size` object
        - `material` string
      - `variant_option_ids` string[] — ID of the corresponding variant options<br>對應規格類別 ID
      - `barcode` string — Barcode<br>商品條碼編號
      - `mpn` string — Manufacturer Part Number<br>製造編號
      - `gtin` string — Barcode<br>商品條碼編號
      - `barcode_type` 'Code 128' | 'Bookland EAN' | 'ISBN' — Barcode type<br>商品條碼編號類別
      - `locked_inventory_count` number
      - `weight` number — Weight (kg)<br>重量 (公斤)
    - `variant_options` object[] — Product Variations<br>商品規格<br>-<br> Maximum 3 types of variant option for a product, type allow (color, size, custom_1, custom_2, custom_3)<br> 最多支援三種不同的 type, type 支援(color, size, custom_1, custom_2, custom_3)<br>
      - `id` string
      - `name_translations` Translatable
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `type` 'color' | 'size' | 'custom_1' | 'custom_2' | 'custom_3'
      - `media` object
      - `index` integer
    - `location_id` string — Stock Unit Number<br>儲位編號
    - `feed_category` object — Category for different feed<br>廣告的分類
      - `google_category_id` string
      - `google_option_id` string
      - `google_product_category` string
    - `feed_variations` object — Feed Variations<br>產品資訊 - 顏色、尺寸、材質
      - `color` string — Color<br>產品資訊 - 顏色
      - `size` string — Size<br>產品資訊 - 尺寸
      - `material` string — Material<br>產品資訊 - 材質
    - `description_translations` object — Title translations<br>商品名稱
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `seo_title_translations` object — Title translations<br>商品名稱
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `seo_description_translations` object — Title translations<br>商品名稱
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `seo_keywords` string — Keywords of SEO<br>SEO關鍵字<br> *Keywords should be separated by commas (,) max length 160 characters.<br> 關鍵字以逗號(,)分隔, 最長 160字
    - `link` string
    - `is_reminder_active` boolean — Out-Of-Stock Reminder<br>商品缺貨是否提醒
    - `show_custom_related_products` true | false — Show Custom Related products<br>顯示相關商品
    - `related_product_ids` string[] — Custom related products<br>自訂相關商品
    - `tags` string[] — Tags<br>標籤<br> *Tags are used to search products at the admin panel and help set up the product-related coupons.<br> 標籤功能用作商品搜尋，並能為指定商品設置優惠券的用途。
    - `blacklisted_delivery_option_ids` string[] — Excluded Delivery Options<br>排除的送貨方式
    - `blacklisted_payment_ids` string[] — Excluded Payment<br>Options<br>排除的付款方式
    - `max_order_quantity` integer — set maximum quantity per purchase for this product<br> 商品單次購買上限<br> *-1 represents there's no quantity limit for each purchase<br> -1代表無商品單次購買的上限
    - `gender` string — Mapping Product Category: Gender<br>產品使用類別：性別<br> male 男性<br> female 女性<br>* unisex 男女通用
    - `age_group` string — Mapping Product Category:Age Group<br>產品使用類別：年齡層<br> newborn 新生兒<br> infant 嬰兒<br> toddler 幼兒<br> kids兒童<br>* Adult 成人
    - `adult` string — Mapping Product Category:Adult<br>產品使用類別：成人<br> yes 是<br> no 否
    - `condition` string — Mapping Product Category:Condition<br>產品使用類別：狀況<br> used 二手<br> refurbished 整新品<br>* new 新品
    - `brand` string — Brand<br>商品品牌
    - `mpn` string — Manufacturer Part Number<br>製造編號
    - `gtin` string — Barcode<br>商品條碼編號
    - `blacklisted_feed_channels` string[] — 排除這個商品投放管道<br>Exclude this product to channel
    - `updated_at` string — Last Updated Time<br>商品最後更新時間
    - `created_at` string — Product Created Time<br>商品創建時間
    - `available_start_time` string
    - `available_end_time` string
    - `created_by` string
    - `is_excluded_promotion` boolean — product is exclude promotion which is discount on order<br>不適用全店折扣的優惠是否開啟
    - `taxable` boolean — taxable<br>是否收稅
    - `labels` Translatable[] — product labels<br>標簽的商品促銷標簽文案
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `locked_inventory_count` number
    - `schedule_publish_at` string
    - `product_price_tiers` ProductPriceTier[] — Product's price for member tier. <br> 適用於指定會員分級的產品價格。
      - `_id` string — Product price tier's ID<br>產品價格分級的ID
      - `created_at` string — Product price tier's created time<br>產品價格分級的創建時間
      - `updated_at` string — Product price tier's updated time<br>產品價格分級的更新時間
      - `member_price` object — The price that is applied to this member tier<br>適用於這會員分級的價格
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `membership_tier_id` string — Membership tier's ID<br>會員等級ID
      - `product_id` string — Product's ID<br>商品ID
      - `status` 'active' — Product price tier's status<br>產品價格分級的狀態
      - `variation_key` string — Product variation's ID<br>產品規格的ID
    - `metafields` object — metafields<br>only show if include_fields[]=metafields
    - `out_of_stock_orderable` boolean — out_of_stock_orderable<br>缺貨時是否可接單
    - `subscription_enabled` boolean — subscription_enabled<br>是否為定期購商品。
    - `subscription_period_duration` integer — subscription_period_duration<br>定期購天數
    - `subscription_recurring_count_limit` integer — Subscription recurring count limit<br>定期購期數
    - `filter_tags` FilterTag[] — filter_tags<br>自訂篩選條件
      - `id` string — Filter Tag's ID<br>自訂篩選條件 ID
      - `name_translations` object — Name Translation<br>自訂篩選名稱
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `bundle_set` object — bundle_set info<br>組合商品資訊<br> Only provided when include_fields contains 'bundle_set'<br> 僅於include_fields傳入 'bundle_set' 時提供
      - `_id` string
      - `price_type` 'fixed_amount discount_percentage discount_amount' — Price Type<br>組合售價類型
      - `discount_value` number — Discount Value<br>金額折扣<br> When price_type is 'fixed_amount', example: 20 means price_sale $20<br> If discount_value is null, its value is taken from the price_sale<br> 當組合售價類型是固定組合價時，20代表组合售價为 $20. 如果該值為空, 金額折扣值取自特價<br> When price_type is 'discount_percentage', example: 20 for 80% off; 70 for 30% off<br> 當組合售價類型是折扣比例時，20代表八折; 70代表三折<br> When price_type is 'discount_amount', example: 20 means minus $20; 70 means minus $70<br> 當組合售價類型是金額折扣時，20代表減$20; 70代表減$70
      - `bundle_set_products` object
    - `type` string — product type<br>商品型別<br> Only provided when include_fields contains 'type'<br> 僅於include_fields傳入 'type' 時提供
    - `tax_type` string — Tax type<br>國內稅項
    - `oversea_tax_type` string — Oversea tax type<br>海外稅項
    - `allow_gift` boolean — Specifies whether the item can be set as a gift.<br> 是否可以設為贈品<br> true: the product can be set as a gift.<br> false: the product cannot be set as a gift.
    - `is_custom` boolean — Specifies whether the item can be set as a customized product.<br>是否可以設為訂制商品<br> true: the product is custom product.<br> false: the product isn't custom product.
    - `sold_out` boolean — Indicates whether the product is sold out.<br> 商品是否售罄.<br> true: the product is sold out. 已售罄<br> false: the product is still available. 尚有庫存<br>
    - `cart_tag_id` string — Product Attribute ID<br>商品屬性設置 id<br> This field is unavailable when you get a product detail<br> 取得商品詳細資訊時不提供
    - `cart_tag` object — Product Attribute<br>商品屬性設置<br> This field is only available when you get a product detail<br> 僅於取得商品詳細資訊時提供

## Other responses

- `500` — Server error

---

[API](https://skmtc.net/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.net/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/versions/1675ac12cde7/schema)
