Get Promotion
Function
To get detailed information for a specific promotion with its ID
使用優惠活動ID獲取特定一個優惠活動的詳細資料
URL
GET API_DOMAIN/v1/promotions/:id
Request parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| :id *Required | String | Promotion ID 優惠活動ID | ruby 5e8445bcca53240021eab706 |
Response fields
| Field | Type | Description | Example |
|---|---|---|---|
| id | String | Promotion ID 優惠活動ID | 5e8445bcca53240021eab706 |
| discount_percentage | Float | Discount percentage 折扣百分比
| 10.0 |
| discount_amount | Money | Discount amount 折扣固定金額
| Please check the link on the left |
| discountable_quantity | Integer | Quantity 獲得數量
| 3 |
| discounted_point | Integer | Amount of point to redeem gift 點數兌換
| 100 |
| discounted_price | Money | Discounted price 優惠價格
| Please check the link on the left |
| discountable_product_ids | Array | Ids of Discounted product 指定商品ids |
|
| discountable_category_ids | Array | Ids of Discounted category 指定商品分類ids |
|
| conditions | Array | Condition of the promotion to take effect 本階層活動生效條件
|
|
| discount_on | String | Promotion target 優惠套用對象
| order |
| discount_type | String | Discount type 折扣類型
| percentage |
| is_accumulated | Boolean | Is bundle pricing or bundle pricing accumulated? 任選優惠/A+B組合優惠是否累計 | true |
| codes | Array | Coupon Code 促銷代碼 |
|
| requires_membership | Boolean | Does it require membership? 設定目標群組
| true |
| whitelisted_membership_tier_ids | Array | Specific Membership Tiers 適用會員等級 |
|
| membership_tier_id | String | Promotion Membership Tier 活動歸屬的會員等級 | 5e8445bcca53240021eab706 |
| whitelisted_tag_contents | Array | Specific tag contents 活動適用標籤 |
|
| user_max_use_count | Integer | Limit per member 每會員最多使用次數
| 1 |
| max_use_count | Integer | How many times can this promotion be used? 活動限使用次數
| 20 |
| use_count | Integer | Usage of this layer of promotion 本階層活動已使用次數 | 5 |
| sum_use_count | Integer | Total usage of promotion 活動已使用次數 | 14 |
| drew_coupon_count | Integer | Total drew of promotion 優惠券已次數 | 0 |
| whitelisted_delivery_option_ids | Array | Delivery options that applicable to the promotion 活動適用送貨方式 |
|
| whitelisted_payment_ids | Array | Payment options that applicable to the promotion 活動適用付款方式 |
|
| start_at | DateTime | Promotion start time 活動開始時間 | 2020-07-09T04:00:00.000+00:00 |
| end_at | DateTime | Promotion end time 活動結束時間
| null |
| created_at | DateTime | Promotion created time 活動創建時間 | 2020-07-09T04:00:00.000+00:00 |
| updated_at | DateTime | Promotion updated time 活動更新時間 | 2020-07-09T04:00:00.000+00:00 |
| status | String | Promotion status 活動狀態
| active |
| usable | Boolean | Is promotion active 優惠是否進行中
| true |
| first_purchase_only | Boolean | Is first purchase only 是否適用首購優惠 | true |
| show_coupon | Boolean | Is promotion coupons showed 是否顯示活動優惠碼 | true |
| for_affiliate_campaign | Boolean | Is applicable to affiliate campaign 是否適用於推薦活動 | true |
| is_contain_campaign | Boolean | Is binded to affiliate campaign 是否已綁定推薦活動 | true |
| seo_keywords | String | SEO keywords SEO 關鍵字 | summer special |
| seo_description_translations | Translation | Description of SEO SEO優化描述 | Please check the link on the left |
| seo_title_translations | Translation | Title of SEO SEO優化標題 | Please check the link on the left |
| title_translations | Translation | Promotion Title 活動標題 | Please check the link on the left |
| link | Link | SEO Link SEO 連結 | Please check the link on the left |
| available_platforms | Array | Promotion available platforms 活動適用平台 |
|
| is_partial_free_shipping | Boolean | Is partial free shipping 是否部分免運 | true |
| extended_promotion_id | String | Parent promotion id 母層活動id
| 5f06a6cb0a3509004853443a |
| extend_promotions | Array | Child layer promotion and condition 多階層優惠活動與條件
|
|
Response Example
{
"id":"62aaf4d83dc888003b2ce6de",
"discount_percentage":3,
"discount_amount":null,
"discountable_quantity":null,
"discounted_point":null,
"discounted_price":null,
"discountable_product_ids":[
"629821a3b6aafb0007f5091b"
],
"conditions":[
{
"id":"62aaf4d83dc888003b2ce6df",
"min_item_count":null,
"min_price":{
"cents":666,
"currency_symbol":"NT$",
"currency_iso":"TWD",
"label":"NT$666",
"dollars":666
},
"type":null,
"whitelisted_product_ids":[
"62440ebeeeaf010008c40ee4",
"62440ebeeeaf010008c40ed8"
],
"whitelisted_category_ids":[
],
"blacklisted_product_ids":[
]
}
],
"created_at":"2022-06-16T09:16:08.251+00:00",
"updated_at":"2022-06-16T09:17:57.118+00:00",
"title_translations":{
"en":"44444"
},
"discountable_category_ids":[
],
"discount_on":"item",
"discount_type":"percentage",
"is_accumulated":false,
"codes":[
],
"show_coupon":false,
"membership_tier_id":null,
"requires_membership":false,
"whitelisted_membership_tier_ids":[
],
"whitelisted_tag_contents":[
],
"user_max_use_count":0,
"max_use_count":11,
"use_count":0,
"sum_use_count":0,
"first_purchase_only":true,
"whitelisted_delivery_option_ids":[
"627cb1148466020038cc2fbd",
"627cabfca31d87001fc59d15",
"627cabc8a31d870019c59d15",
"627c851ce10d0e1df7c9a4c5",
"6195cd3207d5e70049c9506c"
],
"whitelisted_payment_ids":[
"6267a9289ad3fd00340665dc",
"62625477e74c640038cfd928",
"6195ccfd07d5e7004cc9506b"
],
"start_at":"2022-06-14T17:55:02.000+00:00",
"end_at":null,
"status":"active",
"usable":true,
"for_affiliate_campaign":false,
"is_contain_campaign":false,
"seo_keywords":"abc",
"seo_description_translations":{
},
"seo_title_translations":{
},
"link":null,
"available_platforms":[
"ec"
],
"is_partial_free_shipping":false,
"extended_promotion_id":"62aaf4d83dc88800322ce6e1",
"extend_promotions":[
{
"id":"5f06c48a436e2b004b471613",
"discount_percentage":null,
"discount_amount":null,
"discountable_quantity":null,
"discounted_point":10000,
"discounted_price":null,
"discountable_product_ids":[
"5f06a6ad2a051a0048caec6f"
],
"conditions":[
]
}
]
}Updated 6 months ago
Did this page help you?