v1
latestOpenAPI 3.0.02026-07-26318168886.7 KBSearch Products
To search products with specific conditions.<br>利用特殊條件搜尋商品列表。
Query parameters
The last ID of the products in the previous request.<br>前一筆商品的 ID <br>beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口
Page Number<br>頁數（第n頁）
Numbers of Products per page<br>每頁顯示 n 筆資料<br> *If there're many products, it's suggested to set per_page number to 50<br> 如果商品眾多，建議per_page至多設定50
Support query order fields<br>支援搜尋以下欄位<br>product_name<br>sku<br>barcode
Product's ID<br>商品ID<br>Support equal, not equal and multiple search.<br>支援 等於，不等於及多重搜尋
Categories<br>分類<br>*Accept category ids spilt by ","<br>接受同時數個分類id，以","隔開
Status<br>商品狀態
Sort type. Default value is created_at.
Sort order by sort_type. Default value is desc.<br> When sort_type is 'quantity_sold', only 'desc' is allowed.
sku<br>商品貨號<br>Support equal, not equal and multiple search.<br>支援 等於，不等於及多重搜尋
gtin<br>商品條碼編號<br>Support equal, not equal and multiple search.<br>支援 等於，不等於及多重搜尋
Is Preorder Product or not<br>是否為預購商品
Quantity of Variation<br>規格數量<br> Support equal or not equal or less than or less than or equal or greater than or greater than or equal<br> 支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
Quantity of Variation<br>規格數量<br> Support equal or not equal or less than or less than or equal or greater than or greater than or equal<br> 支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
Is Unlimited Quantity or not<br>是否為無限數量
Support equal or not equal or less than or less than or equal or greater than or greater than or equal<br>支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
Support equal or not equal or less than or less than or equal or greater than or greater than or equal<br>支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
Could search any match for all languages that merchant supported,<br>可以搜出店家支援語系中的任何語系關鍵字
Could search any match for all languages that merchant supported,<br>可以搜出店家支援語系中的任何語系關鍵字
Product Tag<br>產品標籤
Could exclude certain parameters in the response<br>結果要排除哪些參數
Could only show certain parameters in the response<br>結果只顯示哪些參數
Provide additional attributes in the response<br>結果添加哪些參數
POS Status<br>POS商品上架狀態
Search with Product Set<br>是否包含組合商品
Is Purchasable Set<br>是否可購買
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.
Specify sorting rules. Supports up to two levels of sorting.<br> When sort by, order by, and sorts are requested, sorts takes priority.<br> 用於設定資料的排序方式，支援最多兩層排序。sold_out 僅能是第一順位的排序依據<br> 當同時傳入 sort by、order by、sorts 時，系統會優先使用 sorts 的設定<br>
Response
OK
Example response
{
"items": [
{
"id": "5d3594c276e7ec003b7021c0",
"status": "active",
"retail_status": "active",
"title_translations": {
"en": "testing SL-8049",
"zh-hant": "測試 SL-8049 round 2"
},
"summary_translations": {
"en": "testing SL-8049",
"zh-hant": "測試 SL-8049 round 2"
},
"price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"price_sale": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"lowest_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"lowest_price_sale": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"same_price": true,
"cost": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"member_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"retail_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"flash_price_sets": [
{
"price_set": {
"price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"price_sale": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"price_details": [
{
"price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"price_sale": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
}
}
]
}
}
],
"preorder_limit": 1,
"preorder_note_translations": {
"en": "Shipping starts April 20th, 1971, preorder NOW!",
"zh-hant": "1971/04/20 開始出貨, 立即訂購!"
},
"weight": 123.99,
"quantity": 87,
"total_orderable_quantity": 87,
"medias": [
{
"id": "5f8e5dc08a8bb70a5c9cd93c",
"alt_translations": {
"en": "Image ALT",
"zh-hant": "圖片ALT"
},
"images": {
"original": {
"width": 800,
"height": 800,
"url": "https://img.example.com/media/1234/thumb.jpg"
}
}
}
],
"detail_medias": [
{
"id": "5f8e5dc08a8bb70a5c9cd93c",
"alt_translations": {
"en": "Image ALT",
"zh-hant": "圖片ALT"
},
"images": {
"original": {
"width": 800,
"height": 800,
"url": "https://img.example.com/media/1234/thumb.jpg"
}
}
}
],
"category_ids": [
"5be90603d1270b4032bed8b4"
],
"sku": "sku_123345",
"field_titles": [
{
"key": "color",
"label": "Color",
"name_translations": {
"en": "Color",
"zh-hant": "顏色"
},
"selectorEnabled": false
},
{
"key": "custom",
"label": "Custom",
"name_translations": {
"en": "Custom1",
"zh-hant": "自訂1"
},
"selectorEnabled": false
}
],
"variations": [
{
"id": "5d3594c2e95d2f000642e011",
"price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"price_sale": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"member_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"retail_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"cost": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"quantity": 100,
"total_orderable_quantity": 100,
"preorder_limit": 1,
"media": {
"id": "5f8e5dc08a8bb70a5c9cd93c",
"alt_translations": {
"en": "Image ALT",
"zh-hant": "圖片ALT"
},
"images": {
"original": {
"width": 800,
"height": 800,
"url": "https://img.example.com/media/1234/thumb.jpg"
}
}
},
"sku": "green_l1",
"location_id": "LaB123",
"feed_variations": {
"color": {
"zh-hant": "紅色",
"en": "red"
},
"size": {
"zh-hant": "xs",
"en": "xs"
}
},
"variant_option_ids": [
"5d3594c2622a56618082c99f",
"5d3594c2622a56618082c9a0"
],
"locked_inventory_count": 10,
"weight": 1.2
}
],
"variant_options": [
{
"id": "5d3594c2622a56618082c99f",
"name_translations": {
"en": "green",
"zh-hant": "綠"
},
"type": "custom",
"media": {},
"index": 0
},
{
"id": "5d3594c2622a56618082c9a0",
"name_translations": {
"en": "L1",
"zh-hant": "大1"
},
"type": "custom",
"media": {},
"index": 1
},
{
"id": "5d3594c2622a56618082c9a1",
"name_translations": {
"en": "S1",
"zh-hant": "小1"
},
"type": "custom",
"media": {},
"index": 1
},
{
"id": "5d3594c2622a56618082c9a2",
"name_translations": {
"en": "Red",
"zh-hant": "紅"
},
"type": "custom",
"media": {},
"index": 0
}
],
"location_id": "shoplineabc",
"feed_category": {
"google_category_id": "animals_pet_supplies",
"google_option_id": "live_animals",
"google_product_category": "Animals & Pet Supplies > Live Animals"
},
"feed_variations": {
"color": "red",
"size": "small",
"material": "gold"
},
"seo_keywords": "電商, 開店, 創業",
"related_product_ids": [
"5d3593cd5722660032e8fbed",
"5d355b7b0e5da9001741ac2c"
],
"max_order_quantity": 4,
"blacklisted_feed_channels": [
"google"
],
"updated_at": "2020-12-09T07:15:06.813+00:00",
"created_at": "2020-11-23T02:31:32.926+00:00",
"created_by": "openapi",
"is_excluded_promotion": true,
"taxable": true,
"labels": [
{
"en": "ABC",
"zh-hant": "ddd"
}
],
"locked_inventory_count": 10,
"schedule_publish_at": "2020-11-23T02:31:32.926+00:00",
"product_price_tiers": [
{
"_id": "610cdc702c1c120047c3519c",
"created_at": "2021-08-06T06:55:45.471Z",
"updated_at": "2021-08-06T06:55:45.471Z",
"member_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"membership_tier_id": "5de6192b9a8b7900365abb5b",
"product_id": "5d3594c276e7ec003b7021c0",
"status": "active",
"variation_key": "610cdcf19f09bc003a2139a4"
}
],
"metafields": {
"namespace": {
"key1": "value",
"key2": 3,
"key3": {
"json": "object"
}
}
},
"subscription_enabled": true,
"subscription_period_duration": 30,
"subscription_recurring_count_limit": 5,
"filter_tags": [
{
"id": "5d3594c2e95d2f000642e011"
}
],
"bundle_set": {
"price_type": "fixed_amount",
"discount_value": 20,
"bundle_set_products": {
"6200c988dcf97a004b22ec26": {
"min_quantity": 1
}
}
},
"type": "product",
"allow_gift": true,
"is_custom": true,
"sold_out": true,
"cart_tag_id": "63ec73c11ac51b368c74b92b",
"cart_tag": {
"id": "63ec73c11ac51b368c74b92b",
"name_translations": {
"en": "",
"zh-hant": "一車常溫"
},
"priority": 1
}
}
]
}