HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Get flash price campaign by id

GET https://open.shopline.io/v1/flash_price_campaigns/{id}


To retrieve a flash price campaign with its id
獲取商品限時促銷價活動

Sample Request

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

Path Param

id Required string Flash price campaigns's ID
商品限時促銷價活動ID

Sample Response

{
  "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
            }
          }
        }
      ]
    }
  ]
}

Response Param

id string Flash price campaign‘s ID
商品限時促銷價活動ID
title String Flash price campaign's title
商品限時促銷價活動名稱
start_at String The start time of the event
商品限時促銷價活動開始時間
Should use UTC time
應使用UTC時間
end_at String The end time of the event
商品限時促銷價活動結束時間
Should use UTC time
應使用UTC時間
product_ids Array of String The ids of the products which will be presented in this flash price campaign
是次商品限時促銷價活動所包括的商品 id
price_sets Array of Object The product price sets of this flash price campaigns.
商品限時促銷價活動的商品限時價格。
Presented in GET/flash_price_campaigns{id}, POST /flash_price_campaigns, PUT /flash_price_campaigns{id} but not in GET /flash_price_campaigns. 會於 GET /flash_price_campaigns{id} 及 POST /flash_price_campaigns及 PUT /flash_price_campaigns{id}出現, 但不於 POST /flash_price_campaigns出現。
price_sets[].id string The id of the price set
商品價格組的ID
price_sets[].price Money The price of the product when the event is started
商品限時促銷價活動的商品限時價格
price_sets[].price_sale Money The price sale of the product when the event is started
商品限時促銷價活動的商品限時促銷價格
price_sets[].product Object The price sale of the product when the event is started
商品限時促銷價活動的商品限時促銷價格
price_sets[].product.title_translations Translation Title translations
商品名稱
price_sets[].product.price Money
price_sets[].product.price_sale Money
price_sets[].product.same_price Boolean Main Product and Variation Product share the same price (Including original price and member price)
規格商品是否皆同主商品價格,包含原價格與會員價
1. If Same price is true, and variation_price is filled
2. If Same price is true, and variation_price is not filled
3. If Same price is false, and variation_price is filled
4. If Same price is false, and variation_price is not filled
price_sets[].product.price_details Array of Objects The price sets of the variations of the product of this event
商品限時促銷價活動的商品規格價錢組
price_sets[].product.price_details.variation_key string The id of the variation product
商品限時促銷價活動的商品規格ID
price_sets[].product.price_details.price Money The price of the product variation when the event is started
商品限時促銷價活動的商品規格限時價格
price_sets[].product.price_details.price_sale Money The price sale of the product variation when the event is started
商品限時促銷價活動的商品規格限時促銷價格
price_sets[].product.price_details.variation Object The product variation that applied this price set
商品限時促銷價活動的商品規格
price_sets[].product.price_details.variation.title_translations Translation Title translations
商品名稱
price_sets[].product.price_details.variation.price Money
price_sets[].product.price_details.variation.price_sale Money