Get Membership Tiers

get https://open.shopline.io/v1/membership_tiers

To get membership tiers with open API
獲取會員分級資料

Responses

Response body

array of objects

object

string

Membership tier's ID
會員等級ID

level

integer

Level of Current Membership Tier
等級高低
-
*Having higher level with larger number.
等級數越高，數字越大

name_translations

object

Name Translations
欄位名稱

membership_tier_rules

array of objects

membership_tier_rules

object

string

Membership tier rule's ID
會員等級規則ID

effect_type

string

Type of the membership_tier_rule
會員級別規則的類別

upgrade extend

condition_interval

object

effect_interval

object

total_spending

object

created_at

string

The timestamp that the rule is created at
規則創造時間

updated_at

string

The timestamp that the rule is updated at
規則更新時間

promotions

array of objects

promotions

object

string

Promotion ID
優惠活動ID

discount_percentage

number

Discount percentage
折扣百分比
-
*Applicable when discount_type is percentage
當discount_type為percentage時適用

discount_amount

object

Discount amount
折扣固定金額
-
*Applicable when discount_type is gift
當discount_type為amount時適用

discountable_quantity

integer

Quantity
獲得數量
-
When discount_type is gift, this field refers to quantity of gift
當discount_type為gift時，此為贈品數量

When discount_type is addon, this field refers to quality of add-on
當discount_type為addon時，此為可加購數量

discounted_point

integer

Amount of point to redeem gift
點數兌換
-
*Applicable when discount_type is member_point_redeem_gift
當discount_type為member_point_redeem_gift時適用

discounted_price

object

Discounted price
優惠價格
-
*Applicable when discount_type is bundle_pricing/ bundle_group/addon
當discount_type為bundle_pricing/ bundle_group/addon時適用

discountable_product_ids

array of strings

Ids of Discounted product
指定商品ids

discountable_product_ids

conditions

array of objects

conditions

object

string

Promotion Condition ID
優惠活動條件ID

min_item_count

integer

滿件數量

min_price

object

滿額

type

string

A組(紅標)或B組(綠標)
-
Applicable when discount_type is bundle_group

red green

whitelisted_product_ids

array of strings

指定商品條件id

whitelisted_product_ids

whitelisted_category_ids

array of strings

指定分類條件id

whitelisted_category_ids

blacklisted_product_ids

array of strings

指定排除商品條件id

blacklisted_product_ids

subscription_period

integer

subscription period
定期購指定期數

created_at

string

Created Time
建立時間

updated_at

string

Updated Time
更新時間

title_translations

object

Title translations
標題翻譯

discountable_category_ids

array of strings

Ids of Discounted category
指定商品分類ids

discountable_category_ids

discount_on

string

Promotion target
優惠套用對象
-
order = Entire shop 全店
item = Specific item 指定商品
category = Specific category 指定分類

order item category

discount_type

string

Discount type
折扣類型
-
percentage: 折扣%
amount: 固定金額
gift: 贈品
addon: 加購品
free_shipping: 免運
bundle_pricing: 任選優惠
bundle_group: A+B組合優惠（紅配綠）
member_point_redeem_gift: 點數兌換贈品
subscription_gift

percentage amount gift addon free_shipping bundle_pricing bundle_group member_point_redeem_gift subscription_gift

is_accumulated

boolean

Is bundle pricing or bundle pricing accumulated?
任選優惠/A+B組合優惠是否累計

first_purchase_only

boolean

For first purchase only
創建自動套用—每位會員限用優惠一次的任選優惠

first_purchase_all_platform

boolean

For first purchase all platform
全通路首購

codes

array of strings

Coupon Code
促銷代碼

codes

show_coupon

boolean

membership_tier_id

string

requires_membership

boolean

Does it require membership?
設定目標群組
-
false: 所有顧客
true: 會員

whitelisted_membership_tier_ids

array of strings

Specific Membership Tiers
適用會員等級

whitelisted_membership_tier_ids

whitelisted_tag_contents

array of strings

whitelisted_tag_contents

user_max_use_count

integer

Limit per member
每會員最多使用次數
-
null = Unlimited 不限使用次數

max_use_count

integer

How many times can this promotion be used?
活動限使用次數
-
null = Unlimited 不限使用次數

use_count

integer

Usage of this layer of promotion
本階層活動已使用次數

sum_use_count

integer

Total usage of promotion
活動已使用次數

whitelisted_delivery_option_ids

array of strings

Delivery options that applicable to the promotion
活動適用送貨方式

whitelisted_delivery_option_ids

whitelisted_payment_ids

array of strings

Payment options that applicable to the promotion
活動適用付款方式

whitelisted_payment_ids

start_at

string

Promotion start time
活動開始時間

end_at

string

Promotion end time
活動結束時間
-
null = no end date 永不過期

status

string

Promotion status
活動狀態
-
active: 上架
draft: 下架
hidden: 會員默認優惠/主商品加購品
removed: 刪除

active draft hidden

usable

boolean

Is promotion active
優惠是否進行中
-
true: published and not expired上架且沒有過期
false: unpublished or published and expired上架已過期或是下架

for_affiliate_campaign

boolean

Is applicable to affiliate campaign
是否適用於推薦活動

is_contain_campaign

boolean

Is binded to affiliate campaign
是否已綁定推薦活動

seo_enabled

boolean

Generate promotion page and SEO sitemap or not

seo_keywords

string

SEO keywords
SEO 關鍵字

seo_description_translations

object

Description of SEO
SEO優化描述

seo_title_translations

object

Title of SEO
SEO優化標題

link

object

SEO Link
SEO 連結

available_platforms

array of strings

指定平台（目前僅接受 "ec", "retail", "app" 值）

available_platforms

is_partial_free_shipping

boolean

coupon_type

string

draw single multi

extended_promotion_id

string

Parent promotion id
母層活動id
-
*applicable when this is a child promotion

extend_promotions

array of objects

多階層優惠活動與條件

extend_promotions

object

string

Promotion ID
優惠活動ID

discount_percentage

number

Discount percentage
折扣百分比
-
*Applicable when discount_type is percentage
當discount_type為percentage時適用

discount_amount

object

Discount amount
折扣固定金額
-
*Applicable when discount_type is gift
當discount_type為amount時適用

discountable_quantity

integer

discounted_point

integer

Amount of point to redeem gift
點數兌換
-
*Applicable when discount_type is member_point_redeem_gift
當discount_type為member_point_redeem_gift時適用

discounted_price

object

Discounted price
優惠價格
-
*Applicable when discount_type is bundle_pricing/ bundle_group/addon
當discount_type為bundle_pricing/ bundle_group/addon時適用

discountable_product_ids

array of strings

Ids of Discounted product
指定商品ids

discountable_product_ids

conditions

array of objects

conditions

object

string

Promotion Condition ID
優惠活動條件ID

min_item_count

integer

滿件數量

min_price

object

滿額

type

string

A組(紅標)或B組(綠標)
-
Applicable when discount_type is bundle_group

red green

whitelisted_product_ids

array of strings

指定商品條件id

whitelisted_product_ids

whitelisted_category_ids

array of strings

指定分類條件id

whitelisted_category_ids

blacklisted_product_ids

array of strings

指定排除商品條件id

blacklisted_product_ids

subscription_period

integer

subscription period
定期購指定期數

drew_coupon_count

integer

How many times did this promotion been drew?
活動被領取次數

whitelisted_membership_tiers

array of objects

指定會員資料

whitelisted_membership_tiers

object

summary

object

優惠概況

Has additional fields

available_channel_ids

array of strings

Ids of available channel
指定通路ids

available_channel_ids

banner_medias

object

Promotion banner
活動橫圖

term_translations

object

Promotion Term & Condition
活動條款與細則

member_point_rules

array of objects

member_point_rules

object

string

Member Point Rule ID
會員點數ID

status

string

Whether the rules is applying
規則是否正在生效

active inactive

unit_price

integer

The amount of purchase to earn a unit of points.
This field will be null if the rule_type is not "earn_from_order."
賺取一個單位的點數所需的購買金額
如rule_type不是"earn_from_order"，此欄會是null

points_per_unit

integer

The amount of points earned by a unit of unit_price.
This field will be null if the rule_type is not "earn_from_order".
一個單位的unit_price能夠賺取的點數如rule_type不是"earn_from_order"，此欄會是null

points_expire_day

integer

The expiry date of points, null if there is no expiry date.
This field will be null if the rule_type is not "earn_from_order".
點數的到期日，如規則並沒有設置點數會到期，此欄會是null 如rule_type不是"earn_from_order"，此欄會是null

points_expire_month

integer

The expiry month of points, null if there is no expiry date.
This field will be null if the rule_type is not "earn_from_order".
點數的到期月份，如規則並沒有設置點數會到期，此欄會是null 如rule_type不是"earn_from_order"，此欄會是null

pending_days

integer

The number of days after delivery received (Arrived/ Collected) will the system automatically assign the point to customer.
This field will be null if the rule_type is not "earn_from_order".＜br /> 顧客訂單轉變為已取貨 / 已到達(宅配) 後幾天自動發送點數
如rule_type不是"earn_from_order"，此欄會是null

rule_type

string

Define the types of rules that the current object is representing.
定義這個物件正在表示的規則類別

earn_from_order max_percentage_per_order max_amount_per_order

remarks_translations

object

Remarks of the rules in different language.
不同語言的點數規則說明

membership_tier_id

string

The id of membership_tier.

unit_point

integer

The amount of points needed to redeem a unit of discount.
This field will be null if the rule_type is "earn_from_order".
兌換一個單位的折扣所需的點數
如rule_type是"earn_from_order"，此欄會是null

price_per_unit

integer

The amount of discount per unit of points.
This field will be null if the rule_type is "earn_from_order".
一個單位的點數兌換到的折扣
如rule_type是"earn_from_order"，此欄會是null

point_value

integer

The price to apply point discount.
It will be -1 if there is no constraint on applying discount.
This field will be -1 if the rule_type is "earn_from_order".
可以使用折扣的價錢
如沒有設置使用折扣的價格，此欄會是-1
如rule_type是"earn_from_order"，此欄會是-1

apply_threshold

integer

Maximum amount of point discount could be applied, the metric depends on the rule_type.
This field will be null if the rule_type is "earn_from_order".
可使用的最高折扣額，此欄的單位會因應rule_type而改變
如rule_type是"earn_from_order"，此欄會是null

available_platforms

array of strings

Available platforms.
此規則生效的平台

available_platforms

user_credit_rules

array of objects

user_credit_rules

object

string

status

string

active inactive

rule_type

string

pos_apply_credit: POS 購物金折抵 auto_reward: 滿額送購物金 apply_partial_credit: 允許顧客自行設定折抵金額 welcome_credit: 新加入會員購物金 birthday_credit: 生日購物金 max_amount_per_order: (舊) 購物金折抵上限 by amount max_percentage_per_order: (舊) 購物金折抵上限 by percentage apply_user_credit: (新) 折抵購物金上限，支援多層級設定

pos_apply_credit auto_reward apply_partial_credit welcome_credit birthday_credit max_amount_per_order max_percentage_per_order apply_user_credit

credit_value

integer

購物金

credit_value_type

string

Only the rule whose rule_type is apply_user_credit will use this field to distinguish the credit_value is fixed amount or percentage.
僅 rule_type 為 apply_user_credit 的規則會使用到，用來區分 credit_value 的值是固定金額還是百分比

amount percentage

credit_valid_period

integer

購物金有效日期（天），0 / -1 代表無限

credit_threshold

integer

購物金生效條件

is_accumulated

boolean

自動累計

accumulated_type

string

累計類型 credit: 固定金額 percentage: 百分比

credit percentage

apply_threshold

integer

購物金生效條件

apply_conditions

array of objects

Tiered application of user credits.
套用購物金折抵條件(多階層)

apply_conditions

object

credit_value

integer

Credit Value
購物金

apply_threshold

integer

Apply Threshold
購物金折抵門檻

created_at

string

Created Date
創造時間
(UTC +0)

updated_at

string

Created Date
更新時間
(UTC +0)

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://open.shopline.io/v1/membership_tiers \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

500Server error