easyPoints

# 会員ランク

会員ランクのエンドポイント（Tiers）はAPIのユーザーによる顧客の会員ランクの設定が管理可能になります。

# ベースルート

/api/shopify/point_balances/:id/tiers

# 特定の顧客の会員ランクを更新する

# ルート

以下のPOSTルートから、特定の顧客の会員ランク設定を管理します。

/api/shopify/point_balances/:id/tiers

会員ランクの設定を更新をされたい顧客のShopify IDを:idに入力します。

# フィールド

顧客の会員ランクの設定を更新する際に、以下のフィールドを提出します。

キー タイプ 必須 説明
tier 文字列 ❌ * 指定する顧客のランク
minimum_tier 文字列 ❌ * 顧客の降格可能な最下位ランク
skip_next_check ブール値 ❌ * 次の自動的な会員ランクの変更を無視する

*tier、 minimum_tierまたはskip_next_checkのどれかひとつは必ず必要になります。

# 会員ランク

tierのフィールドは、正確なランク名の文字列またはランクを示す昇順の整数に指定します。

例： 1 = Bronze (デフォルト)、2 = シルバー、3 = ゴールド

注意: ランクを整数として指定する場合は、文字列ではなく整数として入力をする必要があります。 （例：　正解 = 1、不正解 = "1"）

# 降格可能な最下位ランク

minimum_tierのフィールドは上記のtierと同じく、ランク名の文字列または整数で指定可能です。

# 次の自動的な会員ランクの変更を無視する

skip_next_checkをtrueに設定すると、次の自動的な会員ランクの変更を無視する事が可能になります。この設定は、例えば次のランクアップ周期に近づいた時期に、手動またはAPIによる会員ランクの変更が、次のランクアップ周期によるランクの降格・昇格を無視するのに利用します。

このフィールドが指定されない場合、デフォルトでfalseに指定されます。その場合、次のランクアップ周期のタイミングで、システム上の顧客全員と同じ条件でランクが降格・昇格されます。この設定は手動・APIによるランクの変更を次のランクアップ周期に引き継ぎたくない場合に利用します。

# フィールドのレスポンス

以下のフィールドが返されます：

キー タイプ 説明
id 文字列 顧客のShopify ID
tier 文字列 指定する顧客のランク
minimum_tier 文字列 顧客の降格可能な最下位ランク
skip_next_check ブール値 次の自動的な会員ランクの変更を無視する [default false]

# 事例

# 例 1

顧客123のランクをSilverに指定する場合のリクエストとレスポンスの例：

# リクエスト
POST "https://loyalty.slrs.io/api/shopify/point_balances/123/tiers"
Body {
  "tier": "silver"
}
# レスポンス
{
  "data": {
    "id": "123",
    "tier": "silver",
    "minimum_tier": null,
    "skip_next_check": false
  }
}

# 例 2

顧客123のランクをGold、降格可能最下位ランクをSilver、そして次の自動的な会員ランクの変更を無視する場合のリクエストとレスポンスの例：

# リクエスト
POST "https://loyalty.slrs.io/api/shopify/point_balances/123/tiers"
Body {
  "tier": "gold",
  "minimum_tier": "silver",
  "skip_next_check": true
}
# レスポンス
{
  "data": {
    "id": "123",
    "tier": "gold",
    "minimum_tier": "silver",
    "skip_next_check": true
  }
}

← Async API →