# ポイント残高

# タイプ

ポイント残高情報のJSONは以下の内容を含みます:

キー	タイプ	定義
`id`	String	顧客のShopify ID
`expiration_delay`	Integer	顧客のポイントが期限切れになるまでショップが待機する期間（月単位）
`expires_at`	String	顧客の現在のポイント有効期限日時
`point_balance`	Integer	顧客のポイント残高

# 単一ポイント残高の取得

# ルート

以下のGETルートを使用して単一顧客のポイント残高を取得できます。

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

:shopify_customer_idを取得したい顧客のShopifyIDと差し替えてください。

# 引数

# 必須パラメーター

なし

# オプションパラメーター

なし

# 戻り値

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

キー	タイプ	定義
`id`	String	顧客のShopify ID
`expiration_delay`	Integer	顧客のポイントが期限切れになるまでショップが待機する期間（月単位）
`expires_at`	String	顧客の現在のポイント有効期限日時
`point_balance`	Integer	顧客のポイント残高

# 事例

リクエストと結果の例：

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

{
  "data": {
    "expiration_delay": 3,
    "expires_at": "2020-11-14T07:00:35.000000Z",
    "id": "123",
    "point_balance": 800
  }
}

# ポイント残高の更新

# ルート

以下のPOSTルートを使用してポイント残高を指定した値に上書きすることができます。指定したポイント残高と現在のポイント残高の差額分がポイント付与、もしくは差引として適用されます。

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

:customer_shopify_idの箇所はメールアドレスでも結構です。 (必要に応じて暗号化を行なってください。)

# 引数

# 必須パラメーター

以下のフィールドを送信してください:

キー	タイプ	必須	定義
`balance`	Integer	✔️	更新後の顧客のポイント残高

# オプションパラメーター

なし

# 戻り値

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

キー	タイプ	定義
`id`	String	ポイント付与または差引のeasyPoints ID
`point_value`	Integer	変動したポイント数
`inserted_at`	String	残高が更新された日時
`point_balance`	Point Balance	指定されたポイント残高

# 使用例

リクエストと結果の例:

curl -X POST \
 'https://loyalty.slrs.io/api/shopify/point_balances/1234567890/set_balance' \
-H 'content-type: application/json' \
-H 'authorization: Basic ${API_CREDENTIALS}'
-d '{
    "balance": 200,
    }'

{
  "data": {
    "id": "36ce8920-4a65-11eb-98c6-000c291828e7",
    "inserted_at": "2020-12-30T06:06:53.000000",
    "point_balance": {
      "expiration_delay": 3,
      "expires_at": "2021-03-20T23:51:09.000000Z",
      "id": "123",
      "point_balance": 200
    },
    "point_value": 100
  }
}

# webhookにCSVエクスポートをリクエストする

# ルート

以下のPOSTルートを使用して設定したwebhookにCSVエクスポートをリクエストできます。

POST https://loyalty.slrs.io/api/shopify/point_balances/export

webhook経由のCSVエクスポートには8時間に1度のレート制限が設定されています。

# 引数

# 必須パラメーター

以下のフィールドを送信してください::

キー	タイプ	必須	定義
`start_datetime`	String	✔️	CSVエクスポート対象日時の開始点
`end_datetime`	String	✔️	CSVエクスポート対象日時の終了点

# オプションパラメーター

なし

リクエストの例:

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

← セットアップポイント割り当て →