---
updatedAt: 2026-05-27T07:01:03.000Z
agentTools:
  projectIndex: https://open-api.docs.shoplineapp.com/llms.txt
---

# Get Flash Price Campaigns

To retrieve flash price campaign list<br>獲取商品限時促銷價活動列表

# OpenAPI definition

```json
{
  "info": {
    "title": "SHOPLINE Open API",
    "version": "2.348.2",
    "description": "Welcome to the shopline open-api developer hub. You'll find comprehensive guides and documentation to help you start working with shopline open-api as quickly as possible, as well as support if you get stuck. Let's jump right in!"
  },
  "servers": [
    {
      "url": "https://open.shopline.io/v1",
      "description": "Production"
    }
  ],
  "openapi": "3.0.0",
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "Translatable": {
        "type": "object",
        "properties": {
          "en": {
            "type": "string",
            "description": "Merchant defined English name<br>店家定義英文名稱"
          },
          "zh-hant": {
            "type": "string",
            "description": "Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱"
          },
          "zh-cn": {
            "type": "string",
            "description": "Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱"
          },
          "vi": {
            "type": "string",
            "description": "Merchant defined Vietnamese name<br>店家定義越南文名稱"
          },
          "ms": {
            "type": "string",
            "description": "Merchant defined Malaysian name<br>店家定義馬來西亞文名稱"
          },
          "ja": {
            "type": "string",
            "description": "Merchant defined Japanese name<br>店家定義日文名稱"
          },
          "th": {
            "type": "string",
            "description": "Merchant defined Thai name<br>店家定義泰文名稱"
          },
          "id": {
            "type": "string",
            "description": "Merchant defined Indian name<br>店家定義印度文名稱"
          },
          "de": {
            "type": "string",
            "description": "Merchant defined Deutsch name<br>店家定義德文名稱"
          },
          "fr": {
            "type": "string",
            "description": "Merchant defined France name<br>店家定義法文名稱"
          }
        }
      },
      "Money": {
        "type": "object",
        "properties": {
          "cents": {
            "type": "integer"
          },
          "currency_symbol": {
            "type": "string"
          },
          "currency_iso": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "dollars": {
            "type": "number"
          }
        },
        "example": {
          "cents": 999999999,
          "currency_symbol": "NT$",
          "currency_iso": "TWD",
          "label": "NT$999,999,999",
          "dollars": 999999999
        }
      },
      "FlashPriceCampaign": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Flash price campaign‘s ID<br>商品限時促銷價活動ID",
            "type": "string",
            "example": "5892d8679f9a4fc07b008295"
          },
          "title": {
            "description": "Flash price campaign's title<br>商品限時促銷價活動名稱",
            "type": "string",
            "example": "Summer flash sale 2021!"
          },
          "start_at": {
            "description": "The start time of the event<br>商品限時促銷價活動開始時間",
            "type": "string",
            "example": "2021-08-19T18:00:00.000Z"
          },
          "end_at": {
            "description": "The end time of the event<br>商品限時促銷價活動結束時間",
            "type": "string",
            "example": "2021-08-21T15:30:00.000Z"
          },
          "merchant_id": {
            "description": "Merchant ID<br>商户ID",
            "type": "string",
            "example": "611cd8ade0f510001e130048"
          },
          "product_ids": {
            "description": "The ids of the products which will be presented in this flash price campaign<br> 是次商品限時促銷價活動所包括的商品id",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "price_sets": {
            "description": "The product price sets of this flash price campaigns.<br> 商品限時促銷價活動的商品限時價格。<br> Presented in GET/flash_price_campaigns{id}, POST/flash_price_campaigns, PUT/flash_price_campaigns{id} but not in GET/flash_price_campaigns.<br> 會於 GET/flash_price_campaigns{id}及POST/flash_price_campaigns及 PUT/flash_price_campaigns{id}出現， 但不於 POST/flash_price_campaigns出現。",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "The id of the price set<br>商品價格組的ID",
                  "type": "string",
                  "example": "610258858c5acd00452fcf8d"
                },
                "price": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Money"
                    },
                    {
                      "description": "The price of the product when the event is started<br>商品限時促銷價活動的商品限時價格"
                    }
                  ]
                },
                "price_sale": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Money"
                    },
                    {
                      "description": "The price sale of the product when the event is started<br>商品限時促銷價活動的商品限時促銷價格"
                    }
                  ]
                },
                "product": {
                  "description": "The product that applied this price set<br>商品限時促銷價活動的商品",
                  "type": "object",
                  "properties": {
                    "title_translations": {
                      "$ref": "#/components/schemas/Product/properties/title_translations"
                    },
                    "price": {
                      "allOf": [
                        {
                          "$ref": "#/components/schemas/Money"
                        }
                      ]
                    },
                    "price_sale": {
                      "allOf": [
                        {
                          "$ref": "#/components/schemas/Money"
                        }
                      ]
                    },
                    "same_price": {
                      "$ref": "#/components/schemas/Product/properties/same_price"
                    },
                    "media_thumb_url": {
                      "type": "string",
                      "example": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/60c9cc630053cc00462aad34/original.jpg?1623837795"
                    }
                  }
                },
                "price_details": {
                  "description": "The price sets of the variations of the product of this event<br>商品限時促銷價活動的商品規格價錢組",
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "variation_key": {
                        "description": "The id of the variation product<br>商品限時促銷價活動的商品規格ID",
                        "type": "string",
                        "example": "610258858c5acd00452fcf8d"
                      },
                      "price": {
                        "allOf": [
                          {
                            "$ref": "#/components/schemas/Money"
                          },
                          {
                            "description": "The price of the product variation when the event is started <br>商品限時促銷價活動的商品規格限時價格"
                          }
                        ]
                      },
                      "price_sale": {
                        "allOf": [
                          {
                            "$ref": "#/components/schemas/Money"
                          },
                          {
                            "description": "The price sale of the product variation when the event is started <br>商品限時促銷價活動的商品規格限時促銷價格"
                          }
                        ]
                      },
                      "variation": {
                        "description": "The product variation that applied this price set<br><br>商品限時促銷價活動的商品規格",
                        "type": "object",
                        "properties": {
                          "title_translations": {
                            "$ref": "#/components/schemas/Product/properties/title_translations"
                          },
                          "price": {
                            "allOf": [
                              {
                                "$ref": "#/components/schemas/Money"
                              }
                            ]
                          },
                          "price_sale": {
                            "allOf": [
                              {
                                "$ref": "#/components/schemas/Money"
                              }
                            ]
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "FlashPriceCampaigns": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FlashPriceCampaign"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/Paginatable"
          },
          "not_terminated_campaigns_count": {
            "description": "The number of active campaigns<br> 未過期的商品限時促銷價活動的數量",
            "type": "number",
            "example": 2
          }
        }
      },
      "Paginatable": {
        "type": "object",
        "properties": {
          "current_page": {
            "type": "integer",
            "description": "The current page number<br>當前分頁",
            "example": 1
          },
          "per_page": {
            "type": "integer",
            "description": "Number of result per page<br>每頁顯示 n 筆資料<br>(Default: 24)",
            "example": 24
          },
          "total_count": {
            "type": "integer",
            "description": "Number of result in total<br>資料總量",
            "example": 1
          },
          "total_pages": {
            "type": "integer",
            "description": "Number of pages in total<br>總頁數量",
            "example": 1
          }
        }
      },
      "Product": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Product's ID<br>商品ID",
            "type": "string",
            "example": "5d3594c276e7ec003b7021c0"
          },
          "status": {
            "description": "Product's status<br>商品狀態<br>-<br>true: Published 上架<br> false: Unpublished 下架<br>\"active\": Published 上架<br>\"draft\": Unpublished 下架<br> \"hidden\": hidden 隱藏<br><br>Default: false",
            "type": "string",
            "enum": [
              "active",
              "draft",
              "removed",
              "hidden"
            ],
            "example": "active"
          },
          "retail_status": {
            "description": "POS product's status<br>POS商品狀態<br>-<br> \"active\": Published 上架<br> \"draft\": Unpublished 下架<br><br> Default: active",
            "type": "string",
            "enum": [
              "active",
              "draft"
            ],
            "example": "active"
          },
          "title_translations": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Translatable"
              },
              {
                "description": "Title translations<br>商品名稱",
                "example": {
                  "en": "testing SL-8049",
                  "zh-hant": "測試 SL-8049 round 2"
                }
              }
            ]
          },
          "summary_translations": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Translatable"
              },
              {
                "description": "Summary translations<br>商品說明",
                "example": {
                  "en": "testing SL-8049",
                  "zh-hant": "測試 SL-8049 round 2"
                }
              }
            ]
          },
          "price": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              },
              {
                "description": "Price<br>原價格"
              }
            ]
          },
          "price_sale": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              },
              {
                "description": "Price on sale<br>特價"
              }
            ]
          },
          "lowest_price": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              },
              {
                "description": "The lowest price of product variations if exists<br>規格商品中的最低價"
              }
            ]
          },
          "lowest_price_sale": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              },
              {
                "description": "The lowest sale price of product variations if exists<br>特價規格商品中的最低價"
              }
            ]
          },
          "hide_price": {
            "description": "Hide Price to customers<br>隱藏價格<br>-<br>*Default: false",
            "type": "boolean",
            "example": "false"
          },
          "same_price": {
            "description": "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.",
            "type": "boolean",
            "example": true
          },
          "cost": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              },
              {
                "description": "Cost<br>成本價"
              }
            ]
          },
          "member_price": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              },
              {
                "description": "Member Price<br>會員價"
              }
            ]
          },
          "retail_price": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Money"
              },
              {
                "description": "Retail Price<br>零售價<br> Only provided when include_fields contains 'retail_price'<br> 僅於include_fields傳入 'retail_price' 時提供"
              }
            ]
          },
          "flash_price_sets": {
            "description": "price for flash campaign<br>限時促銷價",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "start_at": {
                  "type": "string"
                },
                "end_at": {
                  "type": "string"
                },
                "price_set": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    },
                    "flash_price_campaign_id": {
                      "type": "string"
                    },
                    "price": {
                      "allOf": [
                        {
                          "$ref": "#/components/schemas/Money"
                        },
                        {
                          "description": "price"
                        }
                      ]
                    },
                    "price_sale": {
                      "allOf": [
                        {
                          "$ref": "#/components/schemas/Money"
                        },
                        {
                          "description": "price_sale"
                        }
                      ]
                    },
                    "price_details": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "variation_key": {
                            "type": "string"
                          },
                          "price": {
                            "allOf": [
                              {
                                "$ref": "#/components/schemas/Money"
                              },
                              {
                                "description": "price"
                              }
                            ]
                          },
                          "price_sale": {
                            "allOf": [
                              {
                                "$ref": "#/components/schemas/Money"
                              },
                              {
                                "description": "price_sale"
                              }
                            ]
                          }
                        }
                      }
                    },
                    "created_at": {
                      "type": "string"
                    },
                    "updated_at": {
                      "type": "string"
                    }
                  }
                },
                "created_at": {
                  "type": "string"
                },
                "updated_at": {
                  "type": "string"
                }
              },
              "example": "{\n  \"id\": \"60d946c53be7c54f08869b46\",\n  \"start_at\": \"2021-06-27T00:00:00.000+00:00\",\n  \"end_at\": \"2021-06-27T00:00:00.000+00:00\",\n  \"price_set\": {\n      \"id\": \"60d946953be7c54f08869b45\",\n      \"type\": \"flash_price\",\n      \"flash_price_campaign_id\": \"60d944aa3be7c54f08869b44\",\n      \"price\": {\n          \"cents\": 1000,\n          \"currency_symbol\": \"HK$\",\n          \"currency_iso\": \"HKD\",\n          \"label\": \"HK$10.00\",\n          \"dollars\": 10\n      },\n      \"price_sale\": {\n          \"cents\": 800,\n          \"currency_symbol\": \"HK$\",\n          \"currency_iso\": \"HKD\",\n          \"label\": \"HK$8.00\",\n          \"dollars\": 8\n      },\n      \"created_at\": null,\n      \"updated_at\": null\n  },\n  \"created_at\": \"2021-06-28T03:50:07.912+00:00\",\n  \"updated_at\": \"2021-06-28T03:50:07.912+00:00\"\n}"
            }
          },
          "is_preorder": {
            "description": "Pre-ordered or not<br>是否開放預購",
            "type": "boolean",
            "example": "false"
          },
          "preorder_limit": {
            "description": "Pre-ordere Limit<br>預購上限",
            "type": "integer",
            "example": 1
          },
          "preorder_note_translations": {
            "description": "Pre-order Note Info<br>預購資訊",
            "allOf": [
              {
                "$ref": "#/components/schemas/Translatable"
              },
              {
                "description": "Title translations<br>商品名稱",
                "example": {
                  "en": "Shipping starts April 20th, 1971, preorder NOW!",
                  "zh-hant": "1971/04/20 開始出貨, 立即訂購!"
                }
              }
            ]
          },
          "weight": {
            "description": "Product's Weight (kg)<br>商品重量 (公斤)",
            "type": "number",
            "example": 123.99
          },
          "quantity": {
            "description": "Product's Current quantity<br>商品目前數量<br>-<br> *If unlimited_quantity is true, the product has unlimited quantity<br> regardless of the quantity showing here",
            "type": "number",
            "example": 87
          },
          "total_orderable_quantity": {
            "description": "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",
            "type": "number",
            "example": 87
          },
          "unlimited_quantity": {
            "description": "Unlimited product quantity or not.<br>商品數量是否無限",
            "type": "boolean",
            "enum": [
              true,
              false
            ],
            "example": "false"
          },
          "medias": {
            "description": "Media Data<br>媒體(照片)資訊",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Media"
            }
          },
          "detail_medias": {
            "description": "Additional Product Photos<br>更多商品圖片<br>Maximum 20 images for a product.<br>最多 20 張圖片",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Media"
            }
          },
          "category_ids": {
            "description": "Categories' IDs<br>商品所屬分類之ID",
            "type": "array",
            "items": {
              "type": "string",
              "example": "5be90603d1270b4032bed8b4"
            }
          },
          "supplier": {
            "description": "Supplier<br>供應商",
            "type": "string"
          },
          "sku": {
            "description": "Stock Keeping Unit<br>商品貨號",
            "type": "string",
            "example": "sku_123345"
          },
          "barcode": {
            "description": "Product's Barcode<br>商品條碼編號",
            "type": "string"
          },
          "quantity_sold": {
            "description": "Product's Quantity Sold<br>商品銷售數量",
            "type": "integer"
          },
          "barcode_type": {
            "description": "Barcode type<br>商品條碼編號類別",
            "type": "string",
            "enum": [
              "Code 128",
              "Bookland EAN",
              "ISBN"
            ]
          },
          "field_titles": {
            "description": "Field Title Data<br>規格名稱",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "name_translations": {
                  "$ref": "#/components/schemas/Translatable"
                },
                "selectorEnabled": {
                  "type": "boolean"
                }
              }
            },
            "example": [
              {
                "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": {
            "description": "Product Variations Data<br>商品規格資訊",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductVariation"
            }
          },
          "variant_options": {
            "description": "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>",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name_translations": {
                  "$ref": "#/components/schemas/Translatable"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "color",
                    "size",
                    "custom_1",
                    "custom_2",
                    "custom_3"
                  ]
                },
                "media": {
                  "type": "object"
                },
                "index": {
                  "type": "integer"
                }
              }
            },
            "example": [
              {
                "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": {
            "description": "Stock Unit Number<br>儲位編號",
            "type": "string",
            "example": "shoplineabc"
          },
          "feed_category": {
            "description": "Category for different feed<br>廣告的分類",
            "type": "object",
            "properties": {
              "google_category_id": {
                "type": "string",
                "example": "animals_pet_supplies"
              },
              "google_option_id": {
                "type": "string",
                "example": "live_animals"
              },
              "google_product_category": {
                "type": "string",
                "example": "Animals & Pet Supplies > Live Animals"
              }
            }
          },
          "feed_variations": {
            "description": "Feed Variations<br>產品資訊 - 顏色、尺寸、材質",
            "type": "object",
            "example": "{\n  \"color\": \"red\",\n  \"size\": \"small\",\n  \"material\": \"gold\"\n}",
            "properties": {
              "color": {
                "description": "Color<br>產品資訊 - 顏色",
                "type": "string",
                "example": "red"
              },
              "size": {
                "description": "Size<br>產品資訊 - 尺寸",
                "type": "string",
                "example": "small"
              },
              "material": {
                "description": "Material<br>產品資訊 - 材質",
                "type": "string",
                "example": "gold"
              }
            }
          },
          "description_translations": {
            "description": "Product Description<br>商品描述<br> Content in each locale cannot exceed 100,000 characters.<br> 各語系內容不能超過 100,000 個字元數。",
            "allOf": [
              {
                "$ref": "#/components/schemas/Translatable"
              },
              {
                "description": "Title translations<br>商品名稱"
              }
            ]
          },
          "seo_title_translations": {
            "description": "Title of SEO<br>SEO優化標題",
            "allOf": [
              {
                "$ref": "#/components/schemas/Translatable"
              },
              {
                "description": "Title translations<br>商品名稱"
              }
            ]
          },
          "seo_description_translations": {
            "description": "Description of SEO<br>SEO優化描述",
            "allOf": [
              {
                "$ref": "#/components/schemas/Translatable"
              },
              {
                "description": "Title translations<br>商品名稱"
              }
            ]
          },
          "seo_keywords": {
            "description": "Keywords of SEO<br>SEO關鍵字<br> *Keywords should be separated by commas (,) max length 160 characters.<br> 關鍵字以逗號(,)分隔, 最長 160字",
            "type": "string",
            "example": "電商, 開店, 創業"
          },
          "link": {
            "description": "",
            "type": "string"
          },
          "is_reminder_active": {
            "description": "Out-Of-Stock Reminder<br>商品缺貨是否提醒",
            "type": "boolean",
            "example": "true "
          },
          "show_custom_related_products": {
            "description": "Show Custom Related products<br>顯示相關商品",
            "type": "boolean",
            "enum": [
              true,
              false
            ],
            "example": false
          },
          "related_product_ids": {
            "description": "Custom related products<br>自訂相關商品",
            "type": "array",
            "example": [
              "5d3593cd5722660032e8fbed",
              "5d355b7b0e5da9001741ac2c"
            ],
            "items": {
              "type": "string"
            }
          },
          "tags": {
            "description": "Tags<br>標籤<br> *Tags are used to search products at the admin panel and help set up the product-related coupons.<br> 標籤功能用作商品搜尋，並能為指定商品設置優惠券的用途。",
            "type": "array",
            "example": "[\"shopline\", \"123\", \"abc\"]",
            "items": {
              "type": "string"
            }
          },
          "blacklisted_delivery_option_ids": {
            "description": "Excluded Delivery Options<br>排除的送貨方式",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "blacklisted_payment_ids": {
            "description": "Excluded Payment<br>Options<br>排除的付款方式",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "max_order_quantity": {
            "description": "set maximum quantity per purchase for this product<br> 商品單次購買上限<br> *-1 represents there's no quantity limit for each purchase<br> -1代表無商品單次購買的上限",
            "type": "integer",
            "example": 4
          },
          "gender": {
            "description": "Mapping Product Category: Gender<br>產品使用類別：性別<br> male 男性<br> female 女性<br>* unisex 男女通用",
            "type": "string"
          },
          "age_group": {
            "description": "Mapping Product Category:Age Group<br>產品使用類別：年齡層<br> newborn 新生兒<br> infant 嬰兒<br> toddler 幼兒<br> kids兒童<br>* Adult 成人",
            "type": "string"
          },
          "adult": {
            "description": "Mapping Product Category:Adult<br>產品使用類別：成人<br> yes 是<br> no 否",
            "type": "string"
          },
          "condition": {
            "description": "Mapping Product Category:Condition<br>產品使用類別：狀況<br> used 二手<br> refurbished 整新品<br>* new 新品",
            "type": "string"
          },
          "brand": {
            "description": "Brand<br>商品品牌",
            "type": "string"
          },
          "mpn": {
            "description": "Manufacturer Part Number<br>製造編號",
            "type": "string"
          },
          "gtin": {
            "description": "Barcode<br>商品條碼編號",
            "type": "string"
          },
          "blacklisted_feed_channels": {
            "description": "排除這個商品投放管道<br>Exclude this product to channel",
            "type": "array",
            "items": {
              "type": "string",
              "example": "google"
            }
          },
          "updated_at": {
            "description": "Last Updated Time<br>商品最後更新時間",
            "type": "string",
            "example": "2020-12-09T07:15:06.813+00:00"
          },
          "created_at": {
            "description": "Product Created Time<br>商品創建時間",
            "type": "string",
            "example": "2020-11-23T02:31:32.926+00:00"
          },
          "available_start_time": {
            "description": "",
            "type": "string"
          },
          "available_end_time": {
            "description": "",
            "type": "string"
          },
          "created_by": {
            "description": "",
            "type": "string",
            "example": "openapi"
          },
          "is_excluded_promotion": {
            "description": "product is exclude promotion which is discount on order<br>不適用全店折扣的優惠是否開啟",
            "type": "boolean",
            "example": true
          },
          "taxable": {
            "description": "taxable<br>是否收稅",
            "type": "boolean",
            "example": true
          },
          "labels": {
            "description": "product labels<br>標簽的商品促銷標簽文案",
            "type": "array",
            "items": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Translatable"
                }
              ]
            },
            "example": [
              {
                "en": "ABC",
                "zh-hant": "ddd"
              }
            ]
          },
          "locked_inventory_count": {
            "type": "number",
            "example": 10
          },
          "schedule_publish_at": {
            "type": "string",
            "example": "2020-11-23T02:31:32.926+00:00"
          },
          "product_price_tiers": {
            "description": "Product's price for member tier. <br> 適用於指定會員分級的產品價格。",
            "type": "array",
            "items": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ProductPriceTier"
                }
              ]
            }
          },
          "metafields": {
            "description": "metafields<br>only show if include_fields[]=metafields",
            "type": "object",
            "example": {
              "namespace": {
                "key1": "value",
                "key2": 3,
                "key3": {
                  "json": "object"
                }
              }
            }
          },
          "out_of_stock_orderable": {
            "description": "out_of_stock_orderable<br>缺貨時是否可接單",
            "type": "boolean",
            "example": false
          },
          "subscription_enabled": {
            "description": "subscription_enabled<br>是否為定期購商品。",
            "type": "boolean",
            "example": true
          },
          "subscription_period_duration": {
            "description": "subscription_period_duration<br>定期購天數",
            "type": "integer",
            "example": 30
          },
          "subscription_recurring_count_limit": {
            "description": "Subscription recurring count limit<br>定期購期數",
            "type": "integer",
            "example": 5
          },
          "filter_tags": {
            "description": "filter_tags<br>自訂篩選條件",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FilterTag"
            }
          },
          "bundle_set": {
            "description": "bundle_set info<br>組合商品資訊<br> Only provided when include_fields contains 'bundle_set'<br> 僅於include_fields傳入 'bundle_set' 時提供",
            "type": "object",
            "properties": {
              "_id": {
                "type": "string"
              },
              "price_type": {
                "description": "Price Type<br>組合售價類型",
                "type": "string",
                "enum": [
                  "fixed_amount discount_percentage discount_amount"
                ],
                "example": "fixed_amount"
              },
              "discount_value": {
                "description": "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",
                "type": "number",
                "example": 20
              },
              "bundle_set_products": {
                "type": "object",
                "example": {
                  "6200c988dcf97a004b22ec26": {
                    "min_quantity": 1
                  }
                }
              }
            }
          },
          "type": {
            "description": "product type<br>商品型別<br> Only provided when include_fields contains 'type'<br> 僅於include_fields傳入 'type' 時提供",
            "type": "string",
            "example": "product"
          },
          "tax_type": {
            "description": "Tax type<br>國內稅項",
            "type": "string"
          },
          "oversea_tax_type": {
            "description": "Oversea tax type<br>海外稅項",
            "type": "string"
          },
          "allow_gift": {
            "description": "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.",
            "type": "boolean",
            "example": true
          },
          "is_custom": {
            "description": "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.",
            "type": "boolean",
            "example": true
          },
          "sold_out": {
            "description": "Indicates whether the product is sold out.<br> 商品是否售罄.<br> true: the product is sold out. 已售罄<br> false: the product is still available. 尚有庫存<br>",
            "type": "boolean",
            "example": true
          },
          "cart_tag_id": {
            "description": "Product Attribute ID<br>商品屬性設置 id<br> This field is unavailable when you get a product detail<br> 取得商品詳細資訊時不提供",
            "type": "string",
            "example": "63ec73c11ac51b368c74b92b"
          },
          "cart_tag": {
            "description": "Product Attribute<br>商品屬性設置<br> This field is only available when you get a product detail<br> 僅於取得商品詳細資訊時提供",
            "type": "object",
            "example": {
              "id": "63ec73c11ac51b368c74b92b",
              "name_translations": {
                "en": "",
                "zh-hant": "一車常溫"
              },
              "priority": 1
            }
          }
        }
      }
    }
  },
  "paths": {
    "/flash_price_campaigns": {
      "get": {
        "summary": "Get Flash Price Campaigns",
        "description": "To retrieve flash price campaign list<br>獲取商品限時促銷價活動列表",
        "parameters": [
          {
            "name": "filter_action",
            "description": "Specify the filter action for flash price campaigns by the start time or/and end time<br> 指定商品限時促銷價活動的過濾動作，此動作依據start_at或/及end_at進行過濾",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "overlap"
              ]
            },
            "example": "overlap"
          },
          {
            "name": "start_at",
            "description": "Filter those flash price campaigns after specified start_at time.<br> 取得大於指定start_at時間的商品限時促銷價活動<br> *Should use UTC time<br> *應使用UTC時間",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "2022-01-01 00:00:00"
          },
          {
            "name": "end_at",
            "description": "Filter those flash price campaigns before specified end_at time.<br> 取得小於指定end_at時間的商品限時促銷價活動<br> *Should use UTC time<br> *應使用UTC時間",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "2022-02-01 00:00:00"
          },
          {
            "name": "page",
            "description": "Page Number<br>頁數",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "example": 1
          },
          {
            "name": "per_page",
            "description": "Numbers of Orders per Page<br>每頁顯示 n 筆資料<br>",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "example": 24
          }
        ],
        "tags": [
          "Flash Price Campaigns"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlashPriceCampaigns"
                }
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Flash Price Campaigns",
      "description": "Operations about flash price campaigns"
    }
  ]
}
```