---
title: "Get Membership Tiers"
method: GET
path: "/membership_tiers"
tags: ["Membership Tiers"]
---

# Get Membership Tiers

`GET /membership_tiers`

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

## Query parameters

- `include_fields[]` string[]

## Response `200`

OK

- MembershipTier[]
  - `id` string — Membership tier's ID<br>會員等級ID
  - `level` integer — Level of Current Membership Tier<br>等級高低<br>-<br>*Having higher level with larger number.<br>等級數越高，數字越大
  - `name_translations` object — Name Translations<br>欄位名稱
    - `en` string — Merchant defined English name<br>店家定義英文名稱
    - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
    - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
    - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
    - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
    - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
    - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
    - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
    - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
    - `fr` string — Merchant defined France name<br>店家定義法文名稱
  - `member_count` integer — Number of members in this tier<br>此等級的會員人數
  - `membership_tier_rules` MembershipTierRule[]
    - `id` string — Membership tier rule's ID<br />會員等級規則ID
    - `effect_type` 'upgrade' | 'extend' — Type of the membership_tier_rule<br /> 會員級別規則的類別
    - `condition_interval` object
      - `type` 'within_interval' | 'single_purchase' — Membership Upgrade Condition Type<br /> 會員升級條件類別<br /> - within_interval: 指定期限內購物<br /> - single_purchase: 單次購物
      - `time_unit` 'month' — Membership Upgrade Condition Time Unit<br /> 會員升級條件時間單位
      - `time_value` integer — Valid Period of the conditional interval if the type is "within_interval"<br /> 如類別是"within_interval"，升級條件時間的值
    - `effect_interval` object
      - `type` 'within_interval' | 'unlimited' — Membership Valid Period<br /> 會員有效期限
      - `time_unit` 'month' — Unit of Valid Period<br /> 有效期限單位
      - `time_value` integer — Valid Period of the effect interval if the type is "within_interval"<br /> 如類別是"within_interval"，有效期間的值
    - `total_spending` object
      - `cents` integer — Total Spending Requirement represent in cents<br /> 以仙為單位表示總消費要求
      - `currency_symbol` string — Total Spending Requirement represent in currency_symbol<br /> 以currency_symbol表示總消費要求
      - `currency_iso` string — Total Spending Requirement represent in currency_iso<br /> 以currency_iso表示總消費要求
      - `label` string — Total Spending Requirement represent in label<br /> 以標籤表示總消費要求
      - `dollars` number, float — Total Spending Requirement represent in dollars<br /> 以元為單位表示總消費要求
    - `created_at` string — The timestamp that the rule is created at<br />規則創造時間
    - `updated_at` string — The timestamp that the rule is updated at<br />規則更新時間
  - `promotions` Promotion[]
    - `id` string — Promotion ID<br>優惠活動ID
    - `discount_percentage` number — Discount percentage<br>折扣百分比<br>-<br>*Applicable when discount_type is percentage<br>當discount_type為percentage時適用
    - `discount_amount` object — Discount amount<br>折扣固定金額<br>-<br>*Applicable when discount_type is gift<br>當discount_type為amount時適用
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `discountable_quantity` integer — Quantity<br>獲得數量<br>-<br>*When discount_type is gift, this field refers to quantity of gift<br>當discount_type為gift時，此為贈品數量<br><br>*When discount_type is addon, this field refers to quality of add-on<br>當discount_type為addon時，此為可加購數量
    - `discounted_point` integer — Amount of point to redeem gift<br>點數兌換<br>-<br>*Applicable when discount_type is member_point_redeem_gift<br>當discount_type為member_point_redeem_gift時適用
    - `discounted_price` object — Discounted price<br>優惠價格<br>-<br>*Applicable when discount_type is bundle_pricing/ bundle_group/addon<br>當discount_type為bundle_pricing/ bundle_group/addon時適用
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `discountable_product_ids` string[] — Ids of Discounted product<br>指定商品ids
    - `conditions` object[]
      - `id` string — Promotion Condition ID<br>優惠活動條件ID
      - `min_item_count` integer — 滿件數量
      - `min_price` Money
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `type` 'red' | 'green' — A組(紅標)或B組(綠標)<br>-<br> Applicable when discount_type is bundle_group
      - `whitelisted_product_ids` string[] — 指定商品條件id
      - `whitelisted_category_ids` string[] — 指定分類條件id
      - `blacklisted_product_ids` string[] — 指定排除商品條件id
      - `subscription_period` integer — subscription period<br>定期購指定期數
    - `created_at` string — Created Time<br>建立時間
    - `updated_at` string — Updated Time<br>更新時間
    - `title_translations` object — Title translations <br> 標題翻譯
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `discountable_category_ids` string[] — Ids of Discounted category<br>指定商品分類ids
    - `discount_on` 'order' | 'item' | 'category' — Promotion target<br>優惠套用對象<br>-<br>order = Entire shop 全店<br>item = Specific item 指定商品<br>category = Specific category 指定分類
    - `discount_type` 'percentage' | 'amount' | 'gift' | 'addon' | 'free_shipping' | 'bundle_pricing' | 'bundle_group' | 'member_point_redeem_gift' | 'subscription_gift' — Discount type<br>折扣類型<br>-<br>percentage: 折扣%<br>amount: 固定金額<br>gift: 贈品<br>addon: 加購品<br>free_shipping: 免運<br>bundle_pricing: 任選優惠<br>bundle_group: A+B組合優惠（紅配綠）<br>member_point_redeem_gift: 點數兌換贈品<br>subscription_gift
    - `is_accumulated` boolean — Is bundle pricing or bundle pricing accumulated?<br>任選優惠/A+B組合優惠是否累計
    - `first_purchase_only` boolean — For first purchase only<br>創建自動套用—每位會員限用優惠一次的任選優惠
    - `first_purchase_all_platform` boolean — For first purchase all platform<br>全通路首購
    - `codes` string[] — Coupon Code<br>促銷代碼
    - `show_coupon` boolean
    - `membership_tier_id` string
    - `requires_membership` boolean — Does it require membership?<br>設定目標群組<br>-<br>false: 所有顧客<br>true: 會員
    - `whitelisted_membership_tier_ids` string[] — Specific Membership Tiers<br>適用會員等級
    - `whitelisted_tag_contents` string[]
    - `user_max_use_count` integer — Limit per member<br>每會員最多使用次數<br>-<br>null = Unlimited 不限使用次數
    - `max_use_count` integer — How many times can this promotion be used?<br>活動限使用次數<br>-<br>null = Unlimited 不限使用次數
    - `use_count` integer — Usage of this layer of promotion<br>本階層活動已使用次數
    - `sum_use_count` integer — Total usage of promotion<br>活動已使用次數
    - `whitelisted_delivery_option_ids` string[] — Delivery options that applicable to the promotion<br>活動適用送貨方式
    - `whitelisted_payment_ids` string[] — Payment options that applicable to the promotion<br>活動適用付款方式
    - `start_at` string — Promotion start time<br>活動開始時間
    - `end_at` string — Promotion end time<br>活動結束時間<br>-<br>null = no end date 永不過期
    - `status` 'active' | 'draft' | 'hidden' — Promotion status<br>活動狀態<br>-<br>active: 上架<br>draft: 下架<br>hidden: 會員默認優惠/主商品加購品<br>removed: 刪除
    - `usable` boolean — Is promotion active<br>優惠是否進行中<br>-<br>true: published and not expired上架且沒有過期<br>false: unpublished or published and expired上架已過期 或是 下架
    - `for_affiliate_campaign` boolean — Is applicable to affiliate campaign<br>是否適用於推薦活動
    - `is_contain_campaign` boolean — Is binded to affiliate campaign<br>是否已綁定推薦活動
    - `seo_enabled` boolean — Generate promotion page and SEO sitemap or not
    - `seo_keywords` string — SEO keywords<br>SEO 關鍵字
    - `seo_description_translations` object — Description of SEO<br>SEO優化描述
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `seo_title_translations` object — Title of SEO<br>SEO優化標題
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `link` object — SEO Link<br>SEO 連結
      - `id` string
      - `status` string
      - `type` string
      - `name` string
      - `name_translations` Translatable
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `value_id` string
      - `url_link` string
      - `key` string
      - `html_target` string
      - `section` string
      - `owner_id` string
      - `parent_id` string
      - `priority` number
      - `children_ids` string[]
      - `created_at` string — Created Time<br>建立時間
      - `updated_at` string — Updated Time<br>更新時間
      - `seo_image` object — SEO Image<br>SEO社群預覽圖
        - `id` string — Media ID
        - `url` string — Media URL
    - `available_platforms` string[] — 指定平台（目前僅接受 "ec", "retail", "app" 值）
    - `is_partial_free_shipping` boolean
    - `coupon_type` 'draw' | 'single' | 'multi'
    - `extended_promotion_id` string — Parent promotion id<br>母層活動id<br>-<br>*applicable when this is a child promotion
    - `extend_promotions` ExtendPromotion[] — 多階層優惠活動與條件
      - `id` string — Promotion ID<br>優惠活動ID
      - `discount_percentage` number — Discount percentage<br>折扣百分比<br>-<br>*Applicable when discount_type is percentage<br>當discount_type為percentage時適用
      - `discount_amount` object — Discount amount<br>折扣固定金額<br>-<br>*Applicable when discount_type is gift<br>當discount_type為amount時適用
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `discountable_quantity` integer — Quantity<br>獲得數量<br>-<br>*When discount_type is gift, this field refers to quantity of gift<br>當discount_type為gift時，此為贈品數量<br><br>*When discount_type is addon, this field refers to quality of add-on<br>當discount_type為addon時，此為可加購數量
      - `discounted_point` integer — Amount of point to redeem gift<br>點數兌換<br>-<br>*Applicable when discount_type is member_point_redeem_gift<br>當discount_type為member_point_redeem_gift時適用
      - `discounted_price` object — Discounted price<br>優惠價格<br>-<br>*Applicable when discount_type is bundle_pricing/ bundle_group/addon<br>當discount_type為bundle_pricing/ bundle_group/addon時適用
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `discountable_product_ids` string[] — Ids of Discounted product<br>指定商品ids
      - `conditions` object[]
        - `id` string — Promotion Condition ID<br>優惠活動條件ID
        - `min_item_count` integer — 滿件數量
        - `min_price` Money
          - `cents` integer
          - `currency_symbol` string
          - `currency_iso` string
          - `label` string
          - `dollars` number
        - `type` 'red' | 'green' — A組(紅標)或B組(綠標)<br>-<br> Applicable when discount_type is bundle_group
        - `whitelisted_product_ids` string[] — 指定商品條件id
        - `whitelisted_category_ids` string[] — 指定分類條件id
        - `blacklisted_product_ids` string[] — 指定排除商品條件id
        - `subscription_period` integer — subscription period<br>定期購指定期數
    - `drew_coupon_count` integer — How many times did this promotion been drew?<br>活動被領取次數
    - `whitelisted_membership_tiers` object[] — 指定會員資料
    - `summary` object — 優惠概況
    - `available_channel_ids` string[] — Ids of available channel<br>指定通路ids
    - `banner_medias` object — Promotion banner<br>活動橫圖
      - `id` string — Media ID
      - `alt_translations` object — Content to display on ALT attribute<br>在圖片ALT上展示的內容
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `images` object — Object contains url of image in different dimensions<br>包含不同大小圖片的連絡
    - `term_translations` object — Promotion Term & Condition <br> 活動條款與細則
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
  - `member_point_rules` MemberPointRule[]
    - `id` string — Member Point Rule ID<br />會員點數ID
    - `status` 'active' | 'inactive' — Whether the rules is applying<br />規則是否正在生效
    - `unit_price` integer — The amount of purchase to earn a unit of points.<br /> This field will be null if the rule_type is not "earn_from_order."<br /> 賺取一個單位的點數所需的購買金額<br /> 如rule_type不是"earn_from_order"，此欄會是null
    - `points_per_unit` integer — The amount of points earned by a unit of unit_price.<br /> This field will be null if the rule_type is not "earn_from_order".<br /> 一個單位的unit_price能夠賺取的點數 如rule_type不是"earn_from_order"，此欄會是null
    - `points_expire_day` integer — The expiry date of points, null if there is no expiry date.<br /> This field will be null if the rule_type is not "earn_from_order".<br /> 點數的到期日，如規則並沒有設置點數會到期，此欄會是null 如rule_type不是"earn_from_order"，此欄會是null
    - `points_expire_month` integer — The expiry month of points, null if there is no expiry date.<br /> This field will be null if the rule_type is not "earn_from_order".<br /> 點數的到期月份，如規則並沒有設置點數會到期，此欄會是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.<br /> This field will be null if the rule_type is not "earn_from_order".＜br /> 顧客訂單轉變為 已取貨 / 已到達(宅配) 後幾天自動發送點數<br /> 如rule_type不是"earn_from_order"，此欄會是null
    - `rule_type` 'earn_from_order' | 'max_percentage_per_order' | 'max_amount_per_order' — Define the types of rules that the current object is representing.<br /> 定義這個物件正在表示的規則類別
    - `remarks_translations` object — Remarks of the rules in different language.<br /> 不同語言的點數規則說明
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `membership_tier_id` string — The id of membership_tier.
    - `unit_point` integer — The amount of points needed to redeem a unit of discount.<br /> This field will be null if the rule_type is "earn_from_order".<br /> 兌換一個單位的折扣所需的點數<br /> 如rule_type是"earn_from_order"，此欄會是null
    - `price_per_unit` integer — The amount of discount per unit of points.<br /> This field will be null if the rule_type is "earn_from_order".<br /> 一個單位的點數兌換到的折扣<br /> 如rule_type是"earn_from_order"，此欄會是null
    - `point_value` integer — The price to apply point discount.<br /> It will be -1 if there is no constraint on applying discount.<br /> This field will be -1 if the rule_type is "earn_from_order".<br /> 可以使用折扣的價錢<br /> 如沒有設置使用折扣的價格，此欄會是-1<br /> 如rule_type是"earn_from_order"，此欄會是-1
    - `apply_threshold` integer — Maximum amount of point discount could be applied, the metric depends on the rule_type.<br /> This field will be null if the rule_type is "earn_from_order".<br /> 可使用的最高折扣額，此欄的單位會因應rule_type而改變<br /> 如rule_type是"earn_from_order"，此欄會是null
    - `available_platforms` string[] — Available platforms.<br />此規則生效的平台
  - `user_credit_rules` UserCreditRule[]
    - `id` string
    - `status` 'active' | 'inactive'
    - `rule_type` 'pos_apply_credit' | 'auto_reward' | 'apply_partial_credit' | 'welcome_credit' | 'birthday_credit' | 'max_amount_per_order' | 'max_percentage_per_order' | 'apply_user_credit' — 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: (新) 折抵購物金上限，支援多層級設定
    - `credit_value` integer — 購物金
    - `credit_value_type` 'amount' | 'percentage' — Only the rule whose rule_type is apply_user_credit will use this field to distinguish the credit_value is fixed amount or percentage.<br> 僅 rule_type 為 apply_user_credit 的規則會使用到，用來區分 credit_value 的值是固定金額還是百分比
    - `credit_valid_period` integer — 購物金有效日期（天），0 / -1 代表無限
    - `credit_threshold` integer — 購物金生效條件
    - `is_accumulated` boolean — 自動累計
    - `accumulated_type` 'credit' | 'percentage' — 累計類型 credit: 固定金額 percentage: 百分比
    - `apply_threshold` integer — 購物金生效條件
    - `apply_conditions` object[] — Tiered application of user credits.<br>套用購物金折抵條件(多階層)
      - `credit_value` integer — Credit Value<br>購物金
      - `apply_threshold` integer — Apply Threshold<br>購物金折抵門檻
    - `created_at` string — Created Date<br>創造時間<br>(UTC +0)
    - `updated_at` string — Created Date<br>更新時間<br>(UTC +0)

## Other responses

- `500` — Server error

---

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