---
title: "Get Flash Price Campaigns"
method: GET
path: "/flash_price_campaigns"
tags: ["Flash Price Campaigns"]
---

# Get Flash Price Campaigns

`GET /flash_price_campaigns`

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

## Query parameters

- `filter_action` 'overlap'
- `start_at` string
- `end_at` string
- `page` integer
- `per_page` integer

## Response `200`

OK

- FlashPriceCampaigns
  - `items` FlashPriceCampaign[]
    - `id` string — Flash price campaign‘s ID<br>商品限時促銷價活動ID
    - `title` string — Flash price campaign's title<br>商品限時促銷價活動名稱
    - `start_at` string — The start time of the event<br>商品限時促銷價活動開始時間
    - `end_at` string — The end time of the event<br>商品限時促銷價活動結束時間
    - `merchant_id` string — Merchant ID<br>商户ID
    - `product_ids` string[] — The ids of the products which will be presented in this flash price campaign<br> 是次商品限時促銷價活動所包括的商品id
    - `price_sets` object[] — 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出現。
      - `id` string — The id of the price set<br>商品價格組的ID
      - `price` object — The price of the product when the event is started<br>商品限時促銷價活動的商品限時價格
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `price_sale` object — The price sale of the product when the event is started<br>商品限時促銷價活動的商品限時促銷價格
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `product` object — The product that applied this price set<br>商品限時促銷價活動的商品
        - `title_translations` TitleTranslations — unresolved $ref
        - `price` Money
          - `cents` integer
          - `currency_symbol` string
          - `currency_iso` string
          - `label` string
          - `dollars` number
        - `price_sale` Money
          - `cents` integer
          - `currency_symbol` string
          - `currency_iso` string
          - `label` string
          - `dollars` number
        - `same_price` SamePrice — unresolved $ref
        - `media_thumb_url` string
      - `price_details` object[] — The price sets of the variations of the product of this event<br>商品限時促銷價活動的商品規格價錢組
        - `variation_key` string — The id of the variation product<br>商品限時促銷價活動的商品規格ID
        - `price` object — The price of the product variation when the event is started <br>商品限時促銷價活動的商品規格限時價格
          - `cents` integer
          - `currency_symbol` string
          - `currency_iso` string
          - `label` string
          - `dollars` number
        - `price_sale` object — The price sale of the product variation when the event is started <br>商品限時促銷價活動的商品規格限時促銷價格
          - `cents` integer
          - `currency_symbol` string
          - `currency_iso` string
          - `label` string
          - `dollars` number
        - `variation` object — The product variation that applied this price set<br><br>商品限時促銷價活動的商品規格
          - `title_translations` TitleTranslations — unresolved $ref
          - `price` Money
            - `cents` integer
            - `currency_symbol` string
            - `currency_iso` string
            - `label` string
            - `dollars` number
          - `price_sale` Money
            - `cents` integer
            - `currency_symbol` string
            - `currency_iso` string
            - `label` string
            - `dollars` number
  - `pagination` Paginatable
    - `current_page` integer — The current page number<br>當前分頁
    - `per_page` integer — Number of result per page<br>每頁顯示 n 筆資料<br>(Default: 24)
    - `total_count` integer — Number of result in total<br>資料總量
    - `total_pages` integer — Number of pages in total<br>總頁數量
  - `not_terminated_campaigns_count` number — The number of active campaigns<br> 未過期的商品限時促銷價活動的數量

---

[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)