--- title: "Search Gifts" method: GET path: "/gifts/search" tags: ["Gifts"] --- # Search Gifts `GET /gifts/search` To search gifts with specific conditions.
利用特殊條件搜尋贈品列表。 ## Query parameters - `previous_id` string - `id` string - `page` integer - `per_page` integer - `status` 'active' | 'draft' - `sort_by` 'desc' | 'asc' - `sku` string - `quantity` string - `updated_at` string - `created_at` string ## Response `200` OK - object - `items` Gift[] - `id` string — Gift ID
贈品ID - `status` 'active' | 'draft' — Gift's Status
贈品狀態 - `title_translations` object — Title Translations
贈品名稱 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `sku` string — Stock Keeping Unit
贈品貨號 - `quantity` number — Current Quantity
贈品目前庫存 - `cost` object — Cost of Gift
贈品成本 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `weight` number — Weight of Gift (kg)
贈品重量 (公斤重) - `medias` object — Media Data
媒體(照片)資訊 - `id` string — Media ID - `alt_translations` object — Content to display on ALT attribute
在圖片ALT上展示的內容 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `images` object — Object contains url of image in different dimensions
包含不同大小圖片的連絡 - `unlimited_quantity` boolean — Unlimited gift quantity or not.
贈品數量是否無限 - `updated_at` string — Updated Time
贈品更新時間 - `created_at` string — Created Time
贈品創造時間 - `variations` ProductVariation[] — Product Variations Data
商品規格資訊 - `id` string — Product Variation's ID
規格 ID - `fields_translations` object — Field Translation
規格名稱 - `en` string[] — Merchant defined English name
店家定義英文名稱 - `zh-hant` string[] — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string[] — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string[] — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string[] — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string[] — Merchant defined Japanese name
店家定義日文名稱 - `th` string[] — Merchant defined Thai name
店家定義泰文名稱 - `id` string[] — Merchant defined Indian name
店家定義印度文名稱 - `de` string[] — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string[] — Merchant defined France name
店家定義法文名稱 - `price` object — Price
原價格 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `price_sale` object — Price on sale
特價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `member_price` object — Member Price
會員價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `retail_price` object — Retail Price
零售價
Only provided when include_fields contains 'retail_price'
僅於include_fields傳入 'retail_price' 時提供 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `cost` object — Cost
成本價 - `cents` integer - `currency_symbol` string - `currency_iso` string - `label` string - `dollars` number - `quantity` number — Product variation's current quantity
規格現有數量 - `total_orderable_quantity` number — Product variation's current orderable quantity
規格現有可購買數量 - `unlimited_quantity` boolean — Whether the variation has unlimited quantity or not.
規格是否有無限數量
*Please check the main product's unlimited_quantity to see whether variation has unlimited quantity or not.

unlimited_quantity of variation will always shows null - `preorder_limit` integer — Pre-ordere Limit
預購上限 - `media` object — Media Data
圖片資料 - `id` string — Media ID - `alt_translations` object — Content to display on ALT attribute
在圖片ALT上展示的內容 - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `images` object — Object contains url of image in different dimensions
包含不同大小圖片的連絡 - `sku` string — Stock Keeping Unit
貨號 - `location_id` string — Location ID
儲位編號 - `feed_variations` object — Default variations for product feed
廣告規格
當商品為多規格並且規格中有設置color、size時，此时color、size為json。
當商品規格中未設置color、size，但商家有在產品規格摘要頁麵填冩color、size時，此時color、size爲純字串
- `color` object - `size` object - `material` string - `variant_option_ids` string[] — ID of the corresponding variant options
對應規格類別 ID - `barcode` string — Barcode
商品條碼編號 - `mpn` string — Manufacturer Part Number
製造編號 - `gtin` string — Barcode
商品條碼編號 - `barcode_type` 'Code 128' | 'Bookland EAN' | 'ISBN' — Barcode type
商品條碼編號類別 - `locked_inventory_count` number - `weight` number — Weight (kg)
重量 (公斤) - `field_titles` object[] — Field Title Data
規格名稱 - `key` string - `label` string - `name_translations` Translatable - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `variant_options` object[] — Product Variations
商品規格
-
Maximum 3 types of variant option for a product, type allow (color, size, custom_1, custom_2, custom_3)
最多支援三種不同的 type, type 支援(color, size, custom_1, custom_2, custom_3)
- `id` string - `name_translations` Translatable - `en` string — Merchant defined English name
店家定義英文名稱 - `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱 - `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱 - `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱 - `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱 - `ja` string — Merchant defined Japanese name
店家定義日文名稱 - `th` string — Merchant defined Thai name
店家定義泰文名稱 - `id` string — Merchant defined Indian name
店家定義印度文名稱 - `de` string — Merchant defined Deutsch name
店家定義德文名稱 - `fr` string — Merchant defined France name
店家定義法文名稱 - `type` 'color' | 'size' | 'custom_1' | 'custom_2' | 'custom_3' - `media` object - `index` integer - `pagination` Paginatable - `current_page` integer — The current page number
當前分頁 - `per_page` integer — Number of result per page
每頁顯示 n 筆資料
(Default: 24) - `total_count` integer — Number of result in total
資料總量 - `total_pages` integer — Number of pages in total
總頁數量 ## Other responses - `422` — Unprocessable entity error - `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/revisions/1675ac12cde7/schema)