会員ランク

単一顧客の会員ランク情報の取得

ルート

以下のGETルートを使用して単一顧客の会員ランク情報を取得します。

GET https://loyalty.slrs.io/api/shopify/point_balances/:shopify_customer_id/tier

:shopify_customer_idにはデータを取得したい顧客のShopify IDを挿入します。

例えば https://admin.shopify.com/store/{store_domain}/customers/1234567890, 1234567890 is the Shopify customer's id.

引数

必須パラメーター

なし

オプションパラメーター

なし

戻り値

以下のデータを返します:

キー	タイプ	定義
amount	Integer	該当ランク達成に必要な購入金額
currency	String	ストアのデフォルト通貨コード
deadline	Timestamp	会員ランクの更新期限（ISO8601フォーマット）
raw_amount	Integer	該当ランク達成に必要な未返還値（通貨などに依らず一定）
tier_name	String	会員ランク名
tier_uid	String	easyPoints内の会員ランクid

使用例

リクエストと結果の例:

curl -X GET \
 'https://loyalty.slrs.io/api/shopify/point_balances/1234567890/tier' \
-H 'content-type: application/json' \
-H 'authorization: Basic ${API_CREDENTIALS}'

{
  "data": {
    "advancement_data": {
      "amount": "2000",
      "currency": "JPY",
      "deadline": "2023-01-01T00:00:00Z",
      "raw_amount": 2000,
      "spent_requirement": {
        "amount": "2000",
        "currency": "JPY",
        "raw_amount": 2000
      },
      "tier_name": "Silver ",
      "tier_uid": "08eeb334-df4d-11ed-ba1e-787b8aae8c7a",
      "tiers": [
        {
          "amount": "2000",
          "currency": "JPY",
          "name": "Silver ",
          "ratio": 0.03,
          "raw_amount": 2000,
          "spent_requirement": {
            "amount": "2000",
            "currency": "JPY",
            "raw_amount": 2000
          },
          "uid": "08eeb334-df4d-11ed-ba1e-787b8aae8c7a"
        }
      ]
    },
    "id": "6757085806881",
    "maintenance_data": {
      "amount": "1000",
      "currency": "JPY",
      "deadline": "2023-01-01T00:00:00Z",
      "raw_amount": 1000,
      "spent_requirement": {
        "amount": "1000",
        "currency": "JPY",
        "raw_amount": 1000
      }
    },
    "minimum_tier": "Bronze",
    "skip_next_check": false,
    "tier": "Bronze",
    "tier_uid": "dd5cc1f2-df4c-11ed-8376-787b8aae8c7a"
  }
}

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

ルート

以下のPOSTルートを使用して特定の顧客の会員ランクを更新します。

POST https://loyalty.slrs.io/api/shopify/point_balances/:customer_shopify_id/tiers

引数

必須引数

*以下の3つのうち、必ず1つ以上が必須です

キー	タイプ	定義
tier	String	更新後の顧客のランク
minimum_tier	String	顧客に設定されている最下位ランク
skip_next_check	Boolean	次の会員ランク更新を無視する

ランク更新の無視

skip_next_checkがtrueの場合、該当の顧客は次回のランク更新がスキップされます。例えば更新間際に任意にランクを更新し、更新後の次期においてもそのランクを引き継がれたい場合などにご利用いただけます。

デフォルト状態ではfalseに設定されており、その状態ではその他のお客様同様次回のランク更新が適用されます。

オプション引数

なし

戻り値

以下のデータが返されます:

キー	タイプ	説明
id	String	顧客のShopify ID
tier	String	更新後の顧客のランク
minimum_tier	String	顧客に設定されている最下位ランク
skip_next_check	Boolean	次の会員ランク変更を無視する [default false]

使用例

例1

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

リクエスト

curl -X POST \
 'https://loyalty.slrs.io/api/shopify/point_balances/123/tiers' \
-H 'content-type: application/json' \
-H 'authorization: Basic ${API_CREDENTIALS}' \
-d '{
  "tier": "silver"
}'

レスポンス

{
  "data": {
    "id": "123",
    "tier": "silver",
    "minimum_tier": null,
    "skip_next_check": false
  }
}

例2

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

リクエスト

curl -X POST \
 'https://loyalty.slrs.io/api/shopify/point_balances/123' \
-H 'content-type: application/json' \
-H 'authorization: Basic ${API_CREDENTIALS}' \
-d '{
  "tier": "gold",
  "minimum_tier": "silver",
  "skip_next_check": true
}'

レスポンス

{
  "data": {
    "id": "123",
    "tier": "gold",
    "minimum_tier": "silver",
    "skip_next_check": true
  }
}