HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Get flash price campaign

GET <<api_domain>>/v1/flash_price_campaigns


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

curl --request GET \
     --url https://open.shoplineapp.com/v1/flash_price_campaigns \
     --header 'Accept: application/json'

Query Params

filter_action string Specify the filter action for flash price campaigns by the start time or/and end time
指定商品限時促銷價活動的過濾動作,此動作依據start_at或/及end_at進行過濾
overlap
start_at String Could exclude certain parameters in the response
e.g. &excludes[]=field1&excludes[]=field2
end_at String Filter those flash price campaigns before specified end_at time.
取得小於指定end_at時間的商品限時促銷價活動
Should use UTC time
應使用UTC時間

Sample Response

{
  "items": [
    {
      "id": "5892d8679f9a4fc07b008295",
      "title": "Summer flash sale 2021!",
      "start_at": "2021-08-19T18:00:00.000Z",
      "end_at": "2021-08-21T15:30:00.000Z",
      "product_ids": [
        "string"
      ],
      "price_sets": [
        {
          "id": "610258858c5acd00452fcf8d",
          "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
          },
          "product": {
            "title_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
            },
            "same_price": true,
            "media_thumb_url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/60c9cc630053cc00462aad34/original.jpg?1623837795"
          },
          "price_details": [
            {
              "variation_key": "610258858c5acd00452fcf8d",
              "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
              },
              "variation": {
                "title_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
                }
              }
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 1,
    "total_pages": 1
  },
  "not_terminated_campaigns_count": 2
}